Table Of Contents

1. Overview
2. Requirements
3. Installation
4. Plugins
   • Complexity
   • Churn
   • Dependencies
   • Duplicate
   • Security
   • File Statistics
   • Commit Info
   • Lint Tools
5. Frameworks
   • Rails
6. Caveats

Overview

This package aims to provide a complete set of plugins and documentation for analyzing your Ruby projects with Vile.

Requirements

• Node.js
• Ruby
• Bundler

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

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