{"repo":"whitesmith/rubycritic","free":true,"listed":false,"github":"https://github.com/whitesmith/rubycritic","clone":"git clone https://github.com/whitesmith/rubycritic.git","description":"A Ruby code quality reporter","language":"Ruby","stars":3499,"topics":["ruby","static-analysis","quality-reporter","metrics","best-practices"],"license":"MIT","category":"dev-tools","readme_excerpt":"RubyCritic RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [Flay][2] and [Flog][3] to provide a quality report of your Ruby code. Table of Contents - RubyCritic - Table of Contents - Overview - Getting Started - Usage - Analyzer Configuration - Alternative Usage Methods - Rake Task - Formatters - Compatibility - Improving RubyCritic - Contributors - Credits Overview This gem provides features such as: 1. An overview of your project: 2. An index of the project files with their respective number of smells: 3. An index of the smells detected: 4. When analysing code like the following: It basically turns something like this: Into something like this: 5. It uses your source control system (only Git, Mercurial and Perforce are currently supported) to compare your currently uncommitted changes with your last commit. Warning : If your code is not as you expect it to be after running RubyCritic, please check your source control system stash. Checkout the /docs if you want to read more about our core metrics. Getting Started RubyCritic can be installed with the following command: If you'd rather install RubyCritic using Bundler, add this line to your application's Gemfile: And then execute: Usage Running rubycritic with no arguments will analyse all the Ruby files in the current directory: Alternatively you can pass rubycritic a list of files and directories. The analysis will be scoped to the provided files and directories: For a full list of the command-","default_branch":null,"files":null,"tree":[],"storefront":"/r/whitesmith","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/whitesmith/rubycritic/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}