Skip to content

Latest commit

 

History

History
56 lines (29 loc) · 3.54 KB

ROADMAP.md

File metadata and controls

56 lines (29 loc) · 3.54 KB
Raw

These are more nice-to-haves than promises. We can always dream. But this is what we hope to improve in RubyCritic:

  • Explain every single code smell. This includes the "Churn vs Complexity" scatter plot and other graphs that may be implemented.

  • Provide suggestions to fix every code smell. Figure out how to present them in the UI.

  • Improve how modules are graded. Each module is awarded a score, depending on:

    • Its complexity, based off of this post by Jake Scruggs, creator of the MetricFu gem. For every 25 points of complexity (as calculated by Flog), the score increases by 1.

    • Its duplication mass, based off of observations of a few Code Climate repos. For every 25 points of mass (as calculated by Flay), the score increases by 1.

    Finally, this score is translated to a grade like this, based off of a Code Climate blog post.

  • Implement a project rating, ala Code Climate.

  • Explain ratings. What's the difference between an A and a B? Bryan Helmkamp, the creator of Code Climate, wrote a great essay on the subject. #63

  • Explore alternative ratings. GPA and A-F grades are quite US centric. #50

  • Make the gem configurable using a dotfile like .rubycritic.yml. #30 Here are some possible settings:

    • Quiet mode. As of right now, any Ruby code that is unparsable will be reported three times (one time by Flog, another by Flay and another by Reek). Only Flog implements a quiet option, which means we have to implement that quiet option on Flay and on Reek before we can add it to RubyCritic. Or we could just do $stderr = StringIO.new... I wonder if that's really really smart or really really stupid.

    • Verbose mode. #61

    • Ignoring/excluding files. #11

    • Allow configuring date range of Churn calculation. #37 Right now, they are limited to the last year. #39

  • Highlight blocks of duplicated code instead of just the start of the block. This will probably require rewriting Flay with parser instead of ruby_parser.

  • Integrate other gems, like:

  • Improve UI.

    • Make it beautiful.

    • Figure out where the "suggestions to fix code smells" should be presented.

    • Create some kind of toggle option between various types of issues. Just like we can toggle between "Smells" and "Coverage" in Code Climate:

      Code Climate Toggle Option

      Having an option to toggle between "Smells", "Security" (Brakeman) and "Style" (Rubocop) would be great. But that's already assuming we can integrate those gems into RubyCritic.