This is an addon for Vim providing support for editing fish scripts.
- Syntax highlighting and filetype detection, of course.
- Automatic indentation based on keywords for control structures.
- Automatic folds for everything that
endterminates in fish.
- Code formatting with
- Jumping to file in fish's function path that defines the function under the
cursor using the
- Searching for definitions including sourced files using commands like
- Keyword lookup that includes pages for fish builtins using the
- Completions from fish using the
- Syntax checking with quickfix using the
funcedexperience using commands like
Sto instantly start typing commands in the function body.
funcedwhen manually creating new functions.
- Automatic formatting of comments.
For everything above to work you need to have fish installed in
some Vim features turned on. First, tell Vim to use the syntax and filetype
functionality, normally in your
syntax enable filetype plugin indent on
Next, set some options for the
fish filetype. You can do this either by
prefixing each line with
autocmd FileType fish, or by putting them in your
" Set up :make to use fish for syntax checking. compiler fish " Set this to have long lines wrap inside comments. setlocal textwidth=79 " Enable folding of block structures in fish. setlocal foldmethod=expr
To make the folds more pleasant to work with you might also want to tweak
foldminlines, which you could do either
globally in your
~/.vimrc or locally as described above.
A team player
vim-fish ships with:
- Code snippets for UltiSnips
- A syntax checker for Syntastic
- Insertion rules for endwise
- Configuration for commentary
- Patterns for matchit
But you don't have to install any of those to use this addon.
Teach a Vim to fish…
Vim needs a more POSIX compatible shell than fish for certain functionality to
work, such as
:%!, compressed help pages and many third-party addons. If you
use fish as your login shell or launch Vim from fish, you need to set
to something else in your
~/.vimrc, for example:
if &shell =~# 'fish$' set shell=sh endif
Best do it somewhere at the top, before any addon code is loaded and executed.
Note that this also affects what
:sh[ell] launches, so if you care about that
you might want to set it to your second best shell instead. If you use Vim in
the terminal you could also train yourself to use
:st[op] or CTRL-Z instead
fg in fish to get back to Vim.