Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 1.92 KB

README.md

File metadata and controls

82 lines (50 loc) · 1.92 KB
Raw

vile-reek

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

NOTICE

This project is not actively maintained. If you want to help maintain the project, or if you have a better alternative to switch to, please open an issue and ask!

Requirements

Installation

Currently, you need to have reek installed manually.

Example:

npm i -D vile vile-reek
gem install reek

Note: A good strategy is to use Bundler.

Config

reek:
  config: .reek.yml

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.

Architecture

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

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

Developing

cd vile-reek
npm install
gem install reek
npm run dev
npm test