CodeNarc (CodeNarc 3.5.0 API)

org.codenarc.CodeNarc

```
@java.lang.SuppressWarnings(value: [Println, PrintStackTrace])
class CodeNarc
extends java.lang.Object
```
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 ('.').
- sourcefiles - The comma-separated list of files we want to analyze. If set, -includes and -exclude arguments are ignored.
- 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. Each path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute filesystem path), or "http:". If it is a URL, its path may be optionally URL-encoded. That can be useful if the path contains any problematic characters, such as comma (',') or hash ('#'). See URLEncoder#encode(java.lang.String, java.lang.String). Defaults to "rulesets/basic.xml".
- ruleset - JSON string (URL-encoded in UTF-8) containing a ruleSet in JSON format (if set, rulesetfiles will be ignored).
- excludeBaseline - The filename of the optional baseline. If not set, no baseline will be used.
- 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.
- maxPriority1Violations - The maximum number of priority 1 violations allowed. Optional.
- maxPriority2Violations - The maximum number of priority 2 violations allowed. Optional.
- maxPriority3Violations - The maximum number of priority 3 violations allowed. Optional.
- failOnError - whether to terminate and fail the task if any errors occur parsing source files. Optional.
- title - The title description for this analysis; used in the output report(s), if supported. Optional.
- report - The definition of the report to produce. The option value is of the form TYPE[:FILENAME|:stdout]. where TYPE is 'html' and FILENAME is the filename (with optional path) of the output report filename. If the TYPE is followed by :stdout (e.g. "html:stdout", "json:stdout"), then the report is written to standard out. 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.
- plugins - The optional list of CodeNarcPlugin class names to register, separated by commas.
Authors:
Chris Mair
Nicolas Vuillamy

Field Summary

Fields
Modifiers	Name	Description
`protected static java.lang.String`	`HELP`
`protected java.lang.String`	`baseDir`
`protected groovy.lang.Closure`	`createCodeNarcRunner`
`protected java.lang.String`	`excludes`
`protected java.lang.String`	`includes`
`protected int`	`maxPriority1Violations`
`protected int`	`maxPriority2Violations`
`protected int`	`maxPriority3Violations`
`protected java.lang.String`	`plugins`
`protected java.lang.String`	`propertiesFilename`
`protected java.util.List`	`reports`
`protected java.lang.String`	`ruleSetFiles`
`protected java.lang.String`	`ruleset`
`protected java.lang.String`	`sourceFiles`
`protected static groovy.lang.Closure`	`systemExit`
`protected java.lang.String`	`title`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`excludeBaseline` The path to a Baseline Violations report (report type "baseline").
`boolean`	`failOnError` Whether to terminate and fail the task if errors occur parsing source files (true), or just log the errors (false)

Constructor Summary

Constructors
Constructor and description
`CodeNarc ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`checkMaxViolations(Results results, int priority, int max)`
	`protected SourceAnalyzer`	`createSourceAnalyzer()` Create and return the SourceAnalyzer
	`protected void`	`execute(java.lang.String[] args)`
	`static void`	`main(java.lang.String[] args)` Main command-line entry-point.
	`protected void`	`parseArgs(java.lang.String[] args)`
	`protected void`	`setDefaultsIfNecessary()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final java.lang.String HELP
  - protected java.lang.String baseDir
  - protected groovy.lang.Closure createCodeNarcRunner
  - protected java.lang.String excludes
  - protected java.lang.String includes
  - protected int maxPriority1Violations
  - protected int maxPriority2Violations
  - protected int maxPriority3Violations
  - protected java.lang.String plugins
  - protected java.lang.String propertiesFilename
  - protected java.util.List reports
  - protected java.lang.String ruleSetFiles
  - protected java.lang.String ruleset
  - protected java.lang.String sourceFiles
  - protected static groovy.lang.Closure systemExit
  - protected java.lang.String title
- Property Detail
  - java.lang.String excludeBaseline
    
    The path to a Baseline Violations report (report type "baseline"). If set, then all violations specified within that report are excluded (filtered) from the current CodeNarc run. If null/empty, then do nothing.
  - boolean failOnError
    
    Whether to terminate and fail the task if errors occur parsing source files (true), or just log the errors (false)
- Constructor Detail
  - CodeNarc()
- Method Detail
  - protected void checkMaxViolations(Results results, int priority, int max)
  - protected SourceAnalyzer createSourceAnalyzer()
    
    Create and return the SourceAnalyzer
    Returns:
    a configured SourceAnalyzer instance
  - protected void execute(java.lang.String[] args)
  - static void main(java.lang.String[] args)
    
    Main command-line entry-point. Run the CodeNarc application.
    Parameters:
    args - - the String[] of command-line arguments
  - protected void parseArgs(java.lang.String[] args)
  - protected void setDefaultsIfNecessary()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class CodeNarc

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final java.lang.String HELP

protected java.lang.String baseDir

protected groovy.lang.Closure createCodeNarcRunner

protected java.lang.String excludes

protected java.lang.String includes

protected int maxPriority1Violations

protected int maxPriority2Violations

protected int maxPriority3Violations

protected java.lang.String plugins

protected java.lang.String propertiesFilename

protected java.util.List reports

protected java.lang.String ruleSetFiles

protected java.lang.String ruleset

protected java.lang.String sourceFiles

protected static groovy.lang.Closure systemExit

protected java.lang.String title

Property Detail

java.lang.String excludeBaseline

boolean failOnError

Constructor Detail

CodeNarc()

Method Detail

protected void checkMaxViolations(Results results, int priority, int max)

protected SourceAnalyzer createSourceAnalyzer()

protected void execute(java.lang.String[] args)

static void main(java.lang.String[] args)

protected void parseArgs(java.lang.String[] args)

protected void setDefaultsIfNecessary()