document how to setup per-project configuration for each editor

Techatrix · Techatrix · commit e3135ff4e8ed · 2025-06-05T21:07:40.000+02:00
diff --git a/content/zls/configure/in-editor.smd b/content/zls/configure/in-editor.smd
@@ -7,26 +7,32 @@
 } 
 ---
 
-In-Editor Config (or Workspace Config) will integrate with the config system of your editor to configure ZLS on a per-editor basis. 
-
-Some editors (like VS Code) also allow workspace-specific configuration. If you want to share the same configuration across multiple editors, please refer to the [zls.json]($link.page('zls/configure/zls-json')) alternative.
+In-Editor Config (a.k.a workspace configuration) will integrate with the config system of your editor to configure ZLS on a per-editor basis. Most editors also support per-project configuration.
 
 ## Supported Editors
 
-| Editor                                                        |  in-editor config support |
-| ------------------------------------------------------------- | ------------------------- |
-| [VS Code](/zls/editors/vscode)                                | Yes                       |
-| [Sublime Text](/zls/editors/sublime-text)                     | Yes                       |
-| [ZigBrains for JetBrains](/zls/editors/jetbrains)             | Limited\*                 |
-| [Helix](/zls/editors/helix)                                   | Yes                       |
-| [Zed](/zls/editors/zed)                                       | Yes                       |
-| [Neovim with nvim-lspconfig](/zls/editors/vim/nvim-lspconfig) | Yes                       |
-| [Vim/Neovim with CoC](/zls/editors/vim/coc)                   | Yes                       |
-| [Vim/Neovim with YCM](/zls/editors/vim/ycm)                   | Yes\*\*                   |
-| [Emacs with eglot](/zls/editors/emacs)                        | Yes                       |
-| [Emacs with lsp-mode](/zls/editors/emacs)                     | Yes                       |
-| [Kate](/zls/editors/kate)                                     | Yes                       |
+| Editor                                                        | supported? |
+| ------------------------------------------------------------- | ---------- |
+| [VS Code](/zls/editors/vscode)                                | Yes        |
+| [Sublime Text](/zls/editors/sublime-text)                     | Yes        |
+| [ZigBrains for JetBrains](/zls/editors/jetbrains)             | Limited\*  |
+| [Helix](/zls/editors/helix)                                   | Yes        |
+| [Zed](/zls/editors/zed)                                       | Yes        |
+| [Neovim with nvim-lspconfig](/zls/editors/vim/nvim-lspconfig) | Yes        |
+| [Vim/Neovim with CoC](/zls/editors/vim/coc)                   | Yes        |
+| [Vim/Neovim with YCM](/zls/editors/vim/ycm)                   | Yes        |
+| [Emacs with eglot](/zls/editors/emacs)                        | Yes        |
+| [Emacs with lsp-mode](/zls/editors/emacs)                     | Yes        |
+| [Kate](/zls/editors/kate)                                     | Yes        |
 
 \* Only a subset of config options are available.
 
-\*\* In-Editor configuration is somewhat tedious to setup for this Editor. You may favor the [zls.json]($link.page('zls/configure/zls-json')) alternative.
+## Available Config Options
+
+Most editors do not know which config options are available for a language server like ZLS. ZLS provides a [JSON Schema](https://github.com/zigtools/zls/blob/master/schema.json) that can be used to find all available config options.
+
+Be aware that configuration options change over time. The linked schema file above assumes that you are using ZLS nightly/master. When using a tagged release of ZLS, use the JSON Schema file corresponding to that version, like so:
+
+```
+https://raw.githubusercontent.com/zigtools/zls/refs/tags/<ZLS_VERSION_HERE>/schema.json
+```
diff --git a/content/zls/editors/emacs/gnu-emacs.smd b/content/zls/editors/emacs/gnu-emacs.smd
@@ -44,8 +44,6 @@ To apply [in-editor-configuration](/zls/configure/in-editor) or manually specify
          )))))
 ```
 
-Eglot also supports Project-specific or User-specific [server configuration](https://www.gnu.org/software/emacs/manual/html_node/eglot/Advanced-server-configuration.html).
-
 Use `M-x eglot` in a zig-mode buffer to start the server or add a hook:
 
 ```
@@ -70,5 +68,6 @@ Add the following to run `source.fixAll` code action on save:
 
 Use `M-x eglot-code-action-organize-imports` to manually execute the code action.
 
-# lsp-mode
+### Per-project config
 
