Create extensions from checkstyle-metadata.xml

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: Administration, Rules, Tuning
  • Labels:
    None
  • Environment:
    Any

Description

It is currently possible to add new rule profiles, by placing checkstyle and pmd config files in "sonar_web/rules_profiles/profilename" directory.

However, in order to add rule extensions one has to add them by hand, then has to configure them by hand which is quite "annoying" when having multipl rules with regular expressions to add.

It would be thus great if it was possible to extract information from checkstyle-metadata.xml to automatically create these rules extensions. Most of needed information is there.

contact me if you need more information.

Michel

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Simon Brandhof added a comment -

Do you know where I can find some documentation on this checkstyle-cs format ? It should manage the following fields :

  • the name
  • the description
  • the ISO category
  • the parameters and their default values
  • the key used by checkstyle.

Thank you

Show
Simon Brandhof added a comment - Do you know where I can find some documentation on this checkstyle-cs format ? It should manage the following fields :
  • the name
  • the description
  • the ISO category
  • the parameters and their default values
  • the key used by checkstyle.
Thank you
Hide
Permalink
Michel Pawlak added a comment -

You can find some information here :

http://eclipse-cs.sourceforge.net/extending_custom_metadata.html

However it includes no description and no ISO category. These fields could be blank until the admin specifies them.

Michel

Show
Michel Pawlak added a comment - You can find some information here : http://eclipse-cs.sourceforge.net/extending_custom_metadata.html However it includes no description and no ISO category. These fields could be blank until the admin specifies them. Michel
Hide
Permalink
Freddy Mallet added a comment -

Michel, we've made a mistake by associating this ticket to version 1.5 as we haven't investigated it so much. Sorry for that !

Show
Freddy Mallet added a comment - Michel, we've made a mistake by associating this ticket to version 1.5 as we haven't investigated it so much. Sorry for that !
Hide
Permalink
Henri Gomez added a comment -

For now we can define custom rules by defining sonar.rules.extensionsPath in sonar.properties, ie

sonar.rules.extensionsPath: /var/sonar/extensions.

For example a PMD XXX, will be installed under rule/var/sonar/extensions/rules/pmd

We need today a description file, ie ruleXXX.xml file and the rule ruleXXX.jar.

Could it be possible, in future release, to get the ruleXXX.xml from the ruleXXX.jar so it could be possible to build the whole stuff from a simple Maven project ?

A simple jar containing all the required PMD/Checkstyle stuff will be simpler

Show
Henri Gomez added a comment - For now we can define custom rules by defining sonar.rules.extensionsPath in sonar.properties, ie sonar.rules.extensionsPath: /var/sonar/extensions. For example a PMD XXX, will be installed under rule/var/sonar/extensions/rules/pmd We need today a description file, ie ruleXXX.xml file and the rule ruleXXX.jar. Could it be possible, in future release, to get the ruleXXX.xml from the ruleXXX.jar so it could be possible to build the whole stuff from a simple Maven project ? A simple jar containing all the required PMD/Checkstyle stuff will be simpler
Hide
Permalink
Freddy Mallet added a comment -

Hi Michel, with SONAR-236 and SONAR-1766 (new possibility to instantiate several times the sames checkstyle or PMD rules) I guess this feature is no more useful, so I'm closing 'Won't fix' this ticket.
Freddy

Show
Freddy Mallet added a comment - Hi Michel, with SONAR-236 and SONAR-1766 (new possibility to instantiate several times the sames checkstyle or PMD rules) I guess this feature is no more useful, so I'm closing 'Won't fix' this ticket. Freddy

People

  • Assignee:
    Unassigned
    Reporter:
    Michel Pawlak
Vote (1)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: