fish
A robust Sublime Text syntax package for fish
Details
Installs
- Total 13K
- Win 1K
- Mac 8K
- Linux 4K
| Feb 6 | Feb 5 | Feb 4 | Feb 3 | Feb 2 | Feb 1 | Jan 31 | Jan 30 | Jan 29 | Jan 28 | Jan 27 | Jan 26 | Jan 25 | Jan 24 | Jan 23 | Jan 22 | Jan 21 | Jan 20 | Jan 19 | Jan 18 | Jan 17 | Jan 16 | Jan 15 | Jan 14 | Jan 13 | Jan 12 | Jan 11 | Jan 10 | Jan 9 | Jan 8 | Jan 7 | Jan 6 | Jan 5 | Jan 4 | Jan 3 | Jan 2 | Jan 1 | Dec 31 | Dec 30 | Dec 29 | Dec 28 | Dec 27 | Dec 26 | Dec 25 | Dec 24 | Dec 23 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 2 | 1 | 0 | 0 | 0 | 1 | 2 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
| Mac | 0 | 0 | 2 | 4 | 1 | 1 | 3 | 0 | 0 | 1 | 5 | 2 | 0 | 0 | 2 | 1 | 1 | 0 | 2 | 2 | 1 | 2 | 4 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 0 | 1 | 4 | 2 | 3 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Linux | 0 | 0 | 1 | 2 | 1 | 1 | 0 | 1 | 1 | 3 | 2 | 1 | 0 | 0 | 4 | 0 | 2 | 2 | 1 | 1 | 1 | 0 | 0 | 1 | 2 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 1 | 2 | 0 | 0 | 2 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 1 |
Readme
- Source
- raw.githubusercontent.com
Friendly Interactive Shell (fish)
A Sublime Text package for the friendly interactive shell. It features a robust syntax highlighting scheme that mimics the native highlighting behaviour of fish.
The package currently supports up to fish version: 3.4
Note: ST3 support will cease in a future release. ST2 support is capped at fish 2.7 with a limited set of the following features.
Features
- Snippets for common constructs.
- Extensive syntax highlighting:
- Compatibility highlighter: Code that is incompatible with the targeted version of fish is outlined.
- Path highlighter: Paths to existing files are underlined, just like in the fish shell.
- Indent and prettify: Reformat the active file with
fish_indent:- Use
ctrl+alt+ior your build system shortcut (eg,ctrl+b). - Optional setting to run automatically when file is saved.
- Use
Installation
Via Package Control
Install Package Control, then go to Command Palette (Ctrl+Shift+P) > Package Control: Install Package > fish.
Manual
Clone the repository to your Packages directory and rename it to fish.
cd /path/to/sublime/packages/directory
git clone https://github.com/Phidica/sublime-fish.git
mv sublime-fish fish
Open a .fish file and verify the selected syntax is “Fish”.
Screenshots
As of release 3.0.0, a fish script (for example, fish-shell/share/functions/ls.fish) will look something like:
Figure 1: Default Monokai colour scheme
Figure 2: Example custom Monokai colour scheme formatting additional scopes
Exposed scopes
| fish construct | Scope name |
|---|---|
| Unquoted string | meta.string.unquoted |
| Command name | meta.function-call.name |
| Parameters | meta.function-call.parameter.option/argument |
| File path (in argument) | meta.function-call.parameter.argument.path |
| File path (in redirection) | meta.function-call.operator.redirection.path |
| Redirection | meta.function-call.operator.redirection.{stdin,stdout,stderr}.{explicit,implicit} and keyword.operator.redirect.{truncate,append} |
| Job expansion | meta.function-call.parameter.argument.job-expansion and punctuation.definition.job |
| Process expansion | meta.function-call.parameter.argument.process-expansion and punctuation.definition.process |
| Variable expansion | meta.variable-expansion and punctuation.definition.variable |
| Command substitution | meta.parens.command-substitution and punctuation.section.parens.begin/end |
| Index expansion | meta.brackets.index-expansion and punctuation.section.brackets.begin/end |
| Brace expansion | meta.braces.brace-expansion and punctuation.section.braces.begin/separator/end |
| Wildcard expansion | meta.wildcard-expansion and keyword.operator.question-mark/single-star/double-star |
| Home directory expansion | keyword.operator.tilde |
Branches and releases
Support for different ST major versions is separated between several branches:
master: Plugins compatible with ST4, and syntax provides highlighting for fish versions 2.7 and up.st3: Plugins compatible with ST3 and above (via backwards compatibility features), and syntax provides highlighting for fish versions 2.7 and up.st2: Plugins only compatible with ST2, syntax uses the more limitedtmLanguagescheme instead ofsublime-syntax, and provides highlighting for fish 2.7 only.
The particular fish major version supported by a tagged release is indicated by the version number:
- The 2.x.x series (on
st2andst3) only supports fish 2.7. - The 3.x.x series (on
st3andmaster) includes support for fish 3.0 and beyond.
Contribution
Requirements:
- PackageDev, only for ST2 development and changing the
tmPreferencesfile.
ST2 development: The source file of the syntax is fish.YAML-tmLanguage. When editing this file, “compile” it with the PackageDev build system to automatically generate the fish.tmLanguage file which is used by Sublime Text 2.
ST3+ development: The source file of the syntax is fish.sublime-syntax.
Guide for contributing is located here.
History
The first Sublime Text fish syntax highlighter was by toru hamaguchi. When that project became unmaintained, @Phidica fully rewrote the schema and replaced the links on Package Control.