Bear proposal: ReekBear

[sils]

Can somebody investigate this list of tools for ruby: https://github.com/troessner/reek#brothers-and-sisters

[gitmate-bot]

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

[yash-nisar]

Tried the bear on a sample file. Output can be easy to parse via regex :

~ reek xyz.rb 
Inspecting 1 file(s):
S

xyz.rb -- 1 warning:
  [1]:IrresponsibleModule: Car has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]

The available list of commands :

reek -h
Usage: reek [options] [files]

Examples:

reek lib/*.rb
reek -s lib
cat my_class.rb | reek

See https://wiki.github.com/troessner/reek for detailed help.

Configuration:
    -c, --config FILE                Read configuration options from FILE
        --smell SMELL                Only look for a specific smell.
                                     Call it like this: reek --smell PrimaDonnaMethod source.rb
                                     Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md for a list of smells

Generate a todo list:
    -t, --todo                       Generate a todo list

Report format:
    -f, --format FORMAT              Report smells in the given format:
                                       html
                                       text (default)
                                       yaml
                                       json
                                       xml
                                       code_climate

Text format options:
        --[no-]color                 Use colors for the output (default: true)
    -V, --[no-]empty-headings        Show headings for smell-free source files (default: false)
    -U, --[no-]wiki-links            Show link to related wiki page for each smell (default: true)
    -n, --[no-]line-numbers          Show line numbers in the output (default: true)
    -s, --single-line                Show location in editor-compatible single-line-per-smell format
    -P, --[no-]progress              Show progress of each source as it is examined (default: true)
        --sort-by SORTING            Sort reported files by the given criterium:
                                       smelliness ("smelliest" files first)
                                       none (default - output in processing order)
        --force-exclusion            Force excluding files specified in the configuration `exclude_paths`
                                       even if they are explicitly passed as arguments

Exit codes:
        --success-exit-code CODE     The exit code when no smells are found (default: 0)
        --failure-exit-code CODE     The exit code when smells are found (default: 2)

Utility options:
    -h, --help                       Show this message
    -v, --version                    Show version

[jayvdb]

What does it do that existing bears do not do?