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

Sublime​Linter-shellcheck

by SublimeLinter ST3 Trending

This linter plugin for SublimeLinter provides an interface to shellcheck.

Details

Installs

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

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-shellcheck

Build Status

This linter plugin for SublimeLinter provides an interface to shellcheck. It will be used with files that have the “Shell-Unix-Generic” syntax (aka Shell Script (Bash)).

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that shellcheck is installed on your system.

To install shellcheck, follow the instructions on the shellcheck GitHub repository.

shellcheck can be installed with apt-get on Debian sid, brew on Mac OS X, or compiled from its Haskell sources (manually, or through cabal). There is no Windows installer.

If you install it manually, make sure to use a version more recent than commit 376d407ea10b55 (2013-11-13 17:28:08, between version 0.2.0 and 0.3.0), where an easily parseable output was added.

Once shellcheck is installed, you must ensure it is in your system PATH so that SublimeLinter can find it. This may not be as straightforward as you think, so please read about how linter executables are located in the documentation.

Linter configuration

In order for shellcheck to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured shellcheck, you can proceed to install the SublimeLinter-shellcheck plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type shellcheck. Among the entries you should see SublimeLinter-shellcheck. If that entry is not highlighted, use the keyboard or mouse to select it.

  3. In the console, you should see a message stating SublimeLinter: shellcheck activated: /usr/local/bin/shellcheck

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-shellcheck provides its own settings. Those marked as “Inline Override” may also be used inline.

Setting Description Inline Override
exclude A comma-delimited list of codes to exclude.

Examples

You can use a single string (ex: "SC2034,SC2086"), or an array of strings if not inline (ex: ["SC2034", "SC2086"]).

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!