This linter plugin for SublimeLinter provides an interface to bashate. 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, you must ensure that bashate is installed on your system, and it is at least version 0.6.0. To install bashate, do the following:
-
Install
bashateby typing the following in a terminal, replacing '3.x' with the available version of pip:[sudo] pip-3.x install bashate
In order for bashate to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover troubleshooting PATH configuration.
- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
Additional SublimeLinter-contrib-bashate settings:
| Setting | Description |
|---|---|
| ignore | A comma-separated list of rules to ignore |
| warn | A comma-separated list of rules to always warn (rather than error) |
| error | A comma-separated list of rules to always error (rather than warn) |
- As of release 2.0.0, version 0.6.0 of
bashateis required. If you need to use a version prior to that release, use the 1.1.1 release of this linter. bashate0.6.0 does not distinguish warnings from errors, so all hits will report as errors in SublimeLinter. This does in fact make the warn setting useless. Follow the upstream problem at https://bugs.launchpad.net/bash8/+bug/1782960.bashate0.6.0 reports all errors at column 1 and does not provide the offending line, so SublimeLinter will now highlight the first character or word of the offending line. Unless the upstream tool changes this behavior the options are to have that highlight or set the user setting no_column_highlights_line. Still persuing hacks but do not expect any.