+Eglot supports per-project configuration which is documented in the [Advanced server configuration](https://www.gnu.org/software/emacs/manual/html_node/eglot/Advanced-server-configuration.html) docs. 
diff --git a/content/zls/editors/helix.smd b/content/zls/editors/helix.smd
@@ -49,3 +49,9 @@ For more information on the health check results refer to [Health check](https:/
 ## Code Actions on save
 
 Helix does not yet support running code actions on save. See [helix-editor/helix#1565](https://github.com/helix-editor/helix/issues/1565).
+
+## Per-project config
+
+Helix allows setting LSP settings per project via a `./helix/config.toml` file. For more information, check the Helix [configuration docs](https://docs.helix-editor.com/configuration.html). 
+
+If the use case for per-project config is to set the path to the Zig or ZLS executable, consider using [direnv](https://direnv.net/) to add it to your `$PATH` or use a version manager for Zig and ZLS.
diff --git a/content/zls/editors/kate.smd b/content/zls/editors/kate.smd
@@ -51,3 +51,21 @@ To apply [in-editor-configuration](/zls/configure/in-editor) or manually specify
 ## Code Actions on save
 
 Kate does not support code actions on save.
+
+## Per-project config
+
+Kate's [LSP Client Plugin](https://docs.kde.org/stable5/en/kate/kate/kate-application-plugin-lspclient.html) allows setting LSP settings per project via a `.kateproject` file. Here is an example of how this could look like:
+
+```json
+{
+  "lspclient": {
+    "servers": {
+      "zig": {
+        "settings": {
+          "enable_build_on_save": true
+        }
+      }
+    }
+  }
+}
+```
diff --git a/content/zls/editors/sublime-text.smd b/content/zls/editors/sublime-text.smd
@@ -94,3 +94,7 @@
   }
 }
 ```
+
+## Per-project config
+
+The Sublime Text LSP plugin allows setting LSP settings per project via a `.sublime-project` file. See [per-project-overrides](https://lsp.sublimetext.io/client_configuration/#per-project-overrides).
diff --git a/content/zls/editors/vim/coc.smd b/content/zls/editors/vim/coc.smd
@@ -32,7 +32,7 @@
     // Show inlay hints in the editor. Inlay hints are short annotations within the code,
     // which show variable types or parameter names.
     // "inlayHint.enable": true,
-    
+
     // Use the language server to perform code highlighting
     "semanticTokens.enable": true
   },
@@ -110,3 +110,9 @@ vim.api.nvim_create_autocmd('BufWritePre',{
 ```vim
 autocmd BufWritePre *.zig,*.zon call CocActionAsync('organizeImport')
 ```
+
+## Per-project config
+
+Coc allows setting LSP settings per project via a `.vim/coc-settings.json` file. Use the `:CocLocalConfig` to create and open the settings file in your workspace folder. Run `:h coc-configuration` for more information.
+
+If the use case for per-project config is to set the path to the Zig or ZLS executable, consider using [direnv](https://direnv.net/) to add it to your `$PATH` or use a version manager for Zig and ZLS.
diff --git a/content/zls/editors/vim/nvim-lspconfig.smd b/content/zls/editors/vim/nvim-lspconfig.smd
@@ -178,3 +178,9 @@ autocmd BufWritePre *.zig,*.zon lua vim.lsp.buf.code_action({
   apply = true,
 })
 ```
+
+## Per-project config
+
+Neovim allows setting LSP settings per project via [exrc](https://neovim.io/doc/user/options.html#'exrc').
+
+If the use case for per-project config is to set the path to the Zig or ZLS executable, consider using [direnv](https://direnv.net/) to add it to your `$PATH` or use a version manager for Zig and ZLS.
diff --git a/content/zls/editors/vscode.smd b/content/zls/editors/vscode.smd
@@ -64,6 +64,8 @@ With that being said, there are some Zig specific settings that you may wish to
 }
 ```
 
+For more information, checkout the VS Code docs about [Settings](https://code.visualstudio.com/docs/configure/settings).
+
 ### Additional Config Options
 
 The available config options in the VS Code extension match those that are offered by the latest nightly build of ZLS. (sometimes they are out of sync)
diff --git a/content/zls/editors/zed.smd b/content/zls/editors/zed.smd
@@ -61,3 +61,9 @@ Add the following to your `settings.json`:
   }
 }
 ```
+
+## Per-project config
+
+Zed supports per-project configuration by creating a `.zed/settings.json` inside a project. For more information, check the Zed about [configuration docs](https://zed.dev/docs/configuring-zed#configuring-zed). 
+
+If the use case for per-project config is to set the path to the Zig executable, consider using [direnv](https://zed.dev/docs/configuring-zed#direnv-integration) to add it to your `$PATH`.

Original file line number	Diff line number	Diff line change
`@@ -94,3 +94,7 @@`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	```
	`97`	`+`
	`98`	`+## Per-project config`
	`99`	`+`
	`100`	+The Sublime Text LSP plugin allows setting LSP settings per project via a `.sublime-project` file. See [per-project-overrides](https://lsp.sublimetext.io/client_configuration/#per-project-overrides).
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@ With that being said, there are some Zig specific settings that you may wish to`
`64`	`64`	`}`
`65`	`65`	```
`66`	`66`
	`67`	`+For more information, checkout the VS Code docs about [Settings](https://code.visualstudio.com/docs/configure/settings).`
	`68`	`+`
`67`	`69`	`### Additional Config Options`
`68`	`70`
`69`	`71`	`The available config options in the VS Code extension match those that are offered by the latest nightly build of ZLS. (sometimes they are out of sync)`
Original file line number	Diff line number	Diff line change
@@ -61,3 +61,9 @@ Add the following to your `settings.json`:
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	```
	`64`	`+`
	`65`	`+## Per-project config`
	`66`	`+`
	`67`	+Zed supports per-project configuration by creating a `.zed/settings.json` inside a project. For more information, check the Zed about [configuration docs](https://zed.dev/docs/configuring-zed#configuring-zed).
	`68`	`+`
	`69`	+If the use case for per-project config is to set the path to the Zig executable, consider using [direnv](https://zed.dev/docs/configuring-zed#direnv-integration) to add it to your `$PATH`.