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

Sublime​Linter-contrib-bashate

by maristgeek ST3

SublimeLinter 3 plugin for Shell Script (Bash), using bashate.

Details

Installs

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

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-bashate

Build Status

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)).

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 bashate is installed on your system. To install bashate, do the following:

  1. For best performance, install Python 3 and pip.

  2. Install bashate by typing the following in a terminal, replacing '3.x' with the available version of pip:

[sudo] pip-3.x install bashate

Linter configuration

In order for bashate 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 bashate, you can proceed to install the SublimeLinter-contrib-bashate 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 bashate. Among the entries you should see SublimeLinter-contrib-bashate. If that entry is not highlighted, use the keyboard or mouse to select it.

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-contrib-bashate provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Override
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)

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 modifications should follow these coding guidelines:

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

Thank you for helping out!