bazelrc language server

Code intelligence for .bazelrc config files.

Installation & Configuration

The language server from this repository can be used in a wide range editors (neovim, emacs, IntelliJ, ...).

For Visual Studio Code, we offer a pre-packaged Visual Studio Code plugin:

1. Download the correct *.vsix package for your operating system for the latest release
2. Inside Visual Studio, press Cmd + Shift + P to open the command picker
3. Choose the "Extension: Install from VSIX..." command
4. Choose the downloaded .vsix file in the file picker

I will leave it as an exercise to the reader to figure out how exactly to configure the language server for other editors. The bazelrc-lsp help command might be useful to get an overview of the available arguments.

Configuring your Bazel version

bazelrc-lsp comes packaged with documentation and metadata about the supported Bazel flags for a large range of Bazel versions. By default, the Bazel version is auto-detected using Bazelisk's algorithm, i.e. based on the USE_BAZEL_VERSION environment variable, the .bazeliskrc and the .bazelversion file.

In case auto-detection does not work for your particular use case, you can also specify a version explicitly via the VS-Code settings.

Alternatively, the language server can also invoke Bazel to request the list of supported flags. To do so, point the environment variable BAZELRC_LSP_RUN_BAZEL_PATH to your Bazel binary. This is particularly useful for development versions and custom forks of Bazel.

Development

The source code for this extension lives at https://github.com/salesforce-misc/bazelrc-lsp. Contributions are welcome. Feel free to just open a pull request. Further down in this README you can also find a backlog of various ideas, in case you need some inspiration. In case you want to discuss any of those topics (or a topic of your own), please feel free to reach out via a Github issue.

Building from source

1. cd vscode-extension
2. pnpm i
3. pnpm package
4. Install the "hyper-ir-lsp-*.vsix" in VS Code

Current State & Backlog

The extension is complete enough for my personal needs and hopefully useful to you, too.

Long-term, I am considering to integrate this functionality into the official VSCode Bazel extension. This is also why this extension is not published to the VS Code Marketplace as a standalone extension.

Backlog items:

• ✔ Bazel version support
  • ✔ load flags from Bazel's flag dump
  • ✔ pack multiple flag versions & auto-detect version
  • ✔ run bazel help flags-as-proto at runtime based on environment variable
  • ✔ expose settings in VS-Code extension
• ✔ Syntax highlighting / semantic tokens
• Diagnose
  • ✔ unknown flags
  • ✔ allow custom setting flags (--//my/package:setting and --no//my/package:setting)
  • ✔ abbreviated flag names; prefer non-abbreviated flags
  • when using an old, deprecated name (blocked on up-stream Bazel change)
  • ✔ diagnose deprecated flags
  • ✔ diagnose missing imported files
  • ✔ configs on startup, import, try-import
  • ✔ empty config name
  • ✔ config name which doesn't match [a-z_\-]+ (or similar)
  • repeated flags
  • offer fix-it:
    • to replace abbreviated flags by non-abbreviated flags
    • to remove deprecated no-op flags
    • to remove repeated flags
• Hover
  • ✔ Show documentation of flags on hover
  • ✔ Correctly escape <> in Markdown (e.g. problematic in the documentation for --config)
  • Link to flag documentation in hovers
  • Expose default value, value description (blocked on up-stream Bazel change)
  • ✔ Show documentation for commands on hover
• Autocomplete
  • ✔ auto complete command names
  • ✔ flag names
  • flag values:
    • based on available setting values (needs Bazel-side changes)
    • based on previously observed values
  • config names
    • based on config names used elsewhere in the file / project
  • file names for import / try-import
• Format / pretty print
  • improved formatting behavior
    • ✔ basic formatting support
    • ✔ always quote arguments to import / try-import
    • ✔ combine --flag value into --flag=value
    • ✔ "line reflowing" support (all on single line; one flag per line with \ line continuations; one flag per command; ...)
    • ✔ compact multiple consecutive empty lines
    • break up multiline continuations in comments
    • more aggressive reformatting of comments / smarter detection of Markdown, ASCII art etc.
  • ✔ LSP integration
    • ✔ whole document formatting
    • ✔ range formatting
  • ✔ expose formatting through command line to enable integration into CI systems
    • ✔ stdin processing
    • ✔ inplace updates for files
    • ✔ --check-mode
    • ✔ support enumerating all bazelrc files from a folder
  • write documentation, including explanation of different styles
• ✔ link file names for import & try-import
• Rename functionality for config names
• Go to Reference:
  • Other usages of config name
  • Find other usages of same flag