aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2025-09-19 21:32:50 +0000
committergithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2025-09-19 21:32:50 +0000
commit107c2458cdc780c4ed2c2b5e1b7800cd019010bd (patch)
tree78b31ab0ff014a9232dcf6b4d505ead64ced7e5f
parentfeat(apex_ls): add vim.lsp.config support #4081 (diff)
downloadnvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar.gz
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar.bz2
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar.lz
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar.xz
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.tar.zst
nvim-lspconfig-107c2458cdc780c4ed2c2b5e1b7800cd019010bd.zip
docs: update configs.md
skip-checks: true
-rw-r--r--doc/configs.md58
-rw-r--r--doc/configs.txt50
2 files changed, 104 insertions, 4 deletions
diff --git a/doc/configs.md b/doc/configs.md
index 41e6bf43..b89c9c5d 100644
--- a/doc/configs.md
+++ b/doc/configs.md
@@ -13,6 +13,7 @@ Nvim by running `:help lspconfig-all`.
- [angularls](#angularls)
- [ansiblels](#ansiblels)
- [antlersls](#antlersls)
+- [apex_ls](#apex_ls)
- [arduino_language_server](#arduino_language_server)
- [asm_lsp](#asm_lsp)
- [ast_grep](#ast_grep)
@@ -703,6 +704,59 @@ Default config:
---
+## apex_ls
+
+https://github.com/forcedotcom/salesforcedx-vscode
+
+ Language server for Apex.
+
+ For manual installation, download the JAR file from the [VSCode
+ extension](https://github.com/forcedotcom/salesforcedx-vscode/tree/develop/packages/salesforcedx-vscode-apex) and adjust the `apex_jar_path` appropriately.
+
+ ```lua
+ vim.lsp.config('apex_ls', {
+ apex_jar_path = '/path/to/apex-jorje-lsp.jar',
+ apex_enable_semantic_errors = false, -- Whether to allow Apex Language Server to surface semantic errors
+ apex_enable_completion_statistics = false, -- Whether to allow Apex Language Server to collect telemetry on code completion usage
+ }
+```
+
+ Example configuration using Mason:
+
+```lua
+ vim.lsp.config('apex_ls', {
+ apex_jar_path = vim.fn.stdpath('data') .. '/mason/share/apex-language-server/apex-jorje-lsp.jar',
+ }
+```
+
+ For a complete experience, you may need to ensure the treesitter parsers for 'apex' are installed (:TSInstall apex) as well as configure the filetype for apex (*.cls) files:
+
+ ```lua
+ vim.filetype.add({
+ pattern = {
+ ['.*/*.cls'] = 'apex',
+ },
+ })
+ ```
+
+Snippet to enable the language server:
+```lua
+vim.lsp.enable('apex_ls')
+```
+
+Default config:
+- `cmd`: [../lsp/apex_ls.lua:37](../lsp/apex_ls.lua#L37)
+- `filetypes` :
+ ```lua
+ { "apex", "apexcode" }
+ ```
+- `root_markers` :
+ ```lua
+ { "sfdx-project.json" }
+ ```
+
+---
+
## arduino_language_server
https://github.com/arduino/arduino-language-server
@@ -2346,11 +2400,11 @@ Default config:
{
editorInfo = {
name = "Neovim",
- version = "0.12.0-dev+g63ece2b151"
+ version = "0.12.0-dev+gb756a6165a"
},
editorPluginInfo = {
name = "Neovim",
- version = "0.12.0-dev+g63ece2b151"
+ version = "0.12.0-dev+gb756a6165a"
}
}
```
diff --git a/doc/configs.txt b/doc/configs.txt
index f69b0bd1..e0cfc8da 100644
--- a/doc/configs.txt
+++ b/doc/configs.txt
@@ -260,6 +260,52 @@ Default config:
<
------------------------------------------------------------------------------
+apex_ls
+
+https://github.com/forcedotcom/salesforcedx-vscode
+
+ Language server for Apex.
+
+ For manual installation, download the JAR file from the [VSCode
+ extension](https://github.com/forcedotcom/salesforcedx-vscode/tree/develop/packages/salesforcedx-vscode-apex) and adjust the `apex_jar_path` appropriately.
+
+ ```lua
+ vim.lsp.config('apex_ls', {
+ apex_jar_path = '/path/to/apex-jorje-lsp.jar',
+ apex_enable_semantic_errors = false, -- Whether to allow Apex Language Server to surface semantic errors
+ apex_enable_completion_statistics = false, -- Whether to allow Apex Language Server to collect telemetry on code completion usage
+ }
+```
+
+ Example configuration using Mason:
+>lua
+ vim.lsp.config('apex_ls', {
+ apex_jar_path = vim.fn.stdpath('data') .. '/mason/share/apex-language-server/apex-jorje-lsp.jar',
+ }
+
+ For a complete experience, you may need to ensure the treesitter parsers for 'apex' are installed (:TSInstall apex) as well as configure the filetype for apex (*.cls) files:
+
+ ```lua
+ vim.filetype.add({
+ pattern = {
+ ['.*/*.cls'] = 'apex',
+ },
+ })
+ ```
+
+Snippet to enable the language server: >lua
+ vim.lsp.enable('apex_ls')
+
+
+Default config:
+- cmd (use "gF" to view): ../lsp/apex_ls.lua:37
+- filetypes: >lua
+ { "apex", "apexcode" }
+- root_markers: >lua
+ { "sfdx-project.json" }
+<
+
+------------------------------------------------------------------------------
arduino_language_server
https://github.com/arduino/arduino-language-server
@@ -1518,11 +1564,11 @@ Default config:
{
editorInfo = {
name = "Neovim",
- version = "0.12.0-dev+g63ece2b151"
+ version = "0.12.0-dev+gb756a6165a"
},
editorPluginInfo = {
name = "Neovim",
- version = "0.12.0-dev+g63ece2b151"
+ version = "0.12.0-dev+gb756a6165a"
}
}
- on_attach (use "gF" to view): ../lsp/copilot.lua:79