Fork me on GitHub

General

Home
Downloads
GitHub Project
Javadoc

Running

Ant Task
Command-Line [Docker]
Run as a Test
Other Tools/Frameworks

Using

Creating a RuleSet
Creating a Rule
Configuring Rules
Config for Grails, Spock, etc.
Starter RuleSet (All)

Report Types

HTML Report [SAMPLE]
Sortable HTML [SAMPLE]
XML Report [SAMPLE]
JSON Report [SAMPLE]
Text/IDE/Compact Reports [SAMPLE]
GitLab Code Quality Report [SAMPLE]
SARIF Report [SAMPLE]
Baseline Report

Rules

Rule Index [By Name]
Basic Rules
Braces Rules
Comments Rules
Concurrency Rules
Convention Rules
Design Rules
DRY Rules
Enhanced Rules
Exceptions Rules
Formatting Rules
Generic Rules
Grails Rules
Groovyism Rules
Import Rules
JDBC Rules
JUnit Rules
Logging Rules
Naming Rules
Size/Complexity Rules
Security Rules
Serialization Rules
Unnecessary Rules
Unused Rules

Developing

Developer Guide

Rule Index by Name

CodeNarc includes 406 rules.

Rules

[TOP] https://codenarc.org