CodeNarc - CodeNarc - Generic Rules

##### General

- Home
- Downloads
- Road Map
- Javadocs
- Mailing Lists
- Bug Tracker
- SourceForge Project

##### Running

- Ant Task Usage
- Command-Line
- Run as a Test
- Other Tools/Frameworks

##### Using

- Creating a RuleSet
- Creating a Rule
- Configuring Rules
- Starter RuleSet (All)

##### Report Types

- HTML (HtmlReportWriter)
- XML (XmlReportWriter)
- Text (TextReportWriter)

##### Sample Reports

- Sample HTML Report
- Open Source Projects

##### Rules

- Rule Index
- Basic Rules
- Braces Rules
- Concurrency Rules
- Convention Rules
- Design Rules
- DRY Rules
- Exceptions Rules
- Formatting Rules
- Generic Rules
- Grails Rules
- Groovyism Rules
- Imports Rules
- JDBC Rules
- JUnit Rules
- Logging Rules
- Naming Rules
- Size/Complexity Rules
- Security Rules
- Serialization Rules
- Unnecessary Rules
- Unused Rules

##### Developing

- Developer Guide

##### Project Documentation

- Project Information
- Project Reports

## Generic Rules ("rulesets/generic.xml")

### IllegalClassReference Rule

Since CodeNarc 0.15

Checks for reference to any of the classes configured in `classNames`.

Property | Description | Default Value
classNames | Specifies the comma-separated list of (fully-qualified) class names. The class name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard matches any sequence of zero or more characters in the class/package name, e.g. 'a.*.MyClass' matches `a.b.MyClass` as well as `a.b.c.d.MyClass`. If `classNames` is null or empty, do nothing. | `null`

Note that you can use the standard rule properties, such as `applyToClassNames`, `doNotApplyToFileNames` and `applyToFilesMatching` to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.

This rule can be useful for governance and enforcement of architectural layering. For instance, making sure that view or model classes, for instance, do not contain references to DAO classes (e.g., *Dao).

Here is an example configuration of this rule used to ensure that DAO classes are not referenced from within model classes:

        ruleset {
            description "Example CodeNarc Ruleset"

            // ...

            IllegalClassReference {
                name = 'DoNotReferenceDaoFromModelClasses'
                priority = 2
                classNames = '*Dao'
                applyToClassNames = 'com.example.model.*'
                description = 'Do not reference DAOs from model classes.'
            }
        }

A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and classNames, and (optionally) customized violationMessage and priority.

### IllegalPackageReference Rule

Since CodeNarc 0.14

Checks for reference to any of the packages configured in `packageNames`.

Property | Description | Default Value
packageNames | Specifies the comma-separated list of package names. The package name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard matches any sequence of zero or more characters in the package name, e.g. 'a.*' matches 'a.b' as well as 'a.b.c.d'. If `packageNames` is null or empty, do nothing. | `null`

Note that you can use the standard rule properties, such as `applyToClassNames`, `doNotApplyToFileNames` and `applyToFilesMatching` to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.

This rule can be useful for governance and enforcement of architectural layering. For instance, making sure that view or model classes, for instance, do not contain references to JDBC-specific packages (e.g. java.sql and javax.sql).

Here is an example configuration of this rule used to ensure that JDBC packages/classes are only referenced within DAO classes:

        ruleset {
            description "Example CodeNarc Ruleset"

            // ...

            IllegalPackageReference {
                name = 'UseJdbcOnlyInDaoClasses'
                priority = 2
                packageNames = 'groovy.sql, java.sql, javax.sql'
                doNotApplyToClassNames = 'com.example.framework.dao.*, *Dao, *DaoImpl'
                description = 'Reference to JDBC packages should be restricted to DAO classes.'
            }
        }

A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and packageNames, and (optionally) customized violationMessage and priority.

### IllegalRegex Rule

Checks for a specified illegal regular expression within the source code.

Property | Description | Default Value
regex | The regular expression to check for. If null or empty then do nothing. | `null`

A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and regex, and (optionally) customized violationMessage and priority.

NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.

### RequiredRegex Rule

Checks for a specified regular expression that must exist within the source code.

Property | Description | Default Value
regex | The regular expression to check for. If null or empty then do nothing. | `null`

A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and regex, and (optionally) customized violationMessage and priority.

NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.

### RequiredString Rule

Checks for a specified text string that must exist within the source code.

Property | Description | Default Value
string | The String to check for. If null or empty then do nothing. | `null`

A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and string, and (optionally) customized violationMessage and priority.

NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.

### StatelessClass Rule

Checks for non-`final` fields on a class. The intent of this rule is to check a configured set of classes that should remain "stateless" and reentrant. One example might be Grails service classes which are singletons, by default, and so they should be reentrant.

This rule ignores `final` fields (either instance or static). Fields that are `static` and non-`final`, however, do cause a violation.

This rule also ignores all classes annotated with the `@Immutable` transformation. See http://groovy.codehaus.org/Immutable+transformation.

This rule also ignores all fields annotated with the `@Inject` annotation.

You can configure this rule to ignore certain fields either by name or by type. This can be useful to ignore fields that hold references to (static) dependencies (such as DAOs or Service objects) or static configuration.

Property | Description | Default Value
ignoreFieldNames | Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?). | `null`
addToIgnoreFieldNames | Specifies one or more (comma-separated) field names to be added to the `ignoreFieldNames` property value. This is a special write-only property, and each call to `setAddIgnoreFieldNames()` adds to (rather than overwrites) the list of field names to be ignored. | `null`
ignoreFieldTypes | Specifies one or more (comma-separated) field types that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?). | `null`

Note that you can use the standard rule properties, such as `applyToClassNames`, `doNotApplyToFileNames` and `applyToFilesMatching` to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.

#### Notes

1. The `ignoreFieldTypes` property matches the field type name as indicated in the field declaration, only including a full package specification IF it is included in the source code. For example, the field declaration `BigDecimal value` matches an `ignoreFieldTypes` value of `BigDecimal`, but not `java.lang.BigDecimal`.
2. There is one exception for the `ignoreFieldTypes` property: if the field is declared with a modifier/type of `def`, then the type resolves to `java.lang.Object`.
3. At least one of the (standard) `applyToClassNames`, `applyToFileNames` or `applyToFilesMatching` properties must be set (i.e., not null or empty) or else this rule does nothing. In other words, you must configure this rule to apply to a specific set of classes or files.