Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Revert "Edited README.md via GitHub"

This reverts commit 2dc1f16.
  • Loading branch information...
commit e586a6c26d7a252a991eeacbd5f652873e3d0476 1 parent 2dc1f16
duncan-bayne authored
Showing with 9 additions and 18 deletions.
  1. +9 −18 README.md
View
27 README.md
@@ -1,26 +1,21 @@
-roodi
-=====
+= roodi
* http://roodi.rubyforge.org
-DESCRIPTION
------------
+== DESCRIPTION:
Roodi stands for Ruby Object Oriented Design Inferometer. It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
-INSTALL
--------
+== INSTALL:
* sudo gem install roodi
-SYNOPSIS
---------
+== SYNOPSIS:
To check one or more files using the default configuration that comes with Roodi, use:
roodi [-config=file] [pattern ...]
-EXAMPLE USAGE
--------------
+=== EXAMPLE USAGE
Check all ruby files in a rails app:
roodi "rails_app/**/*.rb"
@@ -37,8 +32,7 @@ Check all ruby files in a rails app with a custom configuration file:
If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ruby_parser). Use:
roodi-describe [filename]
-CUSTOM CONFIGURATION
---------------------
+== CUSTOM CONFIGURATION
To change the set of checks included, or to change the default values of the checks, you can provide your own config file. The config file is a YAML file that lists the checks to be included. Each check can optionally include a hash of options that are passed to the check to configure it. For example, the default config file looks like this:
@@ -56,8 +50,7 @@ To change the set of checks included, or to change the default values of the che
ModuleNameCheck: { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
ParameterNumberCheck: { parameter_count: 5 }
-SUPPORTED CHECKS
-----------------
+== SUPPORTED CHECKS:
* AssignmentInConditionalCheck - Check for an assignment inside a conditional. It's probably a mistaken equality comparison.
* CaseMissingElseCheck - Check that case statements have an else statement so that all cases are covered.
@@ -73,13 +66,11 @@ SUPPORTED CHECKS
* ModuleNameCheck - Check that module names match convention.
* ParameterNumberCheck - Check that the number of parameters on a method is below the threshold.
-SUGGESTED CHECKS
-----------------
+== SUGGESTED CHECKS:
* BlockVariableShadowCheck - Check that a block variable does not have the same name as a method parameter or local variable. It may be mistakenly referenced within the block.
-LICENSE
--------
+== LICENSE:
(The MIT License)
Please sign in to comment.
Something went wrong with that request. Please try again.