/linter-shellcheck

Linter plugin for Bash, using shellcheck.

Primary LanguageCoffeeScript

linter-shellcheck

This linter plugin for Linter provides an interface to shellcheck. It will be used with files that have the "Shell" syntax.

Installation

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

shellcheck installation

Before using this plugin, you must ensure that shellcheck is installed on your system. To install shellcheck, follow the guide on shellcheck github

Now you can proceed to install the linter-shellcheck plugin.

Plugin installation

$ apm install linter-shellcheck

Settings

You can configure linter-json by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):

'linter-shellcheck':
  'shellcheckExecutablePath': null #shellcheck path. run 'which shellcheck' to find the path

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. welcome to the club

Please note that modications should follow these coding guidelines:

  • Indent is 2 spaces.
  • Code should pass coffeelint linter.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!

Donation

Share the love!