Building from Source

Building from source is the most portable installation method.

git clone https://github.com/ndonfris/fish-lsp && cd fish-lsp
yarn install
yarn build

The command yarn build compiles the source and links ./dist/fish-lsp into your
yarn global bin location (which needs to be accessible in your system $PATH).

Confirm which binary is being used by your shell:

fish-lsp info

Customizing builds

The command yarn build compiles two different target binaries that have different purposes.

• dist/fish-lsp is the normal language-server binary that is typically distributed to end-users. It is a smaller binary that requires the projects dependencies to be accessible (npm/yarn/pnpm would be able to use this file and its package.json to install the required modules for the server to run).

• bin/fish-lsp is a larger binary that is distributed as a release asset which can be downloaded directly and contains all the projects dependencies embedded into the binary itself. For this reason, it is typically much larger than the dist/fish-lsp executable.

yarn build:npm

yarn build:bin

yarn build:npm:nosourcemaps

To further customize the build target, use the command included package.json script dev:

yarn dev # --<FLAG...> to customize the build target
# yarn dev --help to see all available flags

The build script is essentailly a wrapper around the common combinations provided by the dev script.

Watching builds

The yarn watch command can be used to watch the source files and automatically rebuild the project when changes are detected.

yarn watch # normal usage
yarn watch --npm # watch and rebuild the normal dist/fish-lsp target
yarn watch --bin # watch and rebuild the single executable bin/fish-lsp target
yarn watch --mode=test # watch and rebuild and then run the test suite

This is useful if you are live testing the language server in a client and making changes to the source code. Since the language server is linked globally the language-client should be able to pick up the changes automatically when a new build is completed. Depending on which client is being used, restarting the client/server connection might need to be done for this to work correctly (some clients automatically do this though).

Manual Linking

If yarn build compiles but fails to link, test the local binary first:

./dist/fish-lsp info

Then link it manually from the repo root:

yarn unlink -g fish-lsp
yarn link -g .

Re-linking for VSCode

cd ~/.vscode/extensions/ndonfris.fish-lsp-*/
yarn unlink fish-lsp && yarn link fish-lsp

tree-sitter WASM

The build needs tree-sitter-fish.wasm. Normally, this is achieved directly using the npm package @esdmr/tree-sitter-fish, which is a fork of the tree-sitter-fish repository providing a prebuilt wasm binary of the tree-sitter-fish language.

This is not always the case though. Since newer versions of the server embed the wasm dependency directly into the executable, the server could also be using a custom upstream build of the tree-sitter-fish grammar. For releases where a separate wasm file was embedded, the wasm file is included separately in the github release assets (i.e., release 1.1.4 assets)

If you want to use an upstream version of the tree-sitter-fish grammar, you can build the .wasm yourself and point the server at it instead of rebuilding:

set -gx fish_lsp_tree_sitter_wasm_path ~/path/to/tree-sitter-fish.wasm

All build related commands used to compile and bundle the project into its target executable recognize the fish_lsp_tree_sitter_wasm_path environment variable and will use it if set to embed the wasm file directly into the executable.

To build the executable with a custom embedded wasm file, you could use the either of following methods:

set -lx fish_lsp_tree_sitter_wasm_path ~/path/to/tree-sitter-fish.wasm
yarn build

fish_lsp_tree_sitter_wasm_path=~/path/to/tree-sitter-fish.wasm yarn build

The executable will also allow you to override the fish_lsp_tree_sitter_wasm_path environment variable at runtime, so you can use a different .wasm file without rebuilding the executable.

To temporarily override the wasm file used by the executable, for a single server use, you can directly export it to the fish-lsp command:

# here we override the wasm file used by the server for a single command and 
# display the parse tree of the config.fish file using the grammar exported
fish_lsp_tree_sitter_wasm_path=~/path/to/tree-sitter-fish.wasm fish-lsp info --dump-parse-tree ~/.config/fish/config.fish

Development

yarn watch     # watch + rebuild while developing
yarn test      # run the test suite
yarn typecheck # ensure valid type usage project wide
yarn lint:fix  # fix linting issues

See the Contributing guide for the full development workflow.