If you want to see a live example of the capabilities of the Web plugin, you can have a look at the analysis of the Shopizer project on Nemo.
Description / Features
The plugin provides static code analysis of web files within Sonar. Currently JSP and JSF are supported. Some initial support is provided for Ruby templating (erb files).
The following metrics are supported:
- sizing (files, lines of code)
- rules compliancy
The plugin scans the following files by default: .xhtml, .jspf, .jsp. The file extensions are configurable.
The plugin imports the source code in Sonar, calculates measurements and scans the code for violations, duplications and complexity. The checks are configurable in the Sonar rules repository.
- Install the Web plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory
- Restart the Sonar server
Run a Sonar Analysis with the Sonar Runner (Recommended Way)
To launch a Sonar analysis of your Web project, use the Sonar Runner.
Run a Sonar Analysis with the other Analyzers
The following properties of the plugin are configurable:
Rules & Metrics
There are about 20 checks in the library. Please read the documentation of the checks on the page Web Rules Library.
The ruleset is inspired on the following standards and guidelines:
A complete explanation of the available checks is given here .
Complexity of the web page is measured by counting the decision tags (such as if and forEach) and boolean operators in expressions ("&&" and "||"), plus one for the body of the document. It is a measure of the minimum number possible paths to render the page.
The decision tags and the operators are configurable. For details see rules library
Duplication is counted by comparing tokens. Duplication is reported if more than a minimum amount of tokens are replicated (in the same file or another file). The default minimum tokens is set to 70.
Comments are counted by adding the lines for server side and client side comments.
The plugin uses a simple tokenizer to parse the web pages. The tokenizer is based on the sonar-channel library. The output of the tokenizer is analyzed by a set of analyzers and checks. Expressions written in the Unified Expression Language (EL) are validated with JBoss EL.
No further external tools or maven plugins are being used for analyzing the code.
- Run analysis directly from maven (without sonar)
- More support for WCAG, webrichtlijnen
- Enhanced validation of unified expressions (using JSFUnit?)
- Dependency analysis