Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
CLEAR_METHOD_NAME |
"clear" |
public static final String |
RECORD_METHOD_NAME |
"record" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
HELP |
"CodeNarc - static analysis for Groovy\',\nUsage: java org.codenarc.CodeNarc [OPTIONS]\n where OPTIONS are zero or more command-line options of the form \"-NAME[=VALUE]\":\n -basedir=<DIR>\n The base (root) directory for the source code to be analyzed.\n Defaults to the current directory (\".\").\n -includes=<PATTERNS>\n The comma-separated list of Ant-style file patterns specifying files that must\n be included. Defaults to \"**/*.groovy\".\n -excludes=<PATTERNS>\n The comma-separated list of Ant-style file patterns specifying files that must\n be excluded. No files are excluded when omitted.\n -rulesetfiles=<FILENAMES>\n The path to the Groovy or XML RuleSet definition files, relative to the classpath.\n This can be a single file path, or multiple paths separated by commas. Each path may be optionally prefixed by\n any of the valid java.net.URL prefixes, such as \"file:\" (to load from a relative or absolute filesystem path),\n or \"http:\". If it is a URL, its path may be optionally URL-encoded. That can be useful if the path contains\n any problematic characters, such as comma (\',\') or hash (\'#\'). For instance:\n file:src/test/resources/RuleSet-,#.txt\n can be encoded as:\n file:src%2Ftest%2Fresources%2FRuleSet-%2C%23.txt\n See URLEncoder#encode(java.lang.String, java.lang.String). Defaults to \"rulesets/basic.xml\"\n -maxPriority1Violations=<MAX>\n The maximum number of priority 1 violations allowed (int).\n -maxPriority2Violations=<MAX>\n The maximum number of priority 2 violations allowed (int).\n -maxPriority3Violations=<MAX>\n The maximum number of priority 3 violations allowed (int).\n -title=<REPORT TITLE>\n The title for this analysis; used in the output report(s), if supported by the report type. Optional.\n -report=<REPORT-TYPE[:FILENAME]>\n The definition of the report to produce. The option value is of the form\n TYPE[:FILENAME], where TYPE is \"html\", \"text\", \"xml\", or \"console\" and FILENAME is the filename (with\n optional path) of the output report filename. If the report filename is\n omitted, the default filename is used for the specified report type\n (\"CodeNarcReport.html\" for \"html\" and \"CodeNarcXmlReport.xml\" for \"xml\"). If no\n report option is specified, default to a single \"html\" report with the\n default filename.\n -help\n Display the command-line help. If present, this must be the only command-line parameter.\n Example command-line invocations:\n java org.codenarc.CodeNarc\n java org.codenarc.CodeNarc -rulesetfiles=\"rulesets/basic.xml\" title=\"My Project\"\n java org.codenarc.CodeNarc -report=xml:MyXmlReport.xml -report=html\n java org.codenarc.CodeNarc -help\'" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
CSS_FILE |
"codenarc-htmlreport.css" |
protected static final int |
MAX_SOURCE_LINE_LENGTH |
70 |
protected static final int |
SOURCE_LINE_LAST_SEGMENT_LENGTH |
12 |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
BASE_MESSAGES_BUNDLE |
"codenarc-base-messages" |
protected static final String |
CODENARC_URL |
"http://www.codenarc.org" |
protected static final String |
CUSTOM_MESSAGES_BUNDLE |
"codenarc-messages" |
protected static final String |
VERSION_FILE |
"codenarc-version.txt" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
DEFAULT_OUTPUT_FILE |
"CodeNarcReport.html" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
DEFAULT_OUTPUT_FILE |
"CodeNarcSortableReport.html" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
CLOSURE_TEXT |
"{ -> ... }" |
protected static final String |
DEFAULT_CONST_NAME |
"[A-Z][A-Z0-9_]*" |
protected static final String |
DEFAULT_FIELD_NAME |
"[a-z][a-zA-Z0-9]*" |
protected static final String |
DEFAULT_TEST_CLASS_NAMES |
"*Spec,*Test,*Tests,*TestCase" |
protected static final String |
DEFAULT_TEST_FILES |
".*(Spec|Test|Tests|TestCase)\\.groovy" |
protected static final String |
DEFAULT_VAR_NAME |
"[a-z][a-zA-Z0-9]*" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
ENHANCED_MODE_SYSTEM_PROPERTY |
"org.codenarc.enhancedMode" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
JAVADOC_EMPTY_LINE |
"\\s*\\*\\s*\\n" |
protected static final String |
JAVADOC_END |
"\\s*\\*/" |
protected static final String |
JAVADOC_LINE_PREFIX |
"\\s*\\*\\s*" |
protected static final String |
JAVADOC_START |
"/\\*\\*\\s*\\n" |
protected static final String |
NEW_LINE |
"\\n" |
protected static final String |
NON_WHITESPACE_CHARS |
"\\S+" |
protected static final String |
OPTIONAL_WHITESPACE |
"\\s*" |
protected static final String |
WHITESPACE |
"\\s+" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
MESSAGE |
"def for declaration should not be used" |
public static final String |
MESSAGE_DEF_PARAMETER |
"def for method parameter type should not be used" |
public static final String |
MESSAGE_DEF_RETURN |
"def for method return type should not be used" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
VIOLATION_MESSAGE |
"Do not use java.util.Date. Prefer the classes in the java.time.* packages." |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
CONTROLLERS_AND_TAGLIB_FILES |
".*grails-app/(controllers|taglib)/.*" |
protected static final String |
CONTROLLERS_CLASSES |
"*Controller" |
protected static final String |
CONTROLLERS_FILES |
".*grails-app/controllers/.*" |
protected static final String |
DOMAIN_FILES |
".*grails-app/domain/.*" |
protected static final String |
SERVICE_CLASSES |
"*Service" |
protected static final String |
SERVICE_FILES |
".*grails-app/services/.*" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
MESSAGE |
"collectAll{} is deprecated since Groovy 1.8.1. Use collectNested instead{}." |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
MESSAGE |
"collect{}.flatten() can be collectMany{}" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
MESSAGE |
"Instead of nested collect{}-calls use collectNested{}" |
Modifier and Type | Constant Field | Value |
---|---|---|
public static final String |
NON_STATIC_IMPORT_PATTERN |
"^\\s*import(?!\\s+static)\\s+([^\\s/]+(\\.[^\\s/]+)*)\\b.*" |
public static final String |
STATIC_IMPORT_PATTERN |
"^\\s*import\\s+static\\s+([^\\s/]+(\\.[^\\s/]+)*)\\b.*" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
CLASS_LOADER_SYS_PROP |
"codenarc.useCurrentThreadContextClassLoader" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
RULE_INDEX_FILE |
"src/site/apt/codenarc-rule-index.apt" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
RULESET_FILE |
"src/site/resources/StarterRuleSet-AllRules.groovy.txt" |
Modifier and Type | Constant Field | Value |
---|---|---|
protected static final String |
RULESET_FILE |
"src/site/resources/StarterRuleSet-AllRulesByCategory.groovy.txt" |
Copyright © 2019. All rights reserved.