You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Olivier Vierlinck (JIRA)" <ji...@codehaus.org> on 2006/07/28 16:30:32 UTC
[jira] Created: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
-------------------------------------------------------------------------------------------------------------------
Key: MCHECKSTYLE-51
URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
Project: Maven 2.x Checkstyle Plugin
Issue Type: Improvement
Affects Versions: 2.1
Environment: NA
Reporter: Olivier Vierlinck
Priority: Minor
While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
To refine this, it very useful to tackle first the big problems=the one occuring often
Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Olivier Vierlinck (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=all ]
Olivier Vierlinck updated MCHECKSTYLE-51:
-----------------------------------------
Attachment: MNG-39787-maven-plugin-checkstyle.patch
Here is a proposed implementation, based on two new configuration params:
showNonViolatedRules : @parameter expression="${checkstyle.sort.rule.summary}" default-value="false"
enableSeveritySummary : @parameter expression="${checkstyle.enable.severity.summary}" default-value="true"
Default values are set so that the normal behaviour is obtained by default
Note that although provided in one patch, these two 'features' are independent and could be used/merged/configured independently (the first one, hidding no violated rules, is very small and impact only a few lines of code (+ supporting its configuration)
This is my first contribution to this project, let me now if you need something more: info, doc,...
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Olivier Vierlinck (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_71019 ]
Olivier Vierlinck commented on MCHECKSTYLE-51:
----------------------------------------------
Note that in my second comment, I described enableSeveritySummary instead of sortRuleSummary.
So here are the new configurations:
showNonViolatedRules : @parameter expression="${checkstyle.sort.rule.summary}" default-value="false"
sortRuleSummary : @parameter expression="${checkstyle.sort.rule.summary}" default-value="false"
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Carlos Sanchez (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_71012 ]
Carlos Sanchez commented on MCHECKSTYLE-51:
-------------------------------------------
All new features must have javadocs, examples, unit tests,...
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_77927 ]
Vincent Siveton commented on MCHECKSTYLE-51:
--------------------------------------------
Olivier,
Thanks! Your patch sounds good (for the next time, please ensure you use our checkstyle [1]).
Could you provide us:
* small documentation (ie one example) [2]
* unit tests with plugin harness [3]
Thanks again.
[1] http://maven.apache.org/guides/development/guide-m2-development.html#Maven%20Code%20Style
[2] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation
[3] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Harness
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Olivier Vierlinck (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_71016 ]
Olivier Vierlinck commented on MCHECKSTYLE-51:
----------------------------------------------
I put the same king of javadoc as in the existing code. Anything more needed?
Regarding the example, what should I do? I don't see example in the existing code? if this patch is accepted, I don't mind editing the Customization page on maven.apache.org or provide a patch for this page (note that other existing features are not yet listed on this page either: enableRulesSummary, enableFileSummary,...)
OK for unit test, I could change the sample rule definition to add a rule that is satisfied and test that when 'showNonViolatedRules' is false, it is not shown For the 'sorting' feature, I don't know if unit test is relevant.. or more relevant for this feature than for any other non-unit-tested checkstyle features...
Let me know what to do from here...
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_71029 ]
Dennis Lundberg commented on MCHECKSTYLE-51:
--------------------------------------------
Olivier, regarding documentation, please build the plugin site locally using:
mvn site
There has been a lot of updates to the documentation this and other plugins. That site should give you an idea of that is needed. Or you can have a loot at the proposed docs here:
http://people.apache.org/~oching/maven-checkstyle-plugin/
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MCHECKSTYLE-51) Rules summary flexibility:add
possibility to hide non-violated rules and to sort by descending number of
occurences
Posted by "Olivier Vierlinck (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MCHECKSTYLE-51?page=comments#action_71532 ]
Olivier Vierlinck commented on MCHECKSTYLE-51:
----------------------------------------------
ok, I see more documentation there on the possibile customization of the plugin.
I'm ok to put the doc for the 2 new settings... if my patch is accepted!
What are the next steps?
> Rules summary flexibility:add possibility to hide non-violated rules and to sort by descending number of occurences
> -------------------------------------------------------------------------------------------------------------------
>
> Key: MCHECKSTYLE-51
> URL: http://jira.codehaus.org/browse/MCHECKSTYLE-51
> Project: Maven 2.x Checkstyle Plugin
> Issue Type: Improvement
> Affects Versions: 2.1
> Environment: NA
> Reporter: Olivier Vierlinck
> Priority: Minor
> Attachments: MNG-39787-maven-plugin-checkstyle.patch
>
>
> While using maven + Checkstyle on a new project, the amount of errors/warnings was quite high, due both because checkstyle was not yet configured to match our preferences.. and also to real style errors.
> To refine this, it very useful to tackle first the big problems=the one occuring often
> Similarly, it is helpful NOT to see the rules that are not violated, so that we can concentrate on the existing problems
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira