Bleacher

Bleacher is a Ruby 2.7 tool that uses Docker containers to run static code analysis tools (such as linters) against a source code file. Bleacher can also install a Git pre-commit hook so it runs automagically for modified files before they are committed.

• Installation
• Usage
• Supported languages and tools
• Sample configuration files

Installation

• Install Docker. (Also take a look at How can I use Docker without sudo if you're using Linux.)
• Install the bleacher gem from this repository:

gem install bleacher-0.0.x.gem

This will automatically install all prerrequisite gems, but some libraries might be needed for this.

• On MacOS you might need to:

brew install cmake pkg-config icu4c

• On Linux:

sudo apt-get install make build-essential libicu-dev cmake libssl-dev

Usage

Usage:

bleacher [OPTION]

Options (mutually exclusive):

-f, --file [STRING]              Filepath of the file that needs to be checked.
-i, --install                    Install Git pre-commit hook.

Tools

Source file language is autodetected at run time.

• CSS

  • CSS Lint
  • Stylelint

• HTML

  • HTML Linter

• JavaScript

  • ESLint
  • JSHint

• Python

  • Bandit
  • Pylint

• Ruby

  • Brakeman
  • Rubocop

• SCSS

  • Stylelint-SCSS