From a7fd52a19077fcff9331fff523b10f8d6e2376ea Mon Sep 17 00:00:00 2001 From: Matthew LeVan Date: Tue, 9 Jul 2024 11:35:22 -0500 Subject: [PATCH] docs: lsp integration --- INSTALL.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 6c4d4e8d1d..5f55e076a9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -113,6 +113,17 @@ you can pass them with [`--per_file_copt`][per_file_copt] like so: bazel build --per_file_copt='pkg/.*@-DMACRO' ``` +## LSP Integration + +```console +bazel run //bazel:refresh_compile_commands +``` + +Running this command will generate a `compile_commands.json` file in the root +of the repository, which `clangd` (or other language server processors) will +use automatically to provide modern editor features like syntax highlighting, +go-to definitions, call hierarchies, symbol manipulation, etc. + ## Test Commands You can build and run unit tests only on native builds. If you have a native