rubycritic-simplecov 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4adf242d4461e0d849cdf31a6d257e7171753cff1f9bc71cf2907ba6207ad5e9
+  data.tar.gz: 213321116c7a70f355bf59fdef92bca97bcfdb59adb36b9ed7046955edd568d3
+SHA512:
+  metadata.gz: 2e1ee647b7f6df5bcbc9441477e38a9b0bd7b319e289e1ff53e9aea1a235adfeff193ad1ec00f587c4d7185e29493eeb6fda07c3f6aabe69a3a1b57ee249aa63
+  data.tar.gz: a2c02926b34d2dcd5aa6d9906dc8503cb66687b9b00a846a5afc6e8fe35940a17f4f9fe9b9852e984d2d6efb50a8ed46c2d6b0597163d9374530ddac109d8169

data/CHANGELOG.md

@@ -0,0 +1,290 @@
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.1.0...master)
+
+* [FEATURE] Add Markdown linting to the Travis build by using the Rubygem `markdownlint` (by [@jbampton][])
+
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.0.2...v4.1.0)
+
+* [BUGFIX] Assorted fixes in HTML report (by [@jbampton][])
+* [BUGFIX] Fix duplicate HTML5 DOCTYPE (by [@jbampton][])
+* [BUGFIX] Config options getting overwritten by nil argv options (by [@nathanbwright][])
+* [CHANGE] Update Reek dependency to '~> 5.0', '< 6.0' (by [@leksster][])
+
+# 4.0.2 / 2019-03-14 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.0.1...v4.0.2)
+
+* [BUGFIX] Fix generating the default html report (by [@lightalloy][])
+
+# 4.0.1 / 2019-03-12 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.0.0...v4.0.1)
+
+* [FEATURE] Allow passing formatters from the outside (by [@marcgrimme][] and [@onumis][])
+* [CHANGE] Fix aruba deprecation warning
+
+# 4.0.0 / 2019-02-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v4.0.0)
+
+* [FEATURE] Allow generating reports in multiple formats in one run (by [@katafrakt])
+* [FEATURE] Allow to accept a config file (by [@mfbmina])
+* [CHANGE] Update `reek` to 5.3 (by [@taitran19][] and [@onumis][])
+* [CHANGE] Update `parser` to 2.6.0 (by [@onumis][])
+* [CHANGE] Update `tty-which` to 0.4.0 (by [@onumis][])
+* [CHANGE] Drop support for ruby 2.1 and 2.2 (by [@onumis][])
+* [CHANGE] Fix rubocop offenses (by [@AllanSiqueira][] and [@harman28][])
+
+# 3.5.2 / 2018-09-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v3.5.2)
+
+* [BUGFIX] Use a better uncommitted changes detection for git (by [@onumis][])
+
+# 3.5.1 / 2018-09-05 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.0...v3.5.1)
+
+* [BUGFIX] Fix branches score comparison when threshold is 0 (by [@antoineLeclercq][])
+
+# 3.5.0 / 2018-09-03 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.4.0...v3.5.0)
+
+* [CHANGE] Add ability to compare only the modified files between two branches. Refactored option `--mode-ci`, added `--branch` and `--maximum-decrease` (by [@HemanthMudalaiah][])
+* [CHANGE] Optimized all images (by [@SuperSandro2000][])
+* [BUGFIX] Fixed opening report in chrome on windows (by [@SuperSandro2000][])
+* [BUGFIX] Fixed churn on windows (by [@SuperSandro2000][])
+* [BUGFIX] Fixed gem not installing under restricted windows environments (by [@onumis][])
+
+# 3.4.0 / 2018-03-22 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.3.0...v3.4.0)
+
+* [CHANGE] Update `rubocop` to 0.51.0 (by [@olleolleolle][])
+* [CHANGE] Update `parser` to 2.5.0 (by [@joshrpowell][])
+* [CHANGE] Update `rainbow` to 3.0 (by [@joshrpowell][])
+* [CHANGE] Update `rubocop` to 0.53.0 (by [@joshrpowell][])
+* [BUGFIX] Fix wrong label for churn in the code file template (by [@nbekirov][])
+
+# 3.3.0 / 2017-10-10 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.3...v3.3.0)
+
+* [FEATURE] Add lint format similar to Golint (by [@nightscape][])
+* [CHANGE] Update `cucumber` to 3.0 (by [@onumis][])
+* [CHANGE] Update `rake` to 12.0 (by [@onumis][])
+* [CHANGE] Update `rubocop` to 0.50.0 (by [@onumis][])
+* [CHANGE] Accepting floating point values from Flog (by [@onumis][])
+
+# 3.2.3 / 2017-05-31 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.2...v3.2.3)
+
+* [BUGFIX] Fix rendering of churn chart in large codebases. (by [@ochagata][])
+
+# 3.2.2 / 2017-05-18 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.1...v3.2.2)
+
+* [CHANGE] Relax dependency of parser gem (by [@yuku-t][])
+* [BUGFIX] Only scroll Y axis when visiting page with anchor tag (by [@georgedrummond][])
+
+# 3.2.1 / 2017-05-13 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.0...v3.2.1)
+
+* [CHANGE] Update `rubocop` to 0.48.x from 0.47.1 (by [@koic][] and [@Onumis][])
+* [BUGFIX] Nest ordered list so we don't render errors as line numbers (by [@georgedrummond][])
+
+# 3.2.0 / 2017-03-24
+
+* [CHANGE] Update `rubocop` to 0.47.1 from 0.42.0 (by [@jdickey][])
+* [CHANGE] Update for Ruby 2.4.0 compatibility; update `parser` gem to 2.4.0 (by [@jdickey][])
+* [CHANGE] Improve YARD documentation (by [@olleolleolle][] and [@tejasbubane][])
+
+# 3.1.3 / 2016-12-19
+
+* [BUGFIX] Fix crash with the usage of an unavailable color in "rainbow" gem  (by [@thedrow][])
+
+# 3.1.2 / 2016-12-17
+
+* [BUGFIX] Fix errors when no source-control is found (by [@tejasbubane][])
+* [BUGFIX] Fix lack of the GPA chart when used with rake/rails (by [@hoshinotsuyoshi][])
+* [BUGFIX] Fix code navigation links in the new UI (by [@rohitcy][])
+
+# 3.1.1 / 2016-12-02
+
+* [FEATURE] Implement search and filter on code and smells view (by [@rohitcy][])
+* [CHANGE] Use Ruby's File instead of `wc` system command (by [@tejasbubane][])
+* [CHANGE] Add MRI 2.3.3 compatibility by updating `parser` to v2.3.3.1 (by [@josephpage][])
+* [BUGFIX] Fix code navigation links in the new UI (by [@rohitcy][])
+* [BUGFIX] Add missing method 'head_reference' for Perforce source control (by [@Rataah][])
+
+# 3.1.0 / 2016-11-23
+
+* [FEATURE] Support for Perforce source control system (by [@Rataah][])
+* [CHANGE] New Web UI (by [@tejasbubane][])
+* [CHANGE] Significant improvements to documentation (by [@olleolleolle][])
+* [CHANGE] Typo / consistency updates to features and tests (by [@olleolleolle][])
+* [CHANGE] Fix test warnings and upgrade 'parser' to '2.3.1.4' (by [@tejasbubane][])
+* [BUGFIX] Increase the turboThreshold of Highcharts so that it renders nicely even with lots of data (by [@victormartins][])
+
+# 3.0.0 / 2016-11-01
+
+* [CHANGE] Set required ruby version to 2.1 (by [@Onumis][])
+* [BUGFIX] Respect the .reek configuration file (by [@mereghost][])
+
+# 2.9.4 / 2016-09-16
+
+* [CHANGE] Update Reek, flog, flay (by [@bglusman][])
+
+# 2.9.3 / 2016-08-17
+
+* [FEATURE] Save json report to file  (by [@NickTroy][])
+* [CHANGE] Rename Rubycritic to RubyCritic (by [@troessner][])
+
+# 2.9.2 / 2016-07-01
+
+* [CHANGE] Upgrade rubocop to 0.41.1 (by [@nijikon][])
+* [CHANGE] Upgrade flog to 4.4.0 (by [@nijikon][])
+* [CHANGE] Upgrade flay to 2.8.0 (by [@nijikon][])
+* [CHANGE] Upgrade Reek to 4.1.0 and Parser to 2.3.1.2 (by [@y-yagi][])
+
+# 2.9.1 / 2016-05-16
+
+* [CHANGE] Upgrade 'parser' to 2.3.1.0 (by [@y-yagi][])
+* [CHANGE] Upgrade 'reek' to 4.0.2 (by [@onumis][])
+* [CHANGE] Upgrade 'rubocop' to 0.40.0 (by [@onumis][])
+
+# 2.9.0 / 2016-04-12
+
+* [FEATURE] Add links to Flay and Flog code smells documentation (by [@ragesoss][])
+* [FEATURE] Documentation updates (by [@troessner][])
+* [CHANGE] Bump Rubocop to 0.39.0 (by [@nijikon][])
+* [CHANGE] Bump Reek to 4.0.1 (by [@nijikon][])
+* [CHANGE] Drop support for Ruby 2.0 (by [@nijikon][])
+
+# 2.8.0 / 2016-02-29
+
+* [FEATURE] Add link to Reek's code smells documentation (by [@danielmbarlow][])
+* [FEATURE] Make RubyCritic usable as Rake Task (by [@troessner][])
+* [CHANGE] Bump Rubocop to 0.37.2 (by [@nijikon][])
+* [CHANGE] Bump Flay to 2.7.0 (by [@nijikon][])
+* [CHANGE] Bump Reek to 3.11 (by [@nijikon][])
+* [CHANGE] Add explicit runtime dependency on ruby_parser ('~> 3.8') (by [@Onumis][])
+
+# 2.7.1 / 2016-02-09
+
+* [CHANGE] Bump Reek to 3.10.1 (by [@nijikon][])
+* [BUGFIX] Analyse only the files whose paths are specified in the CLI (by [@Onumis][])
+
+# 2.7.0 / 2016-01-23
+
+* [FEATURE] Open html report with browser (by [@superiorlu][])
+* [CHANGE] Bump Reek to 3.9.1
+* [CHANGE] Bump Rubocop to 0.36 and internal cleanup (preparing for Ruby 2.3)
+
+# 2.6.0 / 2016-01-21
+
+* [FEATURE] Add a minimum score option to the command line interface (by [@RobertoSchneiders][])
+* [CHANGE] Display the class and module names when the file has no methods
+
+# 2.5.0 / 2016-01-16
+
+* [FEATURE] Add a ConsoleReport format (by [@jbodah][])
+
+# 2.4.1 / 2015-12-27
+
+* [CHANGE] Bump Reek to 3.8.1
+
+# 2.4.0 / 2015-12-26
+
+* [FEATURE] Add progress bar functionality (by [@natesholland][])
+
+# 2.3.0 / 2015-11-30
+
+* [FEATURE] Added global score calculation (by [@ancorgs][])
+* [CHANGE] Bump Reek dependency to 3.7.1.
+
+# 2.2.0 / 2015-11-20
+
+* [CHANGE] Use `Reeks` default configuration loading.
+
+# 2.1.0 / 2015-11-11
+
+* [CHANGE] Bump flay dependency to 2.6.1.
+* [CHANGE] Bump reek dependency to 3.6.0.
+* [CHANGE] Bump flog dependency to 4.3.2.
+
+# 2.0.0 / 2015-11-11
+
+* [CHANGE] Drop support for ruby 1.9
+
+# 1.4.0 / 2015-03-14
+
+* [FEATURE] New report in JSON format. Available by using the new CLI option `-f`
+* [FEATURE] New CLI option `--suppress-ratings` to suppress ratings (by [@halostatue][])
+* [CHANGE] Improve UI, particularly the sortable tables (by [@crackofdusk][])
+
+# 1.3.0 / 2015-02-16
+
+* [FEATURE] New CLI option `--deduplicate-symlinks` to deduplicate symlinks (by [@LeeXGreen][])
+* [CHANGE] Update to Reek 1.6.5 (from 1.6.3)
+* [CHANGE] Remove ruby2ruby dependency
+
+# 1.2.1 / 2015-01-17
+
+* [FEATURE] Support Ruby 2.2
+* [CHANGE] Update to Reek 1.6.3 (from 1.6.0)
+* [CHANGE] Update to at least Parser 2.2.0 (from 2.2.0.pre.5)
+
+# 1.2.0 / 2014-12-27
+
+* [FEATURE] Add CI mode that only analyses the last commit
+* [FEATURE] Add partial support for Mercurial
+* [FEATURE] Allow using RubyCritic programatically
+* [CHANGE] Update to Reek 1.6.0 (from 1.3.8)
+* [BUGFIX] Fix issue #18 - Prevent encoding issues when using Git
+
+# 1.1.1 / 2014-07-29
+
+* [BUGFIX] Analyse only the files whose paths are specified in the CLI
+
+# 1.1.0 / 2014-07-27
+
+* [FEATURE] Display name of the first module found in a file instead of the file's name
+
+# 1.0.2 / 2014-07-23
+
+* [BUGFIX] Fix issue #8 - Solve a dependency error by requiring at least ruby2ruby 2.1.1
+
+# 1.0.1 / 2014-07-22
+
+* [BUGFIX] Fix issue #6 - Rescue `Parser::SyntaxError` when a file is unparsable
+
+# 1.0.0 / 2014-07-13
+
+* Official Release
+
+[@LeeXGreen]: https://github.com/LeeXGreen
+[@crackofdusk]: https://github.com/crackofdusk
+[@halostatue]: https://github.com/halostatue
+[@ancorgs]: https://github.com/ancorgs
+[@natesholland]: https://github.com/natesholland
+[@jbodah]: https://github.com/jbodah
+[@RobertoSchneiders]: https://github.com/RobertoSchneiders
+[@superiorlu]: https://github.com/superiorlu
+[@Onumis]: https://github.com/Onumis
+[@nijikon]: https://github.com/nijikon
+[@troessner]: https://github.com/troessner
+[@danielmbarlow]: https://github.com/danielmbarlow
+[@ragesoss]: https://github.com/ragesoss
+[@y-yagi]: https://github.com/y-yagi
+[@NickTroy]: https://github.com/NickTroy
+[@bglusman]: https://github.com/bglusman
+[@mereghost]: https://github.com/mereghost
+[@victormartins]: https://github.com/victormartins
+[@tejasbubane]: https://github.com/tejasbubane
+[@olleolleolle]: https://github.com/olleolleolle
+[@Rataah]: https://github.com/Rataah
+[@rohitcy]: https://github.com/rohitcy
+[@josephpage]: https://github.com/josephpage
+[@hoshinotsuyoshi]: https://github.com/hoshinotsuyoshi
+[@thedrow]: https://github.com/thedrow
+[@jdickey]: https://github.com/jdickey
+[@koic]: https://github.com/koic
+[@georgedrummond]: https://github.com/georgedrummond
+[@yuku-t]: https://github.com/yuku-t
+[@ochagata]: https://github.com/ochagata
+[@nightscape]: https://github.com/nightscape
+[@nbekirov]: https://github.com/nbekirov
+[@joshrpowell]: https://github.com/joshrpowell
+[@HemanthMudalaiah]: https://github.com/HemanthMudalaiah
+[@SuperSandro2000]: https://github.com/SuperSandro2000
+[@antoineLeclercq]: https://github.com/antoineLeclercq
+[@mfbmina]: https://github.com/mfbmina
+[@taitran19]: https://github.com/taitran19
+[@AllanSiqueira]: https://github.com/AllanSiqueira
+[@harman28]: https://github.com/harman28
+[@lightalloy]: https://github.com/lightalloy
+[@jbampton]: https://github.com/jbampton
+[@nathanbwright]: https://github.com/nathanbwright
+[@leksster]: https://github.com/leksster

