cameron-martin / bazel-lsp

A language server implementation for Bazel

Bazel LSP

This is a LSP for bazel, based on starlark-rust.

Features

• Go to definition for identifiers & labels
• Autocomplete for identifiers & labels
• Auto-import (currently only for open files)

Usage

Installation

Download a release from github releases and move it to somewhere on your $PATH.

Alternatively, it can be installed from source by cloning this repo and building with Bazel:

bazel build //:bazel-lsp -c opt

VSCode

Ensure you have the Bazel extension installed, and add the following config to your user settings.json:

{
  "bazel.lsp.command": "bazel-lsp"
}

Restart vscode for this to take effect.

bazel-lsp's Issues

Preserve output bases between language server restarts

75b9306 introduced a distinct output base for querying. However, it uses a temp directory that is deleted after the language server shuts down. This directory is potentially quite expensive to create, so destroying it is not ideal. Instead, we should put it in a permanent location, in a directory named after the hash of the workspace directory.

E2E tests

Just testing the LspContext is not sufficient, particularly for picking up regressions caused by upstream, or integration issues. We should have tests that exercise the whole server.

Support nested local repositories

See https://bazelbuild.slack.com/archives/C014RARENH0/p1702897315236089

Add type information to builtins

#8 added autocomplete to builtins but typed everything as any. We can do better than this since there's a bunch of type information in the protobuf.

Release for more platforms

Currently it only uploads x86 Linux builds. We should do this for more platforms, for example:

• Mac M1
• Mac x86
• Windows x86

Add cc, py and java builtins

#8 added some builtins, but this proto does not include things like cc_library. I'm not sure where these are meant to come from.

Go to definition on files

If a string is a valid file, go to definition should go to it. This will mean that you can jump to files in srcs, hdrs, etc.

Related: bazelbuild/vscode-bazel#238

Revert to checking in MODULE.bazel.lock

To test on more platforms (#14), I had to remove the MODULE.bazel.lock due to a bug in rules_rust. Once bazelbuild/rules_rust#2452 is fixed this can be checked in again.

Go to definition in external repositories does not work

If you use go to definition to go to an external repository, go to definition from that external repository no longer works.

Run bazel in a distinct output base

This prevents concurrent builds from blocking the language server.

See:

• https://github.com/bazelbuild/vscode-bazel/blob/cfc931cc88681774e832669c684bda2b65e9b90f/src/bazel/bazel_query.ts#L124-L132
• https://bazel.build/run/scripts#output-base-option