Find Ruby design issues using Roodi. Requires that you have the Roodi gem installed.
This package provides the following services:
linter-roodi
This is a Linter plugin for the Atom editor that inspects your Ruby code using roodi.
Roodi stands for Ruby Object Oriented Design Inferometer. It parses your Ruby code and warns you about design issues you have based on the checks that it has configured.
Usage
As you save a file, Roodi will run checks just like any other Linter plugin. If there are any issues in your file, a message will pop up.
Installation
-
Linter must be installed in order to use this plugin. If Linter is not installed, please see the instructions.
-
Install roodi:
gem install roodi -
Install the linter-roodi package from the settings in Atom.
Configuration
The plugin finds the nearest roodi.yml file and uses that.
executablePath
'linter-roodi':
'executablePath': null # roodi path.
Run which roodi to find the path, if you're using rbenv run rbenv which roodi
Contributing
Bug reporting
Please use the GitHub issue tracker.
Want to submit some code?
Fantastic! Please follow this procedure:
- Fork the repository
- Create a well-named topic branch
- Add specs for any changes you make
- Write meaningful commit messages explaining why this change is needed
- Create a pull request.
License
(The MIT License)
Copyright (c) 2015 Peter Evjan
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.