Skip to content

Commit aba5551

Browse files
committed
Document LSP examples
1 parent 7e602ab commit aba5551

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,79 @@ exclude_patterns:
225225

226226
Set `symbol_index_provider: lsp` to use a language server; it falls back to regex indexing if the LSP binary is missing. Configure `symbol_index_lsp_languages` and `symbol_index_lsp_command` to match your server (for example, `typescript-language-server --stdio` with `ts`/`tsx` language IDs).
227227

228+
### LSP Symbol Index Examples (All Common Languages)
229+
230+
Pick one LSP server per run (one `symbol_index_lsp_command`). Update the language map to match the server you installed.
231+
232+
```yaml
233+
# Rust (rust-analyzer)
234+
symbol_index_provider: lsp
235+
symbol_index_lsp_command: rust-analyzer
236+
symbol_index_lsp_languages:
237+
rs: rust
238+
239+
# TypeScript / JavaScript (typescript-language-server)
240+
# symbol_index_provider: lsp
241+
# symbol_index_lsp_command: "typescript-language-server --stdio"
242+
# symbol_index_lsp_languages:
243+
# ts: typescript
244+
# tsx: typescriptreact
245+
# js: javascript
246+
# jsx: javascriptreact
247+
248+
# Python (python-lsp-server / pylsp)
249+
# symbol_index_provider: lsp
250+
# symbol_index_lsp_command: pylsp
251+
# symbol_index_lsp_languages:
252+
# py: python
253+
# pyi: python
254+
255+
# Go (gopls)
256+
# symbol_index_provider: lsp
257+
# symbol_index_lsp_command: gopls
258+
# symbol_index_lsp_languages:
259+
# go: go
260+
261+
# Java (Eclipse JDT LS)
262+
# symbol_index_provider: lsp
263+
# symbol_index_lsp_command: "jdtls -configuration /path/to/config -data /path/to/workspace"
264+
# symbol_index_lsp_languages:
265+
# java: java
266+
267+
# Kotlin (Kotlin LSP)
268+
# symbol_index_provider: lsp
269+
# symbol_index_lsp_command: "kotlin-lsp.sh --stdio"
270+
# symbol_index_lsp_languages:
271+
# kt: kotlin
272+
273+
# C / C++ (clangd)
274+
# symbol_index_provider: lsp
275+
# symbol_index_lsp_command: clangd
276+
# symbol_index_lsp_languages:
277+
# c: c
278+
# h: c
279+
# cpp: cpp
280+
# hpp: cpp
281+
282+
# C# (csharp-ls)
283+
# symbol_index_provider: lsp
284+
# symbol_index_lsp_command: csharp-ls
285+
# symbol_index_lsp_languages:
286+
# cs: csharp
287+
288+
# Ruby (solargraph)
289+
# symbol_index_provider: lsp
290+
# symbol_index_lsp_command: "solargraph stdio"
291+
# symbol_index_lsp_languages:
292+
# rb: ruby
293+
294+
# PHP (Phpactor)
295+
# symbol_index_provider: lsp
296+
# symbol_index_lsp_command: "phpactor language-server"
297+
# symbol_index_lsp_languages:
298+
# php: php
299+
```
300+
228301
## Plugin Development
229302

230303
Create custom analyzers:

0 commit comments

Comments
 (0)