Skip to end of metadata
Go to start of metadata

Description / Features

The Issues Report plugin provides the ability to run local Sonar analyses. The main use case is for a developer to check his/her code before pushing it to the SCM.

It generates an HTML report that displays a list of violations that can be filtered by severity, new violations only, etc.

It supports all languages.

Here's an example of HTML report that you can download:

Sonar Eclipse Plugin
Note that to perform local analyses, a Sonar Eclipse plugin is also available. It currently supports Java, C/C++ and Python.

Installation

  1. Install the Issues Report plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory
  2. Restart the Sonar server

Usage

Note that you do not need to install any local Sonar server and database.

Just run a Sonar analysis on your project with your favorite analyzer (Sonar Runner, Maven or Ant). To run the analysis locally (without making the results available on the remote Sonar server), just set the 'sonar.dryRun' property to 'true' and make sure that the 'sonar.host.url' is properly set to match your remote Sonar server.

To get a local report:

  • To generate an HTML report, set the property 'sonar.issuesReport.html.enable' to 'true'
  • To set the location of this report, set the property 'sonar.issuesReport.html.location' (default is '.sonar/issues-report.html' for the Sonar Runner and Ant, 'target/sonar/issues-report.html ' for Maven)
  • To display a short report in the console, set the 'sonar.issuesReport.console.enable' to 'true':


A useful feature is to limit the scope of the analysis to the files that have been created or modified. To do so, the 'sonar.inclusions' property can be set.

In the following example, Sonar will only check the 'myProgram.cbl' Cobol program and ignore the other programs of the application. The analysis will be local: nothing will be pushed to the database, thus the results will not be available through the Sonar server web interface. An HTML report will be generated to display the list of violations on the 'myCobolProgram.cbl' file:

 

Multi-module project compatibility
Note that the Issues Report plugin is not yet compatible with multi-module projects. See https://jira.codehaus.org/browse/SONARPLUGINS-2805.

 

Change Log

Version 1.0 (4 issues)
Type Key Summary Priority
Improvement SONARPLUGINS-2697 Support generation of a synthetic report directly into the console with help of the "sonar.issuesReport.console.enable=true" property Major
Improvement SONARPLUGINS-2694 Reuse the encoding used to parse source code in order to generate the HTML report Major
New Feature SONARPLUGINS-2684 The Violation Report should generate a report only on demand Major
New Feature SONARPLUGINS-2683 Support the generation of an HTML report Major

Labels
  • None