README.md

vile-rails-best-practices

A Vile plugin for identifying common style and maintainability issues in your Rails code (via rails_best_practices).

Requirements

• Node.js
• Ruby

Installation

Currently, you need to have rails_best_practices installed manually.

npm i -D vile vile-rails-best-practices
gem install rails_best_practices

A good strategy is to use Bundler.

Config

rails-best-practices:
  config:
    vendor: true
    spec: true
    test: true
    features: true

Ignorning Files

You can use vile.ignore or set rails_best_practices.ignore:

rails-best-practices:
  ignore:
    - spec

You can also set the cli specific exclude option:

rails-best-practices:
  config:
    exclude:
      - foo/bar
      - baz

Allowing Files

You can use vile.allow or set rails_best_practices.allow:

rails-best-practices:
  allow:
    - app/controllers

You can also set the cli specific path option:

rails-best-practices:
  config:
    path:
      - foo/bar
      - baz

Setting Path Arg

You can set the cli specific path arg if you want:

rails-best-practices:
  config:
    path: "."

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

1. Please consider tests and code quality before submitting.
2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

• Brent Lintner - @brentlintner

Architecture

This project is currently written in JavaScript. rails_best_practices provides a JSON CLI output that is currently used until a more ideal option is implemented.

• bin houses any shell based scripts
• src is es6+ syntax compiled with Babel
• lib generated js library

Developing

cd vile-rails-best-practices
npm install
npm run dev
npm test