Overview

• Introduction
• Goals
• Usage
• FAQ

Examples

• Using a Custom Checkstyle Checker Configuration
• Using Custom Checkstyle Property Expansion Definitions
• Using a Suppressions Filter
• Using Custom Developed Checkstyle Checks
• Multimodule Configuration

Project Documentation

• Project Information
• Project Reports

How are the Checkstyle properties set?

You can set the Checkstyle properties to be used in the plugin configuration of your pom through the propertiesLocation parameter. The properties file will be resolved by the plugin based on its value.

[top]

---

How do I set a custom ruleset?

You can set a custom ruleset through the configLocation plugin parameter. If no value is specified, the plugin will use a default ruleset, which is the sun_checks.xml, that is bundled with the plugin.

[top]

---

How do I include the test directory in Checkstyle?

You can include the test directory in the Checkstyle report by setting the includeTestSourceDirectory plugin parameter to true.

[top]