Sider Runners

This is a Sider analyzer framework.

See also another related project, called devon_rex.

Supported analyzers

All 40 analyzers are provided as a Docker image:

Name	Links	Status
Brakeman	docker, source, doc, website	✅
Checkstyle	docker, source, doc, website	✅
Clang-Tidy	docker, source, doc, website	✅ beta
CoffeeLint	docker, source, doc, website	✅
Cppcheck	docker, source, doc, website	✅
cpplint	docker, source, doc	✅
detekt	docker, source, doc, website	✅ beta
ESLint	docker, source, doc, website	✅
Flake8	docker, source, doc, website	✅
FxCop	docker, source, doc, website	✅ beta
GolangCI-Lint	docker, source, doc, website	✅
Goodcheck	docker, source, doc, website	✅
hadolint	docker, source, doc	✅
HAML-Lint	docker, source, doc	✅
JavaSee	docker, source, doc	✅
JSHint	docker, source, doc, website	✅
ktlint	docker, source, doc, website	✅ beta
LanguageTool	docker, source, doc, website	✅ beta
Metrics Code Clone	docker, source, doc	✅ beta
Metrics Complexity	docker, source, doc	✅ beta
Metrics File Info	docker, source, doc	✅ beta
Misspell	docker, source, doc	✅
Phinder	docker, source, doc	✅
PHP_CodeSniffer	docker, source, doc	✅
PHPMD	docker, source, doc, website	✅
PMD CPD	docker, source, doc, website	✅ beta
PMD Java	docker, source, doc, website	✅
Pylint	docker, source, doc, website	✅ beta
Querly	docker, source, doc	✅
Rails Best Practices	docker, source, doc, website	✅
Reek	docker, source, doc	✅
remark-lint	docker, source, doc	✅
RuboCop	docker, source, doc, website	✅
SCSS-Lint	docker, source, doc	⚠️ deprecated
ShellCheck	docker, source, doc, website	✅
Slim-Lint	docker, source, doc	✅ beta
stylelint	docker, source, doc, website	✅
SwiftLint	docker, source, doc, website	✅
TSLint	docker, source, doc, website	⚠️ deprecated
TyScan	docker, source, doc	✅

Developer guide

Please follow these instructions.

Prerequisites

• Ruby (see .ruby-version)
• Bundler (see Gemfile.lock)
• Docker (the latest version recommended)
• EditorConfig (see .editorconfig, and setup your editor)

Setup

First, after checking out the source code, run the following command to install Ruby:

$ rbenv install

If you don't want to use rbenv, you need to manually install Ruby with the version in the .ruby-version file.

Next, let's set up via Bundler:

$ bin/setup

All is done. The Rake tasks will help you develop! 😉

Project structure

$ tree -F -L 1 -d
.
├── bin
├── docs
├── exe
├── images
├── lib
├── sig
├── tasks
└── test

6 directories

• bin: Scripts
• docs: Documents
• exe: Entry point
• images: Docker images
• lib: Core programs
• sig: Ruby signature files for type-checking
• tasks: Rake tasks
• test: Unit tests and smoke tests

Testing

Unit test

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'

Smoke test

You can run smoke tests via the rake docker:smoke command as follow:

$ bundle exec rake docker:smoke ANALYZER=rubocop [ONLY=test1,test2,...] [DEBUG=(true|trace)]

• ONLY: Specify test name(s). You can specify a comma-separated list.
• DEBUG: Show debug log to your console.
  • DEBUG=true: All log.
  • DEBUG=trace: Only trace log (colored).

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

Debugging

You can use the rake docker:shell command to run a command directly in a Docker container, for example:

$ bundle exec rake docker:build docker:shell ANALYZER=rubocop
docker run ...
analyzer_runner@838f831e5aa7:/work$ cd test/smokes/rubocop/renamed-cop
analyzer_runner@838f831e5aa7:/work$ rubocop .
...

Type checking

We check the types of our Ruby source files via RBS and Steep.

$ bundle exec steep check [files_or_directories...]

To update the third-party gems' RBS, run:

$ bundle exec rake rbs:update_gems

License

See LICENSE.