CodeNarc (Groovy Documentation)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD

DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.codenarc
Class CodeNarc

java.lang.Object
  org.codenarc.CodeNarc

class CodeNarc

Command-line runner for CodeNarc.

The supported command-line parameters are all of the form: "-OPTION=VALUE", where OPTION is one of the options in the following list.

help - Display the command-line help; If present, this must be the only command-line parameter.
basedir - The base directory for the source code to be analyzed. This is the root of the directory tree. Defaults to the current directory ('.').
rulesetfiles - The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a single file path, or multiple paths separated by commas. Defaults to "rulesets/basic.xml".
includes - The comma-separated list of Ant file patterns specifying files that must be included; all files are included when omitted.
excludes - The comma-separated list of Ant file patterns specifying files that must be excluded; no files are excluded when omitted.
title - The title description for this analysis; used in the output report(s). Optional.
report - The definition of the report to produce. The option value is of the form TYPE[:FILENAME]. where TYPE is 'html' and FILENAME is the filename (with optional path) of the output report filename. If the report filename is omitted, the default filename is used ("CodeNarcReport.html"). If no report option is specified, defaults to a single 'html' report with the default filename.

author:: Chris Mair

version:: $Revision: 268 $ - $Date: 2010-01-02 13:40:41 -0500 (Sat, 02 Jan 2010) $

Property Summary
`protected static def`	`HELP`
`static def`	`LOG`
`protected String`	`baseDir`
`protected def`	`createCodeNarcRunner`
`protected String`	`excludes`
`protected String`	`includes`
`protected List`	`reports`
`protected String`	`ruleSetFiles`
`protected String`	`title`

Constructor Summary
`CodeNarc()`

Method Summary
`protected SourceAnalyzer`	`createSourceAnalyzer()` Create and return the SourceAnalyzer
`protected void`	`execute(String[] args)`
`static void`	`main(String[] args)` Main command-line entry-point.
`protected void`	`parseArgs(String[] args)`
`protected void`	`setDefaultsIfNecessary()`

Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Property Detail

HELP

protected static final def HELP

LOG

static final def LOG

baseDir

protected String baseDir

createCodeNarcRunner

protected def createCodeNarcRunner

excludes

protected String excludes

includes

protected String includes

reports

protected List reports

ruleSetFiles

protected String ruleSetFiles

title

protected String title

Constructor Detail

CodeNarc

CodeNarc()

Method Detail

createSourceAnalyzer

protected SourceAnalyzer createSourceAnalyzer()

Create and return the SourceAnalyzer

return:: a configured SourceAnalyzer instance

execute

protected void execute(String[] args)

main

public static void main(String[] args)

Main command-line entry-point. Run the CodeNarc application.

param:: args - the String[] of command-line arguments

parseArgs

protected void parseArgs(String[] args)

setDefaultsIfNecessary

protected void setDefaultsIfNecessary()

Groovy Documentation

org.codenarc Class CodeNarc