Vile-Ruby
A Vile meta plugin for analyzing your Ruby code and ecosystem.
Table Of Contents
Overview
This package aims to provide a complete set of plugins and documentation for analyzing your Ruby projects with Vile.
Requirements
Installation
npm i -D vile vile-ruby
# Add these to your Gemfile
gem install rubocop rubycritic bundler bundler-audit
Note: Some plugins don't support Vile's allow/ignore out of the box
For example, vile-rubycritic requires
you set specific allow paths to avoid traversing node_modules.
The same goes for vile-rubocop.
Usage
Depending on your gem setup, you may need to do this:
bundle exec vile analyze
Plugins
| Analysis Types | Provided By |
|---|---|
| Coverage | vile-coverage |
| Complexity | vile-rubycritic |
| Churn | vile-rubycritic |
| Dependencies | vile-bundler-outdated |
| Duplicate | vile-rubycritic |
| Security | vile-bundler-audit |
| File Statistics | vile-stat |
| Commit Info | vile-git |
| Lint Tools |
Included: User installable: |
Frameworks
There are a number of plugins not included in the meta package that support various ruby based frameworks.
Rails
An everyday Rails project example using Sass:
npm i -D vile vile-ruby vile-brakeman vile-rails-best-practices vile-sass-lint
gem install rubocop rubycritic bundler bundler-audit brakeman rails-best-practices
For an in-depth article checkout our post: Continuous Analysis For Your Rails Project Using Vile and CircleCI.
Caveats
Plugins won't install properly with npm v2 and below
First check the packages got installed flatly:
ls -l node_modules/* | grep vile
If not, you can also just pick and choose the plugins this package specifices.
For example, for a basic Ruby (using Bundler):
npm i -D vile vile-git vile-rubycritic vile-rubocop vile-sass-lint vile-bundler-audit vile-bundler-outdated