This is a Sider analyzer framework.
See also another related project, called devon_rex.
Each analyzer can be available as a Docker image.
(in alphabetical order)
- Brakeman
- Checkstyle
- CoffeeLint
- Cppcheck
- cpplint
- ESLint
- Flake8
- go vet
- Golint
- Go Meta Linter
- Goodcheck
- hadolint
- HAML-Lint
- JSHint
- JavaSee
- ktlint
- Misspell
- PHPMD
- PHP_CodeSniffer
- PMD Java
- Phinder
- Querly
- Rails Best Practices
- Reek
- RuboCop
- SCSS-Lint
- ShellCheck
- stylelint
- SwiftLint
- TSLint
- TyScan
Please follow these instructions.
The latest version recommended.
- Ruby
- Bundler
- Docker
When checking out the source code, run the following command:
$ bundle install
Next, run the following command to show available commands in the project:
$ bundle exec rake --tasks
These commands will help you develop! π
$ tree -L 1 -d
.
βββ bin
βββ images
βββ lib
βββ sig
βββ test
5 directories
bin
: Entry point to launch a runnerimages
: Docker imageslib
: Core programssig
: Ruby signature files for type-checkingtest
: Unit tests and smoke tests
You can run unit tests via the rake test
command as follow.
All tests:
$ bundle exec rake test
Only a test file:
$ bundle exec rake test TEST=test/cli_test.rb
Only a test method:
$ bundle exec rake test TEST=test/cli_test.rb TESTOPTS='--name=test_parsing_options'
You can run smoke tests via the rake docker:smoke
command as follow:
$ bundle exec rake docker:smoke ANALYZER=rubocop [ONLY=test1,test2,...] [SHOW_TRACE=true]
ONLY
: Specify test name(s). You can specify a comma-separated list.SHOW_TRACE
: Show trace log to console. Useful to debug.
If you want to run tests right after changing code, you can run one command as follow:
$ bundle exec rake docker:build docker:smoke ANALYZER=rubocop
See LICENSE.