[
https://issues.apache.org/jira/browse/MCHECKSTYLE-301?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Krzysztof Krason updated MCHECKSTYLE-301:
-----------------------------------------
Description:
Right now the plugin prints the name of file, line number and description of
the violation, it would be nice to also have a violation ID/name.
In the case below it should print "AvoidStarImport".
{code}
[INFO] --- maven-checkstyle-plugin:2.15:check (check-sources) @ svt-sds-impl ---
[INFO] Starting audit...
.../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12:
Using the '.*' form of import should be avoided - java.util.*.
Audit done.
{code}
So after the changes it could be (only the relevant part):
{code}
.../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12
(AvoidStarImport) Using the '.*' form of import should be avoided - java.util.*.
{code}
This name is usefull if one would like to disable this check using suppression
plugin:
{code}
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@checkstyle (\w+) \((\d+)
lines?\)"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="$2"/>
</module>
{code}
Right now googling is required to find out the name of the rule.
was:
Right now the plugin prints the name of file, line number and description of
the violation, it would be nice to also have a violation ID/name.
In the case below it should print "AvoidStarImport".
{code}
[INFO] --- maven-checkstyle-plugin:2.15:check (check-sources) @ svt-sds-impl ---
[INFO] Starting audit...
.../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12:
Using the '.*' form of import should be avoided - java.util.*.
Audit done.
{code}
So after the changes it could be (only the relevant part):
{code}
.../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12
(AvoidStarImport) Using the '.*' form of import should be avoided - java.util.*.
{code}
> Plugin in check goal should print the name of the rule that was violated
> ------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-301
> URL: https://issues.apache.org/jira/browse/MCHECKSTYLE-301
> Project: Maven Checkstyle Plugin
> Issue Type: Bug
> Reporter: Krzysztof Krason
> Priority: Minor
>
> Right now the plugin prints the name of file, line number and description of
> the violation, it would be nice to also have a violation ID/name.
> In the case below it should print "AvoidStarImport".
> {code}
> [INFO] --- maven-checkstyle-plugin:2.15:check (check-sources) @ svt-sds-impl
> ---
> [INFO] Starting audit...
> .../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12:
> Using the '.*' form of import should be avoided - java.util.*.
> Audit done.
> {code}
> So after the changes it could be (only the relevant part):
> {code}
> .../project/src/main/java/com/implementation/sds/util/DatesCalculator.java:12
> (AvoidStarImport) Using the '.*' form of import should be avoided -
> java.util.*.
> {code}
> This name is usefull if one would like to disable this check using
> suppression plugin:
> {code}
> <module name="SuppressWithNearbyCommentFilter">
> <property name="commentFormat" value="@checkstyle (\w+) \((\d+)
> lines?\)"/>
> <property name="checkFormat" value="$1"/>
> <property name="influenceFormat" value="$2"/>
> </module>
> {code}
> Right now googling is required to find out the name of the rule.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
