Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bazelbuild/vscode-bazel
Bazel support for Visual Studio Code
https://github.com/bazelbuild/vscode-bazel
bazel visual-studio-code
Last synced: 2 months ago
JSON representation
Bazel support for Visual Studio Code
- Host: GitHub
- URL: https://github.com/bazelbuild/vscode-bazel
- Owner: bazelbuild
- License: apache-2.0
- Created: 2018-09-10T11:17:02.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T20:55:29.000Z (2 months ago)
- Last Synced: 2024-04-04T21:52:28.537Z (2 months ago)
- Topics: bazel, visual-studio-code
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=BazelBuild.vscode-bazel
- Size: 544 KB
- Stars: 223
- Watchers: 28
- Forks: 68
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS
Lists
- awesome-bazel - bazelbuild/vscode-bazel
- awesome-stars - bazelbuild/vscode-bazel - Bazel support for Visual Studio Code (TypeScript)
README
# Bazel plugin for Visual Studio Code
[](https://buildkite.com/bazel/vscode-bazel-vs-bazel)
This extension provides support for Bazel in Visual Studio.
## Features
- Syntax highlighting
- **Bazel Build Targets** tree displays the build packages/targets in your
workspace
- **CodeLens** links in BUILD files to directly launch a build or test by simply
clicking on the targets
- **Buildifier** integration to lint and format your Bazel files (requires that
[Buildifier](https://github.com/bazelbuild/buildtools/releases) be installed)
- **Bazel Task** definitions for `tasks.json`
- Debug Starlark code in your `.bzl` files during a build (set breakpoints, step
through code, inspect variables, etc.)
## Configuring the Extension
This extension adds a **Bazel** section to the extension settings in Visual
Studio Code. If you have Bazel installed in a location that is not on your
system path or if you wish to use a different version in the IDE, you should
set the **Bazel: Executable** setting to the location of the Bazel executable.
Similarly, the **Bazel: Buildifier Executable** setting can be configured if
you install Buildifier in a location that is not on your system path.
When Buildifier is installed, the **Format Document** command in Visual Studio
code will reformat `BUILD`, `WORKSPACE`, `.bzl`, and `.sky` files using the
tool and will display lint warnings from those files as you type. By default,
this extension does not automatically _fix_ lint warnings during formatting,
but you can opt into this by enabling the **Bazel: Buildifier Fix on Format**
setting.
## Using the Starlark Debugger
Currently, the Starlark Debugger can be used by right-clicking a build target in
the **Bazel Build Targets** view and selecting "Build Target with Starlark
Debugger". This will start the build inside the Visual Studio Code debugger
(output will be redirected to the Debug Console pane) and it will pause on any
breakpoints hit during execution.
When a Bazel thread is paused, you can step through Starlark code, add watch
expressions, and execute arbitrary statements by typing them in the input area
of the Debug Console.
Clicking the "Stop" button in the debugger will kill the Bazel process being
debugger, allowing you to halt the current build. The Bazel server, however,
will continue running.
## Using the LSP (Experimental)
This extension can use [Facebook's starlark project](https://github.com/facebookexperimental/starlark-rust) as a language server.
1. Install the LSP using cargo: `cargo install starlark_bin`
2. Enable the LSP extension by setting `bazel.lsp.enabled` to `true`.
## Bazel tasks
Bazel tasks can be configured from the `tasks.json` using the following structure:
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "Check for flakyness",
"type": "bazel",
"command": "test",
"targets": ["${input:pickFlakyTest}"],
"options": ["--runs_per_test=9"]
}
],
"inputs": [
{
"id": "pickFlakyTest",
"type": "command",
"command": "bazel.pickTarget",
"args": {
"query": "kind('.*_test', //...:*)",
"placeHolder": "Which test to check for flakyness?"
}
}
]
}
```
## Contributing
If you would like to contribute to the Bazel Visual Studio extension, please
refer to the [contribution guidelines](CONTRIBUTING.md) for information about
our patch acceptance process and setting up your development environment.