Description / Features
The Taglist Maven Plugin generates a report on various tags found in the code, like
//TODO tags. This Taglist Sonar plugin handles the Taglist Maven plugin to collect all occurrences of those tags and inject the information into Sonar DB.
The reporting part is done in two ways : automatic addition of rules into the rule engine and a widget that shows total number of tags found and a repartition. A split is done between mandatory and optional tags. Mandatory tags are tags that have been defined with a CRITICAL or BLOCKER priority when activating the rule, optional are the ones with MAJOR, MINOR or INFO priority.
Usage & Installation
- Stop Sonar Web server
- Place the jar into the /extensions/plugins directory
- Restart Sonar Web server
- Define the tags you want to hunt by activating the associated rules in your quality profile :
Sonar doesn't reuse any configuration possibly made manually in the pom.xml file on the Taglist Maven plugin. If you want to activate a tag detection, you must activate the associated rule in desired Sonar quality profile.
- Launch a new analysis and you'll get such kind of reports :
- If you want to add new tags to the default ones, you need to create a file "taglist.properties" in the /extensions/plugins directory. The file must be fed with the list of desired tags and their associated ISO category. Restart the Sonar web server and your tags should appear in the Quality Profile management console. Example of file :