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

Shell​Script​Improved

by jfcherng ST3

A better ShellScript (Bash) syntax highlight for Sublime Text >= 3143

Details

Installs

  • Total 5K
  • Win 2K
  • OS X 2K
  • Linux 2K
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 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7
Windows 1 2 7 2 3 5 1 0 4 3 7 0 6 1 2 3 2 2 2 5 0 1 4 0 1 1 4 3 0 2 1 4 3 2 2 1 0 3 8 3 2 1 1 2 2 4
OS X 0 2 5 4 3 2 1 1 5 2 2 2 2 3 0 1 3 2 5 2 0 6 2 1 4 3 1 2 1 3 1 7 1 3 4 2 3 2 5 1 6 2 3 2 2 3
Linux 1 2 3 4 3 1 3 3 2 6 6 4 3 1 2 1 4 3 5 5 0 1 2 3 3 4 0 2 1 3 3 7 3 5 2 1 3 4 5 4 8 3 3 3 1 3

Readme

Source
raw.​githubusercontent.​com

Sublime-ShellScriptImproved

A better ShellScript (Bash) syntax highlight for Sublime Text >= 3143.

Important Note

The official ShellScript (Bash) syntax has been rewritten now. All following comparisons are with the one BEFORE rewritten.

Pros

  • It fixes quite lots of bugs which exist in the official ShellScript (Bash) syntax.
  • It parses things more grammatically while the official one is just like a keyword highlighter.

Cons

  • It is designed for Bash only while the official one is designed for general shell scripts.
  • You may have to add customized scopes to your color scheme if you do not want to use the bundled one.
  • Its source code is as messy as the official one's but this does not matter if you are not a maintainer.

Screenshots

Left / Right = Official ShellScript (Bash) / ShellScript Improved screenshot

Color scheme

There are quite a lot of scopes that may be missing in the color scheme you are using. If you want to add them by yourself, see the Customization from Your Color Scheme section. Or, you can set the syntax specific settings to use the color scheme which is shipped with this package.

To do that,

  1. Open a file with ShellScript Improved syntax.
  2. Go to Preferences » Settings - More » Syntax Specific - User
  3. Add the color_scheme item into the settings file and then save.
{
    // use a bundled .tmTheme file while writing shell scripts
    "color_scheme": "Packages/ShellScriptImproved/color_schemes/dark.tmTheme",
    // or, if you are using Sublime Text >= 3149, using a .sublime-color-scheme file is recommended
    "color_scheme": "Packages/ShellScriptImproved/color_schemes/dark.sublime-color-scheme",
}

That color scheme is the exact one I use in my Sublime Text so there is only a dark one. You would get the same highlighting as shown in the screenshot.

Customization from Your Color Scheme

Note that an extra rule is added to my .tmTheme in above screenshots in order to set text to its default color, i.e., white on dark theme and black on light theme mostly. (I just can not find other way to set text to the default text color…) This resets the color of TEXT in $(echo TEXT) and other things like that.

<dict>

    <key>name</key>
    <string>Embedded</string>
    <key>scope</key>
    <string>meta.embedded</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#FFFFFF</string>
    </dict>
</dict>
<dict>

    <key>name</key>
    <string>Reset Color</string>
    <key>scope</key>
    <string>meta.reset.color</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#FFFFFF</string>
    </dict>
</dict>

Also, those scopes may be missing in your theme. You may add/adjust them to get a better color highlighting.

<dict>
    <key>name</key>
    <string>Shell - variable</string>
    <key>scope</key>
    <string>variable.other.normal.shell, variable.other.positional.shell, variable.other.bracket.shell, variable.other.special.shell, variable.other.loop.shell, variable.other.c-style.shell,variable.other.positional.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#AE81FF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - bracket variable in meta.reset.color</string>
    <key>scope</key>
    <string>meta.reset.color variable.other.bracket.shell, meta.reset.color variable.other.bracket.shell variable.other.bracket.shell, meta.reset.color variable.other.bracket.shell variable.other.bracket.shell variable.other.bracket.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#AE81FF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - true</string>
    <key>scope</key>
    <string>variable.other.true.shell</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#AAFFFF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - false</string>
    <key>scope</key>
    <string>variable.other.false.shell</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#FFAAFF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - built-in command</string>
    <key>scope</key>
    <string>support.function.builtin.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#50AAFF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - privilege command</string>
    <key>scope</key>
    <string>support.function.privilege.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#FF0000</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - external command</string>
    <key>scope</key>
    <string>support.function.external.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#0684F4</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - punctuation variable</string>
    <key>scope</key>
    <string>punctuation.definition.variable.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#AE81FF</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - punctuation definition</string>
    <key>scope</key>
    <string>punctuation.definition.string</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#E6DB74</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - pipe-sign/parentheses in `case`</string>
    <key>scope</key>
    <string>punctuation.separator.pipe-sign.shell, punctuation.definition.case-pattern.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#F92672</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - `;;` in `case`</string>
    <key>scope</key>
    <string>punctuation.terminator.case-clause.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold</string>
        <key>foreground</key>
        <string>#F92672</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Shell - command switch</string>
    <key>scope</key>
    <string>support.command-switch.shell</string>
    <key>settings</key>
    <dict>
        <key>fontStyle</key>
        <string>bold italic</string>
    </dict>
</dict>

See Also

Supporters

Thank you guys for sending me some cups of coffee.