fish-lsp

<h1 align="center"> <div align="center"> <a href="https://fish-lsp.dev"> <image src="https://raw.githubusercontent.com/ndonfris/fish-lsp.dev/31d3d587ebd00f76ababcc98ed21b5109637e318/public/favicon-centered-bluee.svg" alt="fish-lsp" style="position: flex; text-align: center;" height="23rem"> fish-lsp </a> <div align="center"> <a href="https://github.com/ndonfris/fish-lsp"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/ndonfris/fish-lsp/ci.yml?branch=master&labelColor=%23181939"></a> <a href="https://github.com/ndonfris/fish-lsp/blob/master/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/ndonfris/fish-lsp?&labelColor=%23181939&color=b88af3"></a> <a href="https://github.com/ndonfris/fish-lsp/commits/master/"><img alt="Github Created At" src="https://img.shields.io/github/created-at/ndonfris/fish-lsp?logo=%234e6cfa&label=created&labelColor=%23181939&color=%236198f5"></a> <a href="https://npmjs.org/fish-lsp"><img alt="NPM Downloads" src="https://img.shields.io/npm/dw/fish-lsp?logoColor=%235f5fd7&labelColor=%23181939&color=%235f5fd7"></a> </div> </div> </h1> ![demo.gif](https://github.com/ndonfris/fish-lsp.dev/blob/ndonfris-patch-1/new_output.gif?raw=true) Introducing the [fish-lsp](https://fish-lsp.dev), a [Language Server Protocol (LSP)](https://lsif.dev/) implementation for the [fish shell language](https://fishshell.com). ## Quick Start Please choose a [method to install](#installation) the language server and [configure a client](#client-configuration-required) to use `fish-lsp` in your editor. A detailed explanation of how a language server connection works is described on the following [wiki](https://github.com/ndonfris/fish-lsp/wiki/How-does-it-work%3F) page. ## Why? 🐟 - 🦈 __Efficiency__: enhances the shell scripting experience with an extensive suite of intelligent text-editing [features](#features) - 🐡 __Flexibility__: allows for a highly customizable [configuration](#server-configuration-optional) - 🐚 __Guidance__: [friendly hints](https://github.com/ndonfris/fish-lsp/?tab=readme-ov-file#) and [documentation](#installation) to comfortably explore command line tooling - 🐬 __Community__: improved by a [vibrant user base](#contributors), with [supportive and insightful feedback](https://github.com/ndonfris/fish-lsp/discussions) - 🐙 __Compatibility__: integrates with a wide variety of [tooling and language clients](#client-configuration-required) - 🌊 __Reliability__: produces an [editor agnostic developer environment](https://en.wikipedia.org/wiki/Language_Server_Protocol), ensuring __all__ fish user's have access to a consistent set of features ## 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 | ✅ | ## Installation 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. ### Use a Package Manager Stability across package managers can vary. Consider using another installation method if issues arise. ```bash npm install -g fish-lsp yarn global add fish-lsp pnpm install -g fish-lsp nix-shell -p fish-lsp brew install fish-lsp conda install fish-lsp mamba install fish-lsp ``` You can install the completions by running the following command: ```fish fish-lsp complete > ~/.config/fish/completions/fish-lsp.fish ``` ### Download Standalone Binary Install the standalone binary directly from GitHub releases (no dependencies required): ```bash # 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.fish ``` > __Note:__ > Ensure `~/.local/bin` is in your `$PATH`. ### Build from Source Recommended Dependencies: `yarn@1.22.22` `node@22.14.0` `fish@4.0.8` ```bash git clone https://github.com/ndonfris/fish-lsp cd fish-lsp/ yarn install yarn build # links `./dist/fish-lsp` to `yarn global bin` $PATH ``` Building the project from source is the most portable method for installing the language server. ### Verifying Installation After installation, verify that `fish-lsp` is working correctly: ```bash fish-lsp --help ``` ![fish-lsp --help](https://github.com/ndonfris/fish-lsp.dev/blob/master/public/help-msg-new.png?raw=true) ## Setup To properly configure [fish-lsp](https://fish-lsp.dev), 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](#client-configuration-required). However, further configuration can be specified as a [server configuration](#server-configuration-optional). Some clients may also allow specifying the server configuration directly in the client configuration. ### Client Configuration <ins>(Required)</ins><a href="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](https://github.com/ndonfris/fish-lsp/wiki/Client-Configurations) of your choice, or [submit a PR](https://github.com/ndonfris/fish-lsp-language-clients/pulls) for new configurations. <details> <summary><a id="nvim"></a>neovim (minimum version <code>>= v0.8.x</code>)</summary> Full table of options available in the [neovim documentation](https://neovim.io/doc/user/lsp.html) ```lua 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](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#fish_lsp), or use your client of choice below. > There is also a useful configuration for testing out the language server in `nvim@v0.11.1` included in the [fish-lsp-language-clients](https://github.com/ndonfris/fish-lsp-language-clients/tree/packer) repository. </details> <details> <summary><a id="mason.nvim"></a>mason.nvim</summary> Install the `fish-lsp` using [mason.nvim](https://github.com/mason-org/mason-registry/pull/8609#event-18154473712) ```vimscript :MasonInstall fish-lsp ``` </details> <details> <summary><a id="coc.nvim"></a>coc.nvim</summary> [Neovim](https://neovim.io) client using [coc.nvim](https://github.com/neoclide/coc.nvim) configuration, located inside [coc-settings.json](https://github.com/neoclide/coc.nvim/wiki/Language-servers#register-custom-language-servers) `"languageserver"` key ```json { "fish-lsp": { "command": "fish-lsp", "filetypes": ["fish"], "args": ["start"] } } ``` </details> <details> <summary><a id="YouCompleteMe"></a>YouCompleteMe</summary> [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe) configuration for vim/neovim ```vim let g:ycm_language_server = \ [ \ { \ 'name': 'fish', \ 'cmdline': [ 'fish-lsp', 'start' ], \ 'filetypes': [ 'fish' ], \ } \ ] ``` </details> <details> <summary><a id="vim-lsp"></a>vim-lsp</summary> Configuration of [prabirshrestha/vim-lsp](https://github.com/prabirshrestha/vim-lsp) in your `init.vim` or `init.lua` file ```vim if executable('fish-lsp') au User lsp_setup call lsp#register_server({ \ 'name': 'fish-lsp', \ 'cmd': {server_info->['fish-lsp', 'start']}, \ 'allowlist': ['fish'], \ }) endif ``` </details> <details> <summary><a id="helix"></a>helix</summary> In config file `~/.config/helix/languages.toml` ```toml [[language]] name = "fish" language-servers = [ "fish-lsp" ] [language-server.fish-lsp] command = "fish-lsp" args= ["start"] environment = { "fish_lsp_show_client_popups" = "false" } ``` </details> <details> <summary><a id="kakoune"></a>kakoune</summary> Configuration for [kakoune-lsp](https://github.com/kakoune-lsp/kakoune-lsp), located in `~/.config/kak-lsp/kak-lsp.toml` ```toml [language.fish] filetypes = ["fish"] command = "fish-lsp" args = ["start"] ``` Or in your `~/.config/kak/lsp.kak` file ```kak 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" ] } } ``` </details> <details> <summary><a id="kate"></a>kate</summary> Configuration for [kate](https://kate-editor.org/) ```json { "servers": { "fish": { "command": ["fish-lsp", "start"], "url": "https://github.com/ndonfris/fish-lsp", "highlightingModeRegex": "^fish$" } } } ``` </details> <details> <summary><a id="emacs"></a>emacs</summary> Configuration using [eglot](https://github.com/joaotavora/eglot) (Built into Emacs 29+) ```elisp ;; 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 ```elisp (use-package fish-mode) (with-eval-after-load 'eglot (add-to-list 'eglot-server-programs '(fish-mode . ("fish-lsp" "start")))) ```  Configuration using [lsp-mode](https://github.com/emacs-lsp/lsp-mode) ```elisp ;; 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](https://github.com/doomemacs/doomemacs/tree/master) can be found in the [fish-lsp language clients repo](https://github.com/ndonfris/fish-lsp-language-clients/). </details> <details> <summary><a id="vscode"></a>VSCode <emph><a href='https://github.com/ndonfris/vscode-fish-lsp'>(Source Code Repo)</a></emph></summary> > To download the extension, visit the [fish-lsp extension on the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=ndonfris.fish-lsp). > > VSCode configuration does not require a client configuration. The server will automatically start when a `.fish` file is opened. > > A server configuration can still be specified to control the server's behavior. ([see below](#server-configuration-optional)) </details> <details> <summary><a id="bbedit"></a>BBEdit</summary> > To install the fish-lsp in [BBEdit](https://www.barebones.com/products/bbedit/), please follow the instructions in the repository [fish-lsp-language-clients](https://github.com/ndonfris/fish-lsp-language-clients/blob/bbedit/BBEdit%20Install.md). > > This configuration includes a [Fish.plist](https://github.com/ndonfris/fish-lsp-language-clients/blob/bbedit/Lanugage%20Modules/Fish.plist) file that provides syntax highlighting and other features for the fish shell. </details> ### Server Configuration <ins>(Optional)</ins> Specific functionality for the server can be set independently from the client. The server allows for both [environment variables](#environment-variables) and [command flags](#command-flags) to customize how specific server processes are started. #### Environment variables Environment variables provide a way to globally configure the server across all sessions, but can be overridden interactively[\[1\]](https://fishshell.com/docs/current/language.html#variable-scope) by the current shell session as well. They can easily be auto-generated[\[1\]](#environment-variables-default)[\[2\]](#environment-variables-template)[\[3\]](#environment-variables-json)[\[4\]](#environment-variables-confd) 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`](#environment-variables-confd) flag which will structure the autoloaded environment variables to only be sourced when the `fish-lsp` command exists. <blockquote> <details> <summary> ###### <a id="environment-variables-default">:package:</a> Default Values: <code> fish-lsp env --show-default </code> </summary>  ```fish # $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.log', '~/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' ``` </details> </blockquote> <blockquote> <details> <summary> ###### <a id="environment-variables-template">:gear:</a> Complete Configuration Template: <code> fish-lsp env --create </code> </summary>  ```fish # $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.log', '~/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 ``` </details> </blockquote> <blockquote> <details> <summary> ###### <a id="environment-variables-json">:floppy_disk:</a> Formatting as JSON: <code> fish-lsp env --show-default --json </code> </summary>  ```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" } ``` </details></blockquote> <blockquote> <details> <summary> ###### <a id="environment-variables-writing"> :jigsaw: </a> Writing current values to <code> ~/.config/fish/conf.d/fish-lsp.fish </code> </summary> ```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 ``` </details> </blockquote> For language clients that import the source code directly and manually connect with the server (e.g., [VSCode](https://github.com/ndonfris/vscode-fish-lsp/blob/4aa63803a0d0a65ceabf164eaeb5a3e360662ef9/package.json#L136)), passing the environment configuration through the [`initializeParams.initializationOptions`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initializeParams) is also possible. #### Command Flags Both the flags `--enable` and `--disable` are provided on the `fish-lsp start` subcommand. __Default configuration enables all stable server handlers__. ```fish # displays what handlers are enabled. Removing the dump flag will run the server. fish-lsp start --disable complete signature --dump ``` #### Further Server Configuration Any [flags](#command-flags) will overwrite their corresponding [environment variables](#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](https://fishshell.com/docs/current/language.html#functions) or [aliases](https://fishshell.com/docs/current/language.html#defining-aliases). Due to the vast possibilities this project aims to support in the fish shell, [sharing useful configurations is highly encouraged](https://github.com/ndonfris/fish-lsp/discussions). ##### Project Specific configuration via dot-env 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\]](https://github.com/berk-karaal/loadenv.fish)[\[2\]](https://direnv.net)[\[3\]](https://github.com/jdx/mise)[\[4\]](https://github.com/hyperupcall/autoenv)      ##### Configuration via Disable Comments <div align="center"> ![`# @fish-lsp-disable`](https://github.com/ndonfris/fish-lsp.dev/blob/master/public/comment.svg?raw=true) </div> 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](https://github.com/ndonfris/fish-lsp/wiki) includes a table of [error codes](https://github.com/ndonfris/fish-lsp/wiki/Diagnostic-Error-Codes) that should be helpful. Diagnostics are a newer feature so [PRs](https://github.com/ndonfris/fish-lsp/blob/master/docs/CONTRIBUTING.md#getting-started-rocket) 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](#environment-variables) for an example).                      ## Trouble Shooting If you encounter any issues with the server, the following commands may be useful to help diagnose the problem: - Show every available <a id="#subcommand">sub-command</a> and flag for the `fish-lsp` ```fish fish-lsp --help-all ``` - <a id="info"></a>Ensure that the `fish-lsp` command is available in your system's `$PATH` by running `which fish-lsp` or `fish-lsp info --bin`. ```fish fish-lsp info ``` - <a id="startup"></a>Confirm that the language server is able to startup correctly by indexing the `$fish_lsp_all_indexed_paths` directories. ```fish fish-lsp info --time-startup ``` > <ins>Note:</ins> > There is also, `fish-lsp info --time-only` which 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`. - <a id="health"></a>Check the health of the server. ```fish fish-lsp info --check-health ``` - <a id="logs"></a>Check the server logs, while a server is running. ```fish set -gx fish_lsp_log_file /tmp/fish_lsp.log tail -f (fish-lsp info --log-file) # open the server somewhere else ``` - <a id="source-maps"></a>Enable [source maps](https://www.typescriptlang.org/tsconfig/#sourceMap) to debug the bundled server code. ```fish set -gx NODE_OPTIONS '--enable-source-maps --inspect' $EDITOR ~/.config/fish/config.fish ``` - <a id="tree-sitter"></a>Show the [tree-sitter](https://github.com/esdmr/tree-sitter-fish) parse tree for a specific file: ```fish 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](https://github.com/ndonfris/fish-lsp/wiki/Abbreviations) ## Additional Resources - [Contributing](./docs/CONTRIBUTING.md) - documentation describing how to contribute to the fish-lsp project. - [Roadmap](./docs/ROADMAP.md) - goals for future project releases. - [Wiki](https://github.com/ndonfris/fish-lsp/wiki) - further documentation and knowledge relevant to the project - [Discussions](https://github.com/ndonfris/fish-lsp/discussions) - interact with maintainers - [Site](https://fish-lsp.dev/) - website homepage - [Client Examples](https://github.com/ndonfris/fish-lsp/wiki/Client-Configurations) - testable language client configurations - [Sources](https://github.com/ndonfris/fish-lsp/wiki/Sources) - major influences for the project ## Contributors Contributions of any kind are welcome! Special thanks to anyone who contributed to the project! :pray:    <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ndonfris"><img src="https://avatars.githubusercontent.com/u/49458459?v=4?s=50" width="50px;" alt="nick"/> nick</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=ndonfris" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mimikun"><img src="https://avatars.githubusercontent.com/u/13450321?v=4?s=50" width="50px;" alt="mimikun"/> mimikun</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=mimikun" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jpaju"><img src="https://avatars.githubusercontent.com/u/36770267?v=4?s=50" width="50px;" alt="Jaakko Paju"/> Jaakko Paju</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=jpaju" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/shaleh"><img src="https://avatars.githubusercontent.com/u/1377996?v=4?s=50" width="50px;" alt="Sean Perry"/> Sean Perry</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=shaleh" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://mastodon.online/@cova"><img src="https://avatars.githubusercontent.com/u/385249?v=4?s=50" width="50px;" alt="Fabio Coatti"/> Fabio Coatti</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=cova-fe" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/PeterCardenas"><img src="https://avatars.githubusercontent.com/u/16930781?v=4?s=50" width="50px;" alt="Peter Cardenas"/> Peter Cardenas</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=PeterCardenas" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/petertriho"><img src="https://avatars.githubusercontent.com/u/7420227?v=4?s=50" width="50px;" alt="Peter Tri Ho"/> Peter Tri Ho</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=petertriho" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/bnwa"><img src="https://avatars.githubusercontent.com/u/74591246?v=4?s=50" width="50px;" alt="bnwa"/> bnwa</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=bnwa" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/branchvincent"><img src="https://avatars.githubusercontent.com/u/19800529?v=4?s=50" width="50px;" alt="Branch Vincent"/> Branch Vincent</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=branchvincent" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/devsunb"><img src="https://avatars.githubusercontent.com/u/23169202?v=4?s=50" width="50px;" alt="Jaeseok Lee"/> Jaeseok Lee</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=devsunb" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ClanEver"><img src="https://avatars.githubusercontent.com/u/73160783?v=4?s=50" width="50px;" alt="ClanEver"/> ClanEver</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=ClanEver" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://degruchy.org/"><img src="https://avatars.githubusercontent.com/u/52262673?v=4?s=50" width="50px;" alt="Nathan DeGruchy"/> Nathan DeGruchy</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=ndegruchy" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://teddyhuang-00.github.io/"><img src="https://avatars.githubusercontent.com/u/64199650?v=4?s=50" width="50px;" alt="Nan Huang"/> Nan Huang</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=TeddyHuang-00" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/unlimitedsola"><img src="https://avatars.githubusercontent.com/u/3632663?v=4?s=50" width="50px;" alt="Sola"/> Sola</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=unlimitedsola" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jose-elias-alvarez"><img src="https://avatars.githubusercontent.com/u/54108223?v=4?s=50" width="50px;" alt="Jose Alvarez"/> Jose Alvarez</a> <a href="https://github.com/ndonfris/fish-lsp/commits?author=jose-elias-alvarez" title="Code">💻</a></td> </tr> </tbody> </table>         This project follows the [all-contributors](https://allcontributors.org) specification. ## License [MIT](https://github.com/ndonfris/fish-lsp/blob/master/LICENSE.md)