Live example If you want to see a live example of the capabilities of the JavaScript plugin, you can have a look at the analysis of the jQuery project on Nemo.

Description / Features

The plugin enables analysis of JavaScript projects within Sonar.

It is compatible with the Issues Report plugin to run pre-commit local analysis.

Installation

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

Usage

Run a Sonar Analysis with the Sonar Runner (Recommended Way)

To launch a Sonar analysis of your JavaScript project, use the Sonar Runner.

A sample project is available on GitHub that can be browsed or downloaded: /projects/languages/javascript/javascript-sonar-runner.

Run a Sonar Analysis with the other Analyzers

Maven and Ant can also be used to launch analysis on JavaScript projects.

Unit Tests and Code Coverage Reports

Reports from JsTestDriver can be imported into Sonar.

A sample project is available on Github (can be browsed or downloaded): this is a JavaScript project analyzed with the Sonar Runner reusing unit tests and code coverage reports generated with JsTestDriver. It is located in /projects/languages/javascript/javascript-sonar-runner-JsTestDriver.

Metrics

See Metrics documentation page.

Extending Coding Rules using XPath

New coding rules can be added using XPath. See the related documentation.

To navigate the AST, download the SSLR JavaScript Toolkit.

Change Log

Version 1.4 (unreleased) (8 issues)
Type	Key	Summary	Priority	Status
	SONARPLUGINS-2764	The rule "Do not use more than one 'break' or 'continue' statement in loops" should feed the rule_failures.cost column		Open
	SONARPLUGINS-2776	Rule S00100 : Function name must comply with a naming convention		Open
	SONARPLUGINS-2780	Rule S00109: Magic number should not be spreaded everywhere in the source code		Open
	SONARPLUGINS-2787	Allow to specify absolute path as a value for property "sonar.javascript.jstestdriver.reportsPath"		Open
	SONARPLUGINS-2822	XPath rule should not lead to NPE, when parse error happens		Resolved
	SONARPLUGINS-2843	BoundOrAssignedEvalOrArgumentsCheck fires on equality expressions		Open
	SONARPLUGINS-2849	Ability to plug some custom rules bases on a new strongly typed AST		Open
	SONARPLUGINS-2844	Lcov parsing should handle dots		Open

