abrams27/build-server-protocol

Protocol for IDEs and build tools to communicate about compile, run, test, debug and more.

Build Server Protocol

This project is an effort to improve the integration between language server/editors and build tools. This effort is led by the Scala Center and JetBrains, together with the help of other tooling developers in the Scala ecosystem and beyond.

Even though the protocol currently focuses on Scala developer tools, it's designed to be language-agnostic.

You can read the specification here.

The specification text, docs and support libraries for some of the supported languages are automatically generated from the smithy model.

Contribution

If you'd like to contribute to the protocol, please check out our CONTRIBUTING doc.

Maintainers

Current Maintainers

• Adrien Piquerez - @adpi2
• Andrzej Głuszak - @agluszak
• Chris Kipp - @ckipp01
• Justin Kaeser - @jastice
• Łukasz Wawrzyk - @lukaszwawrzyk
• Marcin Abramowicz - @abrams27
• Tomasz Pasternak - @tpasternak

Past Maintainers

• Jorge Vicente Cantero - @jvican
• Ólafur Páll Geirsson - @olafurpg

Protocol Changelog

2.2.0 (Unreleased)

• Add unstable run/printStdout, run/printStderr and run/readStdin notifications
• Add an optional originId field to TaskStartParams, TaskProgressParams and TaskFinishParams and deprecate it in CompileReport and TestReport to support BSP clients that need to distinguish between multiple reports for the same target.
  • Migration: Use the originId field in TaskFinishParams instead of CompileReport/TestReport to identify the report.
• Add optional support for environment variables and working directory parameters in buildTarget/run and buildTarget/test requests. Mark arguments and environment variables lists in ScalaMainClass and ScalaTestSuites deprecated as they are replaced by the parameters in the base request.
• Add cargo (Rust build tool) protocol extension
• Add Rust protocol extension