{"repo":"troessner/reek","free":true,"listed":false,"github":"https://github.com/troessner/reek","clone":"git clone https://github.com/troessner/reek.git","description":"Code smell detector for Ruby","language":"Ruby","stars":4130,"topics":["smell","ruby","smell-warnings","smell-detector","static-analysis","linters","quality","parsing"],"license":"MIT","category":"dev-tools","readme_excerpt":"Code smell detector for Ruby Table of Contents - Overview - Quickstart - Example - Supported Ruby versions - Fixing Smell Warnings - Sources - Code smells - Configuration - Command-line interface - Configuration file - Configuration loading - Configuration options - Generating a 'todo' list - Beware of multiple configuration files - Source code comments - Usage - Developing Reek / Contributing - Output formats - Working with Rails - Integrations - Editor integrations - Projects that use or support us - Misc - Brothers and sisters - Contributors - Additional resources - Miscellaneous - More information Overview Quickstart Reek is a tool that examines Ruby classes, modules and methods and reports any Code Smells it finds. For an excellent introduction to Code Smells and Reek check out this blog post or that one. There is also this talk from RubyConfBY (there is also a slide deck if you prefer that). Install it via rubygems: and run it like this: Example Imagine a source file demo.rb containing: Reek will report the following code smells in this file: Supported Ruby versions Reek is officially supported for CRuby 3.0 through 3.3 and for JRuby 9.4. Other Ruby implementations (like Rubinius) are not officially supported but should work as well. Note that, on each Ruby version, Reek will use the parser for that version of Ruby. So, you should always run Reek using one of your project's target Ruby versions. Fixing Smell Warnings Reek focuses on high-level code smells, so we can't t","default_branch":null,"files":null,"tree":[],"storefront":"/r/troessner","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/troessner/reek/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."}