Skip to main content
jCoderZ.org / Java tooling collective
  1. Home
  2. fawkeZ
  3. Wiki
  4. Checkstyle

fawkeZ wiki / last edited 25 November 2006

Checkstyle

Coding standard enforcement, joined into the combined findings report.

Checkstyle checks Java source against a coding standard. Its homepage is checkstyle.org. Within fawkeZ it enforces the conventions described in the Java coding guidelines document.

The tool is wired into the same analysis chain as PMD and FindBugs. Its findings appear in the combined JcReport view, and the rule configuration is declared through the checkstyle.rules property.

Configuration

  • The rule set file is config/jcoderz-checkstyle.xml.
  • The Checkstyle version is declared with the other tool versions in config/ivy.xml.
  • The report normaliser converts the Checkstyle XML output into the shared findings format.
Archive note The original page recorded the tool and the report normaliser, but its update checklist was never written. The steps above are the ones that the build configuration actually references; no additional procedure has been invented here.

The coding guidelines describe the rules that the configuration implements, and the contribution guide explains why patches are expected to pass them.

References