danger-shellcheck

A Danger plugin that shows the static analysis output generated by ShellCheck.

To use this plugin, you need to generate a JSON file using ShellCheck for this plugin to read.

$ gem install danger-shellcheck

Somewhere in your build process, call ShellCheck using the JSON output flag.

shellcheck -f json myscript myotherscript > shellcheck.json

An easy way to have shellcheck look at all of your .sh files is:

shellcheck -f json **/*.sh > shellcheck.json

At a minimum, add this line to your Dangerfile:

shellcheck.report 'shellcheck.json'

You may also use optional specifiers to ignore files, or set the project root.

# Set a different project root
shellcheck.project_root = 'MyProject/NewRoot/'

danger-shellcheck is released under the MIT license. See LICENSE for details.

1. Fork this repo
2. Run bundle install to setup dependencies.
3. Run bundle exec rake spec to run the tests.
4. Use bundle exec guard to automatically have tests run as you make changes.
5. Make your changes.
6. Create a Pull Request for us to review