[MCHECKSTYLE-412] Add option to exclude generated sources/test-sources from default source/test-source directories

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.1.2
• Fix Version/s: 3.3.1
• Component/s: checkstyle:check, checkstyle:checkstyle

Language

Java

• Assignee: Michael Osipov
• Reporter: Zhenlei Huang
• Created: 12/May/22 10:20
• Updated: 27/Dec/23 08:02
• Resolved: 24/May/23 11:28

Description

The default value of parameter `sourceDirectories` is  `${project.compileSourceRoots}`, which includes generated sources. And for `testSourceDirectories` is `${project.testCompileSourceRoots}` which includes generated test sources.

The major usage of checkstyle is to enforce rules on human written codes and docs. The generated ones commonly come from third-party templates or scripts, and they probably do not meet user defined checkstyle rules.

We can bravely conclude exclude the generated sources / test sources directories and the impact should be trivial, although it is a breaking change.

Issue Links

• is related to: MCHECKSTYLE-444 Support exclusion of generated (test) resources
• links to: GitHub Pull Request #76