README.rdoc in simplabs-excellent-1.4.2 vs README.rdoc in simplabs-excellent-1.5.0
- old
+ new
@@ -20,9 +20,18 @@
in your <tt>RAILS_ROOT</tt>. You can also invoke analysation through the Simplabs::Excellent::Runner class. Excellent can also produce HTML output. To
get a formatted HTML report, just specify <tt>html:<filename></tt>:
excellent html:out.html app/models
+You can also use Excellent in a Rake task:
+
+ require 'simplabs/excellent/rake'
+
+ Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
+ t.html = 'doc/excellent.html' # optional, if you don't specify html, output will be written to $stdout
+ t.paths = %w(app lib)
+ end
+
== Static analysis
A few words regarding static code analysis: Static code analysis tools like Excellent can never really understand the code. They just search for patterns that *might* inidicate problematic code. The word *might* really has to be stressed here since static analysis will usually return a reasonable number of false positives. For example, there might be pretty good reasons for empty +rescue+ blocks that suppress all errors (Excellent itself does it). So, don't try and code with the aim of passing Excellent with zero warnings. That will most likely make your code a mess. Instead use Excellent as a helper to find *possibly* problematic code early.
== Contribute