Skip to content

esdmr/fish-completion

Repository files navigation

Fish completion for VS Code

License VS Code version

Native fish shell completion in VS Code intellisense

Editing large scripts or functions in fish is less ergonomic compared to a proper Text Editor™. However, editors (such as VS Code) either do not provide command completions or do not integrate with the built-in completions of fish.

This extension queries fish shell completions directly. The extension provides The text in the editor to commandline and then complete -C provides it with a list of completions and descriptions.

Note: There is an experimental variable and function completion in v0.2. You can enable it in settings at fish-completion.assistant.v1.enabled.

Requirements

  • script executable in $PATH (to fake a TTY),
  • /dev/null (to dispose of the typescript of script),
  • Working fish shell installation.

Installing from source

This project requires Node.js version 16 minimum. Ensure that you have installed the correct version of Node.js by running node --version.

The following snippet will download, install, and build the source from GitHub:

git clone https://github.com/esdmr/fish-completion.git
cd fish-completion
corepack pnpm install
corepack pnpm run build

After building, you can either use VS Code to launch it or run corepack pnpm run package to generate a vsix file.

Porting to other editors

See Porting to other editors.