You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2023/05/22 10:46:00 UTC
[jira] [Commented] (MCHECKSTYLE-412) Exclude generated sources / test-sources from default source / test-source directories
[ https://issues.apache.org/jira/browse/MCHECKSTYLE-412?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17724888#comment-17724888 ]
ASF GitHub Bot commented on MCHECKSTYLE-412:
--------------------------------------------
gmshake commented on PR #76:
URL: https://github.com/apache/maven-checkstyle-plugin/pull/76#issuecomment-1556990598
1. Rebased onto latest master
2. Added a knob `excludeGeneratedSources` to not break existing setups, it is false by default
> Exclude generated sources / test-sources from default source / test-source directories
> --------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-412
> URL: https://issues.apache.org/jira/browse/MCHECKSTYLE-412
> Project: Maven Checkstyle Plugin
> Issue Type: Improvement
> Components: checkstyle:check, checkstyle:checkstyle
> Affects Versions: 3.1.2
> Reporter: Zhenlei Huang
> Priority: Minor
>
> 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.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)