Version 1.3 (20 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2590	Parser should comply with ECMAScript Rules of Automatic Semicolon Insertion
	SONARPLUGINS-2666	By default files not ending with ".js" should not be taken into account
	SONARPLUGINS-2628	Upgrade to SSLR 1.18
	SONARPLUGINS-1805	Rule: Avoid definition of functions inside loops
	SONARPLUGINS-2736	Rule: Avoid named function expressions
	SONARPLUGINS-2507	Rule: Avoid unused variables
	SONARPLUGINS-2743	Update the SQALE mapping for new rules
	SONARPLUGINS-1810	Rule: Avoid variable shadowing
	SONARPLUGINS-2745	Merge the 'JavaScript', 'JSTest' and 'JSTestDriver' Settings categories into only one 'JavaScript category'
	SONARPLUGINS-2675	Improve parsing of LCOV
	SONARPLUGINS-2695	LCOV branch support
	SONARPLUGINS-2750	Merge 'sonar.javascript.jstestdriver.coveragefile' and 'sonar.javascript.jstest.coveragefile' into 'sonar.javascript.lcov.reportPath'
	SONARPLUGINS-2747	Remove use of the 'sonar.javascript.testframework' property
	SONARPLUGINS-2751	Rename 'sonar.javascript.jstestdriver.reportsfolder' into 'sonar.javascript.jstestdriver.reportsPath'
	SONARPLUGINS-2749	Rename 'sonar.javascript.jstest.reportsfolder' into 'sonar.javascript.jstest.reportsPath'
	SONARPLUGINS-2535	Rule: Avoid unused function argument
	SONARPLUGINS-2744	Remove the ability to launch JSTest execution directly from the Sonar Javascript plugin
	SONARPLUGINS-2501	Rule: Do not use more than one "break" or "continue" statement in loops
	SONARPLUGINS-2542	Rule: Declare variables before usage
	SONARPLUGINS-2463	False positive in Rule: "For-in statement must filter items"

Version 1.2 (33 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2545	Rule: Avoid redeclaration of functions
	SONARPLUGINS-2546	Rule: Avoid usage of the same name for the declarations of both a function and a variable
	SONARPLUGINS-2538	Rule: Use Javascript strict mode with caution
	SONARPLUGINS-2536	Rule: Avoid trailing whitespaces
	SONARPLUGINS-2537	Rule: Newline at the end of file
	SONARPLUGINS-2533	Rule: Avoid redeclaration of variables
	SONARPLUGINS-2532	Rule: "eval" and "arguments" must not be bound or assigned
	SONARPLUGINS-2530	Rule: Do not use octal numbers
	SONARPLUGINS-2527	Rule: Function argument names should be unique
	SONARPLUGINS-2526	Rule: Duplicate property names not allowed in object literals
	SONARPLUGINS-2529	Rule: Do not use additional "future reserved words" as identifiers
	SONARPLUGINS-2519	Parser: Regular expression can contain empty class
	SONARPLUGINS-2518	Parser: Incorrect definition of grammar rule identifier
	SONARPLUGINS-2517	Parser: "future reserved words" can be used as identifiers in non-strict code
	SONARPLUGINS-2516	Parser: incorrect definition of grammar rule identifierName
	SONARPLUGINS-2515	Update the SQALE mapping for new rules
	SONARPLUGINS-2514	Rule: Do not use Internet Explorer's conditional comments
	SONARPLUGINS-2513	Misleading position of violation for rule AlwaysUseCurlyBraces
	SONARPLUGINS-2511	Empty violation message in LabelPlacementCheck
	SONARPLUGINS-2512	Rule: Avoid trailing comment
	SONARPLUGINS-2506	Rule: Avoid use of constructor functions for side-effects
	SONARPLUGINS-2503	Rule: Collapsible If statements
	SONARPLUGINS-2502	Rule: Avoid use of tabulation character
	SONARPLUGINS-2500	Rule: Avoid empty block
	SONARPLUGINS-2498	Rule: If ... else if constructs shall be terminated with an else clause
	SONARPLUGINS-2497	Rule: Avoid function with too many parameters
	SONARPLUGINS-2551	Incorrect computation of metrics in case of anonymous functions on same line
	SONARPLUGINS-2289	Parsing javascript running under linux
	SONARPLUGINS-2352	Use lexerless parser
	SONARPLUGINS-2524	The Coverage/Unit Tests widget should not be displayed by default on Javascript projects
	SONARPLUGINS-2520	Update properties descriptions
	SONARPLUGINS-2464	An unconditional break statement shall terminate every non-empty case-clause except latest
	SONARPLUGINS-2307	Incorrect complexity computation

Version 1.1 (20 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2047	Upgrade to SSLR 1.14
	SONARPLUGINS-2045	When a JavaScript file starts with the BOM(Byte Order Mark) character, the source code can't be parsed
	SONARPLUGINS-2043	The Javascript analyser doesn't support the HTML comment embedded into the javascript source code
	SONARPLUGINS-2079	Rule AlwaysUseCurlyBracesCheck should not produce false-positive in case of 'if-else-if'
	SONARPLUGINS-1957	Compound and labelled statements should not be included into metric 'statements'
	SONARPLUGINS-1955	Improve performance of parser by refactoring of grammar
	SONARPLUGINS-1951	Follow best-practice: replace NOK by Non-Compliant and OK by Compliant in descriptions of rules
	SONARPLUGINS-1949	Unable to lex regular expression literal which contains "/"
	SONARPLUGINS-2183	Make the Javascript plugin support the Developer Cockpit plugin by providing the measures comments and loc by line
	SONARPLUGINS-2235	Rule: Avoid switch without default clause
	SONARPLUGINS-2213	Prevent conflicts in l10n of description for JavaScript rules
	SONARPLUGINS-2208	Embed the sonar-common-rules library
	SONARPLUGINS-2200	Misleading position of violation for rule AlwaysUseCurlyBraces
	SONARPLUGINS-2197	Remove metric comment_blank_lines
	SONARPLUGINS-2292	Rule CommentedCode should not produce false-positive in JSDoc comments
	SONARPLUGINS-2290	Rule: Do not use HTML comments, because they are not part of EcmaScript specification
	SONARPLUGINS-2282	Rule: Avoid using 'continue' branching statement
	SONARPLUGINS-2249	Provide new version of sslr-javascript-toolkit instead of javascript-devkit
	SONARPLUGINS-2236	Rule: An unconditional break statement shall terminate every non-empty switch-clause
	SONARPLUGINS-2178	Rule NestedIfDepthCheck should not produce false-positive in case of 'if-else-if'

Version 1.0 (36 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1842	Rule: Avoid use of parentheses where not required by syntax or semantics
	SONARPLUGINS-1841	Rule: Detect conditional operators
	SONARPLUGINS-1840	Rule: "UnreachableCore" - return, break, continue, or throw statements should be followed by a } or case or default.
	SONARPLUGINS-1829	Do not use jslint4java
	SONARPLUGINS-1828	Rule: Avoid trailing comma in array and object literals
	SONARPLUGINS-1826	Rule: Avoid doing assignments in the condition part of if/while/for statements
	SONARPLUGINS-1827	Rule: Only while/do/for statements can be labelled
	SONARPLUGINS-1823	Rule: Use single quote for string literals
	SONARPLUGINS-1822	Rule: Do not allow function declarations within blocks
	SONARPLUGINS-1820	Rule: Do not use wrapper objects for primitive types
	SONARPLUGINS-1817	Rule: Do not use Array and Object constructors
	SONARPLUGINS-1816	Rule: Avoid multiline string literals
	SONARPLUGINS-1819	Rule: For-in statement must filter items
	SONARPLUGINS-1818	Rule: Avoid usage of bitwise operators
	SONARPLUGINS-1814	Rule: Each statement must end with a semicolon
	SONARPLUGINS-1815	Rule: Always use curly braces for if/else/for/while/do statements
	SONARPLUGINS-1813	Rule: Avoid usage of with statement
	SONARPLUGINS-1812	Rule: One statement per line
	SONARPLUGINS-1811	Rule: Regular expression on comment
	SONARPLUGINS-1808	Rule: Avoid usage of == and !=
	SONARPLUGINS-1806	Rule: Avoid usage of eval
	SONARPLUGINS-1809	Rule: Line too long
	SONARPLUGINS-1807	Rule: Avoid usage of debugger statement
	SONARPLUGINS-1799	Rule: Avoid too complex function
	SONARPLUGINS-1855	Rule: Avoid deeply nested if statements
	SONARPLUGINS-1703	Problem in the calculation of cyclomatic complexity
	SONARPLUGINS-1702	Support for JsTest unit test execution and code coverage reports should be added
	SONARPLUGINS-1794	Rule: When there is a parsing error, this error should be added like a violation on that JavaScript file
	SONARPLUGINS-1795	Rule: Detect commented-out lines of code
	SONARPLUGINS-1790	Metric: blank comments
	SONARPLUGINS-1792	Provide "Sonar Way" profile for JavaScript
	SONARPLUGINS-1791	Metric: statements
	SONARPLUGINS-1793	Rule: Generic JavaScript rule to define some homemade checks with an XPath expression
	SONARPLUGINS-1789	Integrate JavaScript parser based on SSLR
	SONARPLUGINS-1788	Provide JavaScript rule engine based on SSLR
	SONARPLUGINS-1796	Provide a default SQALE mapping for the JavaScript rules

Version 0.4 (5 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1625	NullPointer on loading test file
	SONARPLUGINS-1587	Support of JsTestDriver unit test execution and code coverage reports should be added
	SONARPLUGINS-1139	Cannot define multiple predefined variables
	SONARPLUGINS-1319	Doesn't work with SCM Plugin
	SONARPLUGINS-1295	Cannot specify sonar.javascript.lslint.predef in POM

Version 0.3 (1 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1006	Migrate JavaScript plugin from code.google.com to Codehaus