Bazel Build Server Protcol (BSP) VS Code Extension

This extension is designed to provide integration between VS Code and Bazel BSP. It is inspired by the New Bazel Plugin for JetBrains products, allowing VS Code to leverage a subset of Bazel BSP as well.

• Build Server Protocol
• Bazel BSP

The initial focus will be to build out several core workflows for to integrate Bazel BSP with VS Code's Test Explorer, including the following:

• Server install, launch, initialization, and process management
• Syncing available test targets and discovery of test cases beneath them
• Execution of test targets and parsing/display of test results and run history
• Support for debugging test targets and overlay of code coverage

In the future, we may consider exploring other areas of the Build Server Protocol and integrating them with VS Code. We are looking for others who are interested in VS Code + BSP integration. Please feel free to reach out if you have an idea or would like to contribute.

Current Status

The extension is still under active development, but initial development releases are now available for install from this repo. Please see the Getting Started for instructions.

Building/installing the extension

1. On the latest main branch, run yarn package. This will produce an extension artifact (.vsix file).
2. In VS Code's Extensions panel, navigate to the context menu (small ... at the top right of the panel), and select "Install Extension from VSIX..."
3. Select the location of the .vsix file, install it, and reload.
4. The "Testing" panel will become enabled once you open a supported file type. See activation events in the package.json for current list.

Getting Started

1. Launch this extension and open a supported file type.
2. If this is your first time using Bazel BSP in the repo, you will be prompted to install it. Accept the notification to proceed.
3. View the "Testing" panel, which will show progress of the load, and show available test targets once the load is complete.

Adjusting project scope

1. Click on the top level test case to open the .bazelproject that is in use.
2. Adjust the "targets" entry to include desired targets.
3. Click the refresh (circular arrow) icon at the top of the "testing" panel to re-sync available targets.

Syncing changes to targets

• Click the refresh button at the top of the "testing" panel. This will pull in new/renamed targets, and updated source files, within the scope defined by the .bazelproject file.

Extension Output

• Bazel BSP (client): Shows results of server notifications to the client, including sync and build progress.
• Bazel BSP (extension): Shows general extension launch related info, such as install progress and other potential issues with the extension itself.

Requirements

• VS Code 1.89 or newer

Extension Settings

• Please see the bazelbsp section in VS Code settings.

Known Issues

• Coming soon