kevinclark edited this page Sep 13, 2010 · 2 revisions
Clone this wiki locally

Nitpick is intended to be a customizable, programmable, static checker for Ruby. It currently consists of a script which scans require’d code (via method_added) and outputs various warnings built atop a library which provides code-level access to warnings .

If you have ideas for new checks, add them at Suggested Checks. Some set of current checks are “documented” (and I use the term loosely) at Implemented Checks.

Many things Nitpick can do, Ruby can warn about (with -w). But that requires you to notice at runtime, and many apps won’t run cleanly with -w. Many libraries (standard or otherwise) spew warnings, and it’s easy for the stuff you care about to get lost in the deluge. The goal of Nitpick is to be able to inspect code for what you care about before you put it into production.