ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

fish

by Phidica ALL

A robust Sublime Text syntax package for fish

Labels language syntax, snippets

Details

  • 4.0.1
    3.2.0
    2.5.0
  • github.​com
  • github.​com
  • 5 months ago
  • 2 hours ago
  • 13 years ago

Installs

  • Total 15K
  • Win 1K
  • Mac 9K
  • Linux 5K
Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15
Windows 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 0 0 0 0 1 0 0 1 0 3 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0
Mac 1 1 2 3 0 0 1 1 0 0 1 0 0 1 0 0 3 2 1 1 1 1 1 3 0 0 1 1 1 1 0 1 1 1 3 4 1 1 0 0 0 1 0 2 1 4
Linux 0 0 1 0 2 0 1 0 1 0 3 0 2 1 1 1 0 2 0 0 0 1 0 2 2 0 1 2 2 1 0 1 0 2 1 0 2 0 0 1 1 1 1 0 0 0

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: 4.0

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:
  • Indent and prettify: Reformat the active file with fish_indent:
    • Use ctrl+alt+i or your build system shortcut (eg, ctrl+b).
    • Optional setting to run automatically when file is saved.

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 limited tmLanguage scheme instead of sublime-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 st2 and st3) only supports fish 2.7.
  • The 3.x.x series (on st3 and master) includes support for fish 3.0 to 3.7.
  • The 4.x.x series (on st3 and master) includes support for fish 4.0 and beyond.

Contribution

Requirements:

  • PackageDev, only for ST2 development and changing the tmPreferences file.

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.