fish-lsp
Introducing the fish-lsp, a Language Server Protocol (LSP) implementation for the fish shell language.
Please choose a method to install the language server and configure a client to use fish-lsp in your editor.
A detailed explanation of how a language server connection works is described on the following wiki page.
-
🦈 Efficiency: enhances the shell scripting experience with an extensive suite of intelligent text-editing features
-
🐡 Flexibility: allows for a highly customizable configuration
-
🐚 Guidance: friendly hints and documentation to comfortably explore command line tooling
-
🐬 Community: improved by a vibrant user base, with supportive and insightful feedback
-
🐙 Compatibility: integrates with a wide variety of tooling and language clients
-
🌊 Reliability: produces an editor agnostic developer environment, ensuring all fish user's have access to a consistent set of features
| Feature | Description | Status |
|---|---|---|
| Completion | Provides completions for commands, variables, and functions | ✅ |
| Hover | Shows documentation for commands, variables, and functions. Has special handlers for --flag, commands, functions, and variables | ✅ |
| Signature Help | Shows the signature of a command or function | ✅ |
| Goto Definition | Jumps to the definition of a command, variable, function or --flag | ✅ |
| Goto Implementation | Jumps between symbol definitions and completion definitions | ✅ |
| Find References | Shows all references to a command, variable, function, or --flag | ✅ |
| Rename | Rename within matching global && local scope | ✅ |
| Document Symbols | Shows all commands, variables, and functions in a document | ✅ |
| Workspace Symbols | Shows all commands, variables, and functions in a workspace | ✅ |
| Document Formatting | Formats a document, full & selection | ✅ |
| On Type Formatting | Formats a document while typing | ✅ |
| Document Highlight | Highlights all references to a command, variable, or function. | ✅ |
| Command Execution | Executes a server command from the client | ✅ |
| Code Action | Automate code generation | ✅ |
| Quick fix | Auto fix lint issues | ✅ |
| Inlay Hint | Shows Virtual Text/Inlay Hints | ✅ |
| Code Lens | Shows all available code lenses | ✖ |
| Logger | Logs all server activity | ✅ |
| Diagnostic | Shows all diagnostics | ✅ |
| Folding Range | Toggle ranges to fold text | ✅ |
| Selection Range | Expand ranges when selecting text | ✅ |
| Semantic Tokens | Server provides extra syntax highlighting | ✅ |
| CLI Interactivity | Provides a CLI for server interaction. Built by fish-lsp complete |
✅ |
| Client Tree | Shows the defined scope as a Tree | ✅ |
| Indexing | Indexes all commands, variables, functions, and source files | ✅ |
Some language clients might support downloading the fish-lsp directly from within the client, but for the most part, you'll typically be required to install the language server manually.
Below are a few methods to install the language server, and how to verify that it's working.
Stability across package managers can vary. Consider using another installation method if issues arise.
npm install -g fish-lsp
yarn global add fish-lsp
pnpm install -g fish-lsp
nix-shell -p fish-lsp
brew install fish-lspYou can install the completions by running the following command:
fish-lsp complete > ~/.config/fish/completions/fish-lsp.fishInstall the standalone binary directly from GitHub releases (no dependencies required):
# Download the latest standalone binary
curl -L https://github.com/ndonfris/fish-lsp/releases/latest/download/fish-lsp.standalone \
-o ~/.local/bin/fish-lsp
# Make it executable
chmod +x ~/.local/bin/fish-lsp
# Install completions
fish-lsp complete > ~/.config/fish/completions/fish-lsp.fishNote: Ensure
~/.local/binis in your$PATH.
Recommended Dependencies: [email protected] [email protected] [email protected]
git clone https://github.com/ndonfris/fish-lsp
cd fish-lsp/
yarn install
yarn build # links `./dist/fish-lsp` to `yarn global bin` $PATHBuilding the project from source is the most portable method for installing the language server.
After installation, verify that fish-lsp is working correctly:
fish-lsp --help
To properly configure fish-lsp, you need to define a client configuration after installing the language server.
Configuring a client should be relatively straightforward. Typically, you're only required to translate the shell command fish-lsp start for fish files, in the client's configuration. However, further configuration can be specified as a server configuration.
Some clients may also allow specifying the server configuration directly in the client configuration.
Theoretically, the language-server should generally be compatible with almost any text-editor or IDE you prefer using. Feel free to setup the project in any fish-lsp-client of your choice, or submit a PR for new configurations.
neovim (minimum version >= v0.8.x)
Full table of options available in the neovim documentation
vim.api.nvim_create_autocmd('FileType', {
pattern = 'fish',
callback = function()
vim.lsp.start({
name = 'fish-lsp',
cmd = { 'fish-lsp', 'start' },
})
end,
})Alternatively, you can also see official documentation for nvim-lspconfig, or use your client of choice below.
There is also a useful configuration for testing out the language server in
[email protected]included in the fish-lsp-language-clients repository.
coc.nvim
Neovim client using coc.nvim configuration, located inside coc-settings.json "languageserver" key
{
"fish-lsp": {
"command": "fish-lsp",
"filetypes": ["fish"],
"args": ["start"]
}
}YouCompleteMe
YouCompleteMe configuration for vim/neovim
let g:ycm_language_server =
\ [
\ {
\ 'name': 'fish',
\ 'cmdline': [ 'fish-lsp', 'start' ],
\ 'filetypes': [ 'fish' ],
\ }
\ ]vim-lsp
Configuration of prabirshrestha/vim-lsp in your init.vim or init.lua file
if executable('fish-lsp')
au User lsp_setup call lsp#register_server({
\ 'name': 'fish-lsp',
\ 'cmd': {server_info->['fish-lsp', 'start']},
\ 'allowlist': ['fish'],
\ })
endifhelix
In config file ~/.config/helix/languages.toml
[[language]]
name = "fish"
language-servers = [ "fish-lsp" ]
[language-server.fish-lsp]
command = "fish-lsp"
args= ["start"]
environment = { "fish_lsp_show_client_popups" = "false" }kakoune
Configuration for kakoune-lsp, located in ~/.config/kak-lsp/kak-lsp.toml
[language.fish]
filetypes = ["fish"]
command = "fish-lsp"
args = ["start"]
Or in your ~/.config/kak/lsp.kak file
hook -group lsp-filetype-fish global BufSetOption filetype=fish %{
set-option buffer lsp_servers %{
[fish-lsp]
root_globs = [ "*.fish", "config.fish", ".git", ".hg" ]
args = [ "start" ]
}
}kate
Configuration for kate
{
"servers": {
"fish": {
"command": ["fish-lsp", "start"],
"url": "https://github.com/ndonfris/fish-lsp",
"highlightingModeRegex": "^fish$"
}
}
}emacs
Configuration using eglot (Built into Emacs 29+)
;; Add to your init.el or .emacs
(require 'eglot)
(add-to-list 'eglot-server-programs
'(fish-mode . ("fish-lsp" "start")))
;; Optional: auto-start eglot for fish files
(add-hook 'fish-mode-hook 'eglot-ensure)or place in your languages/fish.el file
(use-package fish-mode)
(with-eval-after-load 'eglot
(add-to-list 'eglot-server-programs
'(fish-mode . ("fish-lsp" "start"))))Configuration using lsp-mode
;; Add to your init.el or .emacs
(require 'lsp-mode)
(lsp-register-client
(make-lsp-client
:new-connection (lsp-stdio-connection '("fish-lsp" "start"))
:activation-fn (lsp-activate-on "fish")
:server-id 'fish-lsp))
;; Optional: auto-start lsp for fish files
(add-hook 'fish-mode-hook #'lsp)Full example configuration using doom-emacs can be found in the fish-lsp language clients repo.
VSCode (Source Code Repo)
To download the extension, visit the fish-lsp extension on the VSCode Marketplace.
VSCode configuration does not require a client configuration. The server will automatically start when a
.fishfile is opened.A server configuration can still be specified to control the server's behavior. (see below)
BBEdit
To install the fish-lsp in BBEdit, please follow the instructions in the repository fish-lsp-language-clients.
This configuration includes a Fish.plist file that provides syntax highlighting and other features for the fish shell.
Specific functionality for the server can be set independently from the client. The server allows for both environment variables and command flags to customize how specific server processes are started.
Environment variables provide a way to globally configure the server across all sessions, but can be overridden interactively[1] by the current shell session as well. They can easily be auto-generated[1][2][3][4] for multiple different use cases using the fish-lsp env command.
You can store them directly in your config.fish to be autoloaded for every fish session. Or if you prefer a more modular approach, checkout the --confd flag which will structure the autoloaded environment variables to only be sourced when the fish-lsp command exists.
📦 Default Values:
fish-lsp env --show-default# $fish_lsp_enabled_handlers <ARRAY> # Enables the fish-lsp handlers. By default, all stable handlers are enabled. # (Options: 'complete', 'hover', 'rename', 'definition', 'implementation', # 'reference', 'logger', 'formatting', 'formatRange', # 'typeFormatting', 'codeAction', 'codeLens', 'folding', # 'selectionRange', 'signature', 'executeCommand', 'inlayHint', # 'highlight', 'diagnostic', 'popups', 'semanticTokens') # (Default: []) set -gx fish_lsp_enabled_handlers # $fish_lsp_disabled_handlers <ARRAY> # Disables the fish-lsp handlers. By default, non-stable handlers are disabled. # (Options: 'complete', 'hover', 'rename', 'definition', 'implementation', # 'reference', 'logger', 'formatting', 'formatRange', # 'typeFormatting', 'codeAction', 'codeLens', 'folding', # 'selectionRange', 'signature', 'executeCommand', 'inlayHint', # 'highlight', 'diagnostic', 'popups', 'semanticTokens') # (Default: []) set -gx fish_lsp_disabled_handlers # $fish_lsp_commit_characters <ARRAY> # Array of the completion expansion characters. # Single letter values only. # Commit characters are used to select completion items, as shortcuts. # (Example Options: '.', ',', ';', ':', '(', ')', '[', ']', '{', '}', '<', # '>', ''', '"', '=', '+', '-', '/', '\', '|', '&', '%', # '$', '#', '@', '!', '?', '*', '^', '`', '~', '\t', ' ') # (Default: ['\t', ';', ' ']) set -gx fish_lsp_commit_characters '\t' ';' ' ' # $fish_lsp_log_file <STRING> # A path to the fish-lsp's logging file. Empty string disables logging. # (Example Options: '/tmp/fish_lsp.logs', '~/path/to/fish_lsp/logs.txt') # (Default: '') set -gx fish_lsp_log_file '' # $fish_lsp_log_level <STRING> # The logging severity level for displaying messages in the log file. # (Options: 'debug', 'info', 'warning', 'error', 'log') # (Default: '') set -gx fish_lsp_log_level '' # $fish_lsp_all_indexed_paths <ARRAY> # The fish file paths to include in the fish-lsp's startup indexing, as workspaces. # Order matters (usually place `$__fish_config_dir` before `$__fish_data_dir`). # (Example Options: '$HOME/.config/fish', '/usr/share/fish', # '$__fish_config_dir', '$__fish_data_dir') # (Default: ['$__fish_config_dir', '$__fish_data_dir']) set -gx fish_lsp_all_indexed_paths "$__fish_config_dir" "$__fish_data_dir" # $fish_lsp_modifiable_paths <ARRAY> # The fish file paths, for workspaces where global symbols can be renamed by the user. # (Example Options: '/usr/share/fish', '$HOME/.config/fish', # '$__fish_data_dir', '$__fish_config_dir') # (Default: ['$__fish_config_dir']) set -gx fish_lsp_modifiable_paths "$__fish_config_dir" # $fish_lsp_diagnostic_disable_error_codes <ARRAY> # The diagnostics error codes to disable from the fish-lsp's diagnostics. # (Options: 1001, 1002, 1003, 1004, 1005, 2001, 2002, 2003, 2004, 3001, 3002, # 3003, 4001, 4002, 4003, 4004, 4005, 4006, 4007, 4008, 5001, 5555, # 6001, 7001, 8001, 9999) # (Default: []) set -gx fish_lsp_diagnostic_disable_error_codes # $fish_lsp_max_diagnostics <NUMBER> # The maximum number of diagnostics to return per file. # Using value `0` means unlimited diagnostics. # To entirely disable diagnostics use `fish_lsp_disabled_handlers` # (Example Options: 0, 10, 25, 50, 100, 250) # (Default: 0) set -gx fish_lsp_max_diagnostics 0 # $fish_lsp_enable_experimental_diagnostics <BOOLEAN> # Enables the experimental diagnostics feature, using `fish --no-execute`. # This feature will enable the diagnostic error code 9999 (disabled by default). # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_enable_experimental_diagnostics false # $fish_lsp_strict_conditional_command_warnings <BOOLEAN> # Diagnostic `3002` includes/excludes conditionally chained commands to explicitly check existence. # ENABLED EXAMPLE: `command -q ls && command ls || echo 'no ls'` # DISABLED EXAMPLE: `command ls || echo 'no ls'` # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_strict_conditional_command_warnings false # $fish_lsp_prefer_builtin_fish_commands <BOOLEAN> # Show diagnostic `2004` which warns the user when they are using a recognized external command that can be replaced by an equivalent fish builtin command. # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_prefer_builtin_fish_commands false # $fish_lsp_allow_fish_wrapper_functions <BOOLEAN> # Show warnings when `alias`, `export`, etc... are used instead of their equivalent fish builtin commands. # Some commands will provide quick-fixes to convert this diagnostic to its equivalent fish command. # Diagnostic `2002` is shown when this setting is false, and hidden when true. # (Options: 'true', 'false') # (Default: 'true') set -gx fish_lsp_allow_fish_wrapper_functions true # $fish_lsp_require_autoloaded_functions_to_have_description <BOOLEAN> # Show warning diagnostic `4008` when an autoloaded function definition does not have a description `function -d/--description '...'; end;` # (Options: 'true', 'false') # (Default: 'true') set -gx fish_lsp_require_autoloaded_functions_to_have_description true # $fish_lsp_max_background_files <NUMBER> # The maximum number of background files to read into buffer on startup. # (Example Options: 100, 250, 500, 1000, 5000, 10000) # (Default: 10000) set -gx fish_lsp_max_background_files 10000 # $fish_lsp_show_client_popups <BOOLEAN> # Should the client receive pop-up window notification requests from the fish-lsp server? # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_show_client_popups true # $fish_lsp_single_workspace_support <BOOLEAN> # Try to limit the fish-lsp's workspace searching to only the current workspace open. # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_single_workspace_support false # $fish_lsp_ignore_paths <ARRAY> # Glob paths to never search when indexing their parent folder # (Example Options: '**/.git/**', '**/node_modules/**', '**/vendor/**', # '**/__pycache__/**', '**/docker/**', # '**/containerized/**', '**/*.log', '**/tmp/**') # (Default: ['**/.git/**', '**/node_modules/**', '**/containerized/**', # '**/docker/**']) set -gx fish_lsp_ignore_paths '**/.git/**' '**/node_modules/**' '**/containerized/**' '**/docker/**' # $fish_lsp_max_workspace_depth <NUMBER> # The maximum depth for the lsp to search when starting up. # (Example Options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20) # (Default: 5) set -gx fish_lsp_max_workspace_depth 3 # $fish_lsp_fish_path <STRING> # A path to the fish executable to use exposing fish binary to use in server's spawned child_processes. # Typically, this is used in the language-client's `FishServer.initialize(connection, InitializeParams.initializationOptions)`, NOT as an environment variable # (Example Options: 'fish', '/usr/bin/fish', '/usr/.local/bin/fish', # '~/.local/bin/fish') # (Default: '') set -gx fish_lsp_fish_path 'fish'
⚙️ Complete Configuration Template:
fish-lsp env --create# $fish_lsp_enabled_handlers <ARRAY> # Enables the fish-lsp handlers. By default, all stable handlers are enabled. # (Options: 'complete', 'hover', 'rename', 'definition', 'implementation', # 'reference', 'logger', 'formatting', 'formatRange', # 'typeFormatting', 'codeAction', 'codeLens', 'folding', # 'selectionRange', 'signature', 'executeCommand', 'inlayHint', # 'highlight', 'diagnostic', 'popups', 'semanticTokens') # (Default: []) set -gx fish_lsp_enabled_handlers # $fish_lsp_disabled_handlers <ARRAY> # Disables the fish-lsp handlers. By default, non-stable handlers are disabled. # (Options: 'complete', 'hover', 'rename', 'definition', 'implementation', # 'reference', 'logger', 'formatting', 'formatRange', # 'typeFormatting', 'codeAction', 'codeLens', 'folding', # 'selectionRange', 'signature', 'executeCommand', 'inlayHint', # 'highlight', 'diagnostic', 'popups', 'semanticTokens') # (Default: []) set -gx fish_lsp_disabled_handlers # $fish_lsp_commit_characters <ARRAY> # Array of the completion expansion characters. # Single letter values only. # Commit characters are used to select completion items, as shortcuts. # (Example Options: '.', ',', ';', ':', '(', ')', '[', ']', '{', '}', '<', # '>', ''', '"', '=', '+', '-', '/', '\', '|', '&', '%', # '$', '#', '@', '!', '?', '*', '^', '`', '~', '\t', ' ') # (Default: ['\t', ';', ' ']) set -gx fish_lsp_commit_characters # $fish_lsp_log_file <STRING> # A path to the fish-lsp's logging file. Empty string disables logging. # (Example Options: '/tmp/fish_lsp.logs', '~/path/to/fish_lsp/logs.txt') # (Default: '') set -gx fish_lsp_log_file # $fish_lsp_log_level <STRING> # The logging severity level for displaying messages in the log file. # (Options: 'debug', 'info', 'warning', 'error', 'log') # (Default: '') set -gx fish_lsp_log_level # $fish_lsp_all_indexed_paths <ARRAY> # The fish file paths to include in the fish-lsp's startup indexing, as workspaces. # Order matters (usually place `$__fish_config_dir` before `$__fish_data_dir`). # (Example Options: '$HOME/.config/fish', '/usr/share/fish', # '$__fish_config_dir', '$__fish_data_dir') # (Default: ['$__fish_config_dir', '$__fish_data_dir']) set -gx fish_lsp_all_indexed_paths # $fish_lsp_modifiable_paths <ARRAY> # The fish file paths, for workspaces where global symbols can be renamed by the user. # (Example Options: '/usr/share/fish', '$HOME/.config/fish', # '$__fish_data_dir', '$__fish_config_dir') # (Default: ['$__fish_config_dir']) set -gx fish_lsp_modifiable_paths # $fish_lsp_diagnostic_disable_error_codes <ARRAY> # The diagnostics error codes to disable from the fish-lsp's diagnostics. # (Options: 1001, 1002, 1003, 1004, 1005, 2001, 2002, 2003, 2004, 3001, 3002, # 3003, 4001, 4002, 4003, 4004, 4005, 4006, 4007, 4008, 5001, 5555, # 6001, 7001, 8001, 9999) # (Default: []) set -gx fish_lsp_diagnostic_disable_error_codes # $fish_lsp_max_diagnostics <NUMBER> # The maximum number of diagnostics to return per file. # Using value `0` means unlimited diagnostics. # To entirely disable diagnostics use `fish_lsp_disabled_handlers` # (Example Options: 0, 10, 25, 50, 100, 250) # (Default: 0) set -gx fish_lsp_max_diagnostics # $fish_lsp_enable_experimental_diagnostics <BOOLEAN> # Enables the experimental diagnostics feature, using `fish --no-execute`. # This feature will enable the diagnostic error code 9999 (disabled by default). # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_enable_experimental_diagnostics # $fish_lsp_strict_conditional_command_warnings <BOOLEAN> # Diagnostic `3002` includes/excludes conditionally chained commands to explicitly check existence. # ENABLED EXAMPLE: `command -q ls && command ls || echo 'no ls'` # DISABLED EXAMPLE: `command ls || echo 'no ls'` # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_strict_conditional_command_warnings # $fish_lsp_prefer_builtin_fish_commands <BOOLEAN> # Show diagnostic `2004` which warns the user when they are using a recognized external command that can be replaced by an equivalent fish builtin command. # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_prefer_builtin_fish_commands # $fish_lsp_allow_fish_wrapper_functions <BOOLEAN> # Show warnings when `alias`, `export`, etc... are used instead of their equivalent fish builtin commands. # Some commands will provide quick-fixes to convert this diagnostic to its equivalent fish command. # Diagnostic `2002` is shown when this setting is false, and hidden when true. # (Options: 'true', 'false') # (Default: 'true') set -gx fish_lsp_allow_fish_wrapper_functions # $fish_lsp_require_autoloaded_functions_to_have_description <BOOLEAN> # Show warning diagnostic `4008` when an autoloaded function definition does not have a description `function -d/--description '...'; end;` # (Options: 'true', 'false') # (Default: 'true') set -gx fish_lsp_require_autoloaded_functions_to_have_description # $fish_lsp_max_background_files <NUMBER> # The maximum number of background files to read into buffer on startup. # (Example Options: 100, 250, 500, 1000, 5000, 10000) # (Default: 10000) set -gx fish_lsp_max_background_files # $fish_lsp_show_client_popups <BOOLEAN> # Should the client receive pop-up window notification requests from the fish-lsp server? # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_show_client_popups # $fish_lsp_single_workspace_support <BOOLEAN> # Try to limit the fish-lsp's workspace searching to only the current workspace open. # (Options: 'true', 'false') # (Default: 'false') set -gx fish_lsp_single_workspace_support # $fish_lsp_ignore_paths <ARRAY> # Glob paths to never search when indexing their parent folder # (Example Options: '**/.git/**', '**/node_modules/**', '**/vendor/**', # '**/__pycache__/**', '**/docker/**', # '**/containerized/**', '**/*.log', '**/tmp/**') # (Default: ['**/.git/**', '**/node_modules/**', '**/containerized/**', # '**/docker/**']) set -gx fish_lsp_ignore_paths # $fish_lsp_max_workspace_depth <NUMBER> # The maximum depth for the lsp to search when starting up. # (Example Options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20) # (Default: 5) set -gx fish_lsp_max_workspace_depth # $fish_lsp_fish_path <STRING> # A path to the fish executable to use exposing fish binary to use in server's spawned child_processes. # Typically, this is used in the language-client's `FishServer.initialize(connection, InitializeParams.initializationOptions)`, NOT as an environment variable # (Example Options: 'fish', '/usr/bin/fish', '/usr/.local/bin/fish', # '~/.local/bin/fish') # (Default: '') set -gx fish_lsp_fish_path
💾 Formatting as JSON:
fish-lsp env --show-default --json{ "fish_lsp_enabled_handlers": [], "fish_lsp_disabled_handlers": [], "fish_lsp_commit_characters": [ "\t", ";", " " ], "fish_lsp_log_file": "", "fish_lsp_log_level": "", "fish_lsp_all_indexed_paths": [ "$__fish_config_dir", "$__fish_data_dir" ], "fish_lsp_modifiable_paths": [ "$__fish_config_dir" ], "fish_lsp_diagnostic_disable_error_codes": [], "fish_lsp_max_diagnostics": 0, "fish_lsp_enable_experimental_diagnostics": false, "fish_lsp_strict_conditional_command_warnings": false, "fish_lsp_prefer_builtin_fish_commands": false, "fish_lsp_allow_fish_wrapper_functions": true, "fish_lsp_require_autoloaded_functions_to_have_description": true, "fish_lsp_max_background_files": 10000, "fish_lsp_show_client_popups": true, "fish_lsp_single_workspace_support": false, "fish_lsp_ignore_paths": [ "**/.git/**", "**/node_modules/**", "**/containerized/**", "**/docker/**" ], "fish_lsp_max_workspace_depth": 3, "fish_lsp_fish_path": "fish" }
🧩 Writing current values to
~/.config/fish/conf.d/fish-lsp.fish## clear the current fish-lsp configuration ## >_ fish-lsp env --names-only | string split \n | read -e $name; ## grab only specific variables fish-lsp env --show-default --only fish_lsp_all_indexed_paths fish_lsp_diagnostic_disable_error_codes | source ## Write the current fish-lsp configuration to ~/.config/fish/conf.d/fish-lsp.fish fish-lsp env --show --confd > ~/.config/fish/conf.d/fish-lsp.fish
For language clients that import the source code directly and manually connect with the server (e.g., VSCode), passing the environment configuration through the initializeParams.initializationOptions is also possible.
Both the flags --enable and --disable are provided on the fish-lsp start subcommand. Default configuration enables all stable server handlers.
# displays what handlers are enabled. Removing the dump flag will run the server.
fish-lsp start --disable complete signature --dump Any flags will overwrite their corresponding environment variables, if both are seen for the fish-lsp process. For this reason, it is encouraged to wrap any non-standard behavior of the fish-lsp in functions or aliases.
Due to the vast possibilities this project aims to support in the fish shell, sharing useful configurations is highly encouraged.
If you are using the environment variables, or an alias to start the server from a shell instance, you can also use a .env file to set project specific overrides.
This is not directly supported by the server, but can be achieved using the variety of dotenv tools available.[1][2][3][4]
Single document configurations can be set using fish-shell comments to disable diagnostics or formatting from applying to specific lines or sections of a file. These comments are parsed by the server when a file is opened, and can be placed anywhere in the file.
If you're interested in disabling specific diagnostic messages, the wiki includes a table of error codes that should be helpful. Diagnostics are a newer feature so PRs are welcome to improve their support.
Any diagnostic can be disabled by providing its error code to the environment variable fish_lsp_diagnostic_disable_error_codes (see the template above for an example).
If you encounter any issues with the server, the following commands may be useful to help diagnose the problem:
-
Show every available sub-command and flag for the
fish-lspfish-lsp --help-all -
Ensure that the
fish-lspcommand is available in your system's$PATHby runningwhich fish-lsporfish-lsp info --bin.fish-lsp info
-
Confirm that the language server is able to startup correctly by indexing the
$fish_lsp_all_indexed_pathsdirectories.fish-lsp info --time-startupNote: There is also,
fish-lsp info --time-onlywhich will show a less verbose summary of the startup timings. To limit either of these flags to a specific folder, use--use-workspace ~/path/to/fish. -
Check the health of the server.
fish-lsp info --check-health -
Check the server logs, while a server is running.
set -gx fish_lsp_log_file /tmp/fish_lsp.logs tail -f (fish-lsp info --log-file) # open the server somewhere else
-
Enable source maps to debug the bundled server code.
set -gx NODE_OPTIONS '--enable-source-maps --inspect' $EDITOR ~/.config/fish/config.fish
-
Show the tree-sitter parse tree for a specific file:
fish-lsp info --dump-parse-tree path/to/file.fish
Abbreviations to shorten the amount of characters typed for many of the above commands are available on the wiki
- Contributing - documentation describing how to contribute to the fish-lsp project.
- Roadmap - goals for future project releases.
- Wiki - further documentation and knowledge relevant to the project
- Discussions - interact with maintainers
- Site - website homepage
- Client Examples - testable language client configurations
- Sources - major influences for the project
Contributions of any kind are welcome! Special thanks to anyone who contributed to the project! 🙏
 nick 💻 |
 mimikun 💻 |
 Jaakko Paju 💻 |
 Sean Perry 💻 |
 Fabio Coatti 💻 |
 Peter Cardenas 💻 |
 Peter Tri Ho 💻 |
 bnwa 💻 |
 Branch Vincent 💻 |
 Jaeseok Lee 💻 |
 ClanEver 💻 |
 Nathan DeGruchy 💻 |
 Nan Huang 💻 |
 Sola 💻 |
 Jose Alvarez 💻 |
This project follows the all-contributors specification.
