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)).
SublimeLinter must be installed in order to use this plugin.
Please use Package Control to install the linter plugin.
Before using this plugin, 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).
On Windows either install natively or use the Linux Subsystem. See Microsoft's guide, then run wsl sudo apt update and wsl sudo apt install shellcheck to install Shellcheck (if you installed Ubuntu).
On native Linux systems, Please make sure that the path to shellcheck is available to SublimeLinter.
The docs cover troubleshooting PATH configuration.
- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html
Additional SublimeLinter-shellcheck settings:
| Setting | Description |
|---|---|
| exclude | A comma-delimited list of codes to exclude. |
E.g. you can use a single string (eg: "SC2034,SC2086"), or an array of strings (eg: ["SC2034", "SC2086"]).