data/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+Contributing
+============
+
+RubyCritic is open source and contributions from the community are encouraged! No contribution is too small. Please consider:
+
+* [Writing some Code](#writing-some-code)
+* [Improving the Documentation](#improving-the-documentation)
+* [Reporting a Bug](#reporting-a-bug)
+
+Writing some Code
+-----------------
+
+If you want to squash a bug or add a new feature, please:
+
+1. Fork the project.
+
+2. Create a feature branch (`git checkout -b my-new-feature`).
+
+3. Make your changes. Include tests for your changes, otherwise I may accidentally break them in the future.
+
+4. Run the tests with the `rake` command. Make sure that they are still passing.
+
+5. Add a Changelog entry. Refer [Changelog entry format](#changelog-entry-format).
+
+6. [Stage partial-file changesets] \(`git add -p`).
+
+7. Commit your changes (`git commit`).
+Make exactly as many commits as you need.
+Each commit should do one thing and one thing only. For example, all whitespace fixes should be relegated to a single commit.
+
+8. Write [descriptive commit messages].
+
+9. Push the branch to GitHub (`git push origin my-new-feature`).
+
+10. [Create a Pull Request] and send it to be merged with the master branch.
+
+11. After your code is reviewed, [hide the sausage making]. We follow the "one commit per pull request" [principle](http://ndlib.github.io/practices/one-commit-per-pull-request/) since this allows for a clean git history, easy handling of features and convenient rollbacks when things go wrong. Or in one sentence: You can have as many commits as you want in your pull request, but after the final review and before the merge you need to squash all of those in one single commit.
+For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history] as well.
+
+Improving the Documentation
+---------------------------
+
+You are welcome to clarify how something works or simply fix a typo. Please include `[ci skip]` on a new line in each of your commit messages. This will signal [Travis] that running the test suite is not necessary for these changes.
+
+Reporting a Bug
+---------------
+
+If you are experiencing unexpected behavior and, after having read the documentation, you are convinced this behavior is a bug, please:
+
+1. Search the [issues tracker] to see if it was already reported / fixed.
+
+2. [Create a new issue].
+
+3. Include the Ruby and RubyCritic versions in your report. Here's a little table to help you out:
+
+  ```
+  |            | Version |
+  |------------|---------|
+  | Ruby       | 2.1.2   |
+  | RubyCritic | 1.0.0   |
+  ```
+
+  The more information you provide, the easier it will be to track down the issue and fix it.
+  If you have never written a bug report before, or if you want to brush up on your bug reporting skills, read Simon Tatham's essay [How to Report Bugs Effectively].
+
+[Stage partial-file changesets]: http://nuclearsquid.com/writings/git-add/
+[descriptive commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Create a pull request]: https://help.github.com/articles/creating-a-pull-request
+[hide the sausage making]: http://sethrobertson.github.io/GitBestPractices/#sausage
+[how to rewrite history]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
+[Travis]: https://travis-ci.org
+[issues tracker]: https://github.com/whitesmith/rubycritic/issues
+[Create a new issue]: https://github.com/whitesmith/rubycritic/issues/new
+[How to Report Bugs Effectively]: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
+
+Changelog entry format
+------------------------
+
+Here are a few examples:
+
+```
+* [BUGFIX] Fix errors when no source-control is found (by [@tejasbubane][])
+* [BUGFIX] Fix lack of the GPA chart when used with rake/rails (by [@hoshinotsuyoshi][])
+* [BUGFIX] Fix code navigation links in the new UI (by [@rohitcy][])
+```
+
+* Mark it up in [Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
+* Add your entry in the `master (unreleased)` section.
+* The entry line should start with `* ` (an asterisk and a space).
+* Start with the change type BUGFIX / CHANGE / FEATURE.
+* Describe the brief of the change.
+* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
+* If this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubycritic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guilherme Simoes
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,259 @@
+# RubyCritic
+
+[![Gem Version](https://badge.fury.io/rb/rubycritic.svg)](http://badge.fury.io/rb/rubycritic)
+[![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
+[![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
+
+<img src="https://github.com/whitesmith/rubycritic/raw/master/images/logo.png" alt="RubyCritic Icon" align="right">
+
+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
+
+- [Overview](#overview)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+  + [Analyzer Configuration](#analyzer-configuration)
+  + [Alternative Usage Methods](#alternative-usage-methods)
+  + [Rake Task](#rake-task)
+- [Compatibility](#compatibility)
+- [Improving RubyCritic](#improving-rubyCritic)
+- [Contributors](#contributors)
+- [Credits](#credits)
+
+## Overview
+
+This gem provides features such as:
+
+1. An overview of your project:
+
+  ![RubyCritic overview screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/overview.png)
+
+2. An index of the project files with their respective number of smells:
+
+  ![RubyCritic code index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/code.png)
+
+3. An index of the smells detected:
+
+  ![RubyCritic smells index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smells.png)
+
+4. When analysing code like the following:
+
+  ```ruby
+  class Dirty
+    def awful(x, y)
+      if y
+        @screen = widgets.map {|w| w.each {|key| key += 3}}
+      end
+    end
+  end
+  ```
+
+  It basically turns something like this:
+
+  ![Reek output screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/reek.png)
+
+  Into something like this:
+
+  ![RubyCritic file code screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smell-details.png)
+
+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](https://github.com/whitesmith/rubycritic/blob/master/docs/core-metrics.md).
+
+## Getting Started
+
+RubyCritic can be installed with the following command:
+
+```bash
+$ gem install rubycritic
+```
+
+If you'd rather install RubyCritic using Bundler, add this line to your
+application's Gemfile:
+
+```ruby
+gem "rubycritic", require: false
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Running `rubycritic` with no arguments will analyse all the Ruby files in the
+current directory:
+
+```bash
+$ rubycritic
+```
+
+Alternatively you can pass `rubycritic` a list of files and directories to check:
+
+```bash
+$ rubycritic app lib/foo.rb
+```
+
+For a full list of the command-line options run:
+
+```bash
+$ rubycritic --help
+```
+
+| Command flag                        | Description                                                     |
+|-------------------------------------|-----------------------------------------------------------------|
+| `-v` / `--version`                  | Displays the current version and exits                          |
+| `-p` / `--path`                     | Set path where report will be saved (tmp/rubycritic by default) |
+| `-f` / `--format`                   | Report smells in the given format(s)<sup>1</sup>                |
+| `--custom-format path:classname`    | Load and instantiate custom formatter(s)<sup>2</sup>            |
+| `-s` / `--minimum-score`            | Set a minimum score (FLOAT: ex: 96.28), default: 0              |
+| `-m` / `--mode-ci`                  | Use CI mode<sup>3</sup>                                         |
+| `-b` / `--branch`                   | Set branch to compare                                           |
+| `-t` / `--maximum-decrease`         | Threshold for score difference between two branches<sup>4</sup> |
+| `--deduplicate-symlinks`            | De-duplicate symlinks based on their final target               |
+| `--suppress-ratings`                | Suppress letter ratings                                         |
+| `--no-browser`                      | Do not open html report with browser                            |
+
+1. Available output formats:
+- `html` (default; will open in a browser)
+- `json`
+- `console`
+- `lint`
+2. See [custom formatters docs](/docs/formatters.md)
+3. Faster, analyses diffs w.r.t base_branch (default: master), see `-b`
+4. Works only with `-b`, default: 0
+
+You also can use a config file. Just create a `.rubycritic.yml` on your project root path.
+
+Here are one example:
+
+```yml
+mode_ci:
+  enabled: true # default is false
+  branch: 'production' # default is master
+branch: 'production' # default is master
+path: '/tmp/mycustompath' # Set path where report will be saved (tmp/rubycritic by default)
+threshold_score: 10 # default is 0
+deduplicate_symlinks: true # default is false
+suppress_ratings: true # default is false
+no_browser: true # default is false
+formats: # Available values are: html, json, console, lint. Default value is html.
+  - console
+minimum_score: 95 # default is 0
+paths: # Files to analyse.
+  - 'app/controllers/'
+  - 'app/models/'
+```
+
+### Analyzer Configuration
+
+* [`Reek`](https://github.com/troessner/reek): `RubyCritic` utilizes `Reek`'s default [configuration loading mechanism](https://github.com/troessner/reek#configuration-file).
+  This means that if you have an existing `Reek` configuration file, you can just put this into your
+  project root and `RubyCritic` will respect this configuration.
+* [`flay`](https://github.com/seattlerb/flay): We use `flay`'s default configuration.
+* [`flog`](https://github.com/seattlerb/flog): We use `flog`'s default configuration with a couple of [smaller tweaks](https://github.com/whitesmith/rubycritic/blob/master/lib/rubycritic/analysers/helpers/flog.rb#L5):
+  * `all`: Forces `flog` to report scores on all classes and methods. Without this option `flog` will only give results up to a certain threshold.
+  * `continue`: Makes it so that `flog` does not abort when a ruby file cannot be parsed.
+  * `methods`: Configures `flog` to skip code outside of methods. It prevents `flog` from reporting on the "methods" `private` and `protected`. It also prevents `flog` from reporting on Rails methods like `before_action` and `has_many`.
+
+### Alternative Usage Methods
+
+If you're fond of Guard you might like [guard-rubycritic][4]. It automatically analyses your Ruby files as they are modified.
+
+For continuous integration, you can give [Jenkins CI][5] a spin. With it, you can [easily build your own (poor-man's) Code Climate][6]!
+
+### Rake Task
+
+You can use RubyCritic as Rake command in its most simple form like this:
+
+```ruby
+require "rubycritic/rake_task"
+
+RubyCritic::RakeTask.new
+```
+
+A more sophisticated Rake task that would make use of all available configuration options could look like this:
+
+```ruby
+RubyCritic::RakeTask.new do |task|
+  # Name of RubyCritic task. Defaults to :rubycritic.
+  task.name    = 'something_special'
+
+  # Glob pattern to match source files. Defaults to FileList['.'].
+  task.paths   = FileList['vendor/**/*.rb']
+
+  # You can pass all the options here in that are shown by "rubycritic -h" except for
+  # "-p / --path" since that is set separately. Defaults to ''.
+  task.options = '--mode-ci --format json'
+
+  # Defaults to false
+  task.verbose = true
+end
+```
+
+RubyCritic will try to open the generated report with a browser by default. If you don't want this
+you can prevent this behaviour by setting the options correspondingly:
+
+```ruby
+RubyCritic::RakeTask.new do |task|
+  task.options = '--no-browser'
+end
+```
+
+## Formatters
+
+See [formatters](docs/formatters.md)
+
+## Compatibility
+
+RubyCritic is supporting Ruby versions:
+
+* 2.3
+* 2.4
+* 2.5
+* 2.6
+
+## Improving RubyCritic
+
+RubyCritic doesn't have to remain a second choice to other code quality analysis services. Together, we can improve it and continue to build on the great code metric tools that are available in the Ruby ecosystem.
+
+Arguably, the [better_errors gem][7] only got popular after receiving a [(pretty awesome) Pull Request][8] that changed its page design.
+
+Similarly, Pull Requests that improve the look and feel of the gem, that tweak the calculation of ratings or that fix existing issues will be most welcome. Just commenting on an issue and giving some insight into how something should work will be appreciated. No contribution is too small.
+
+See RubyCritic's [contributing guidelines](https://github.com/whitesmith/rubycritic/blob/master/CONTRIBUTING.md) about how to proceed.
+
+## Contributors
+
+`RubyCritics` initial author was [Guilherme Simões](https://github.com/guilhermesimoes).
+
+The current core team consists of:
+
+* [Nuno Silva](https://github.com/Onumis)
+* [Lucas Mazza](https://github.com/lucasmazza)
+* [Timo Rößner](https://github.com/troessner)
+
+## Credits
+
+![Whitesmith](https://github.com/whitesmith/rubycritic/raw/master/images/whitesmith.png)
+
+RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@Whitesmithco][10].
+
+[1]: https://github.com/troessner/reek
+[2]: https://github.com/seattlerb/flay
+[3]: https://github.com/seattlerb/flog
+[4]: https://github.com/whitesmith/guard-rubycritic
+[5]: http://jenkins-ci.org/
+[6]: https://github.com/whitesmith/rubycritic/blob/master/docs/building-own-code-climate.md
+[7]: https://github.com/charliesome/better_errors
+[8]: https://github.com/charliesome/better_errors/pull/22
+[9]: http://www.whitesmith.co/
+[10]: https://twitter.com/Whitesmithco