...
Managing Existing Violations
When going through the source code, Sonar in Eclipse will highlight to you the existing violations. The idea is that once you have read the code and understood it, the cost of fixing a violation is low.
Fixing a Violation
Go through the Violations view Violations view that displays the list of violations of the selected resource (project, file, etc.):
A double-click on a violation opens the source code editor and highlights the violation:
Once a violation has been fixed, you can simply delete it by clicking on the violation icon and then by selecting the Delete violation item. Deleting a violation also removes it from the Violations viewthe Violations view:
Creating a Review (Remote)
If, for any reason you are not going to fix a violation right away but you think it should be resolved, you can create a review on it.
...
It is possible to create custom queries to display reviews in the Task List view:
From there, double-clicking on a review open the detail of that review:
...
| Note | ||
|---|---|---|
| ||
This Mylyn extension has currently the following limitations that should be quickly fixed:
|
Checking Code Prior to Commit
...
| Info |
|---|
Note that this feature requires Sonar Eclipse 3.1+ and Sonar 3.5+ |
Sonar in Eclipse provides the ability to show the quality of this changed/modified code prior to committing back pushing it to the SCM.
| Note | ||
|---|---|---|
| ||
This use case is currently not fully supported since Sonar Eclipse does not provide a differential mode yet. It is therefore not possible to differentiate what defect was there before from what has been added by the changes. |
Running Local Analysis (Local)
By default Sonar Eclipse takes care to automatically collect information from the Sonar Web server and decorates the source code on-the-fly (remote mode). This default mode is pretty useful as it does not consume any CPU or memory on the developer's computer while quickly displaying valuable quality information as soon as a new source file is opened.
But if lots of source code has been modified locally, quality information available remotely might be quite desynchronized after a while. In that case, a local analysis can be run before committing any changes to the source code repository and with the same quality profile used to analyze the project remotely.
To run a local analysis, switch to the local mode. As soon as this mode is selected a local analysis is launched to update the Violations and Measures views.
Later, at any time, you can run a new local analysis by choosing Sonar => Run Local Analysis.
| Note | ||
|---|---|---|
| ||
Even in local mode, the Hotspots and Web views still display remote data. |
After running a local analysis, if new violations have been introduced (comparison made against the last analysis on the Sonar server), Eclipse will clearly highlight them: the Sonar icon is red and the line is highlighted. Morevoer, every new violation is considered by default as an error. This means that you won't miss them as Eclipse Package/Resource explorer will clearly show that your project has problems:
