[MCHECKSTYLE-444] Support exclusion of generated (test) resources

• Type: Bug
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 3.3.1
• Component/s: checkstyle:check
• Assignee: Unassigned
• Reporter: Stephan Schroevers
• Created: 27/Dec/23 08:02
• Updated: 29/Dec/23 06:32

Description

In the context of MCHECKSTYLE-412 a new excludeGeneratedSources option was introduced. This feature does not exclude generated resources, however. Generated resources are not uncommon:

1. The license-maven-plugin attaches a THIRD-PARTY.txt file.
2. The hisrc-basicjaxb plugin attaches a META-INF/sun-jaxb.episode file, located in a directory that also contains generated sources ().

As a result, if one sets

<excludeGeneratedSources>true</excludeGeneratedSources>
<resourceIncludes>**/*</resourceIncludes>

Then the plugin will flag THIRD-PARTY.txt files (not completely unexpected) as well as XJC-generated Java files (very unexpected).

Possible fixes:

1. Update the excludeGeneratedSources flag to also cover (test) resource directories.
2. Introduce an analogous excludeGeneratedResources flag.

(The first option may seem less flexible, but would be less surprising i.c.w. plugins that generate sources and resources into the same directory, as in example (2) above.)

I'm open to contributing a PR for this change; it would be nice to first hear from the maintainers whether they prefer approach (1) or (2).

Issue Links

• relates to: MCHECKSTYLE-412 Add option to exclude generated sources/test-sources from default source/test-source directories