It provides ~80 rules (including ~40 bug detection), which represent the "Sonar Way" profile of the SonarJS analyzer.
As a Command Line Tool
- Install SonarJS
> npm install -g sonarjs
- Run analysis from the project directory
> cd <directory of project to analyze> > sonarjs
> sonarjs -h
for more information
- As the result you will get the list of issues found in the project. E.g.
MAJOR - S3923: /Users/path/to/foo/file.js [3, 6]: Remove this conditional structure or edit its code blocks so that they're not all the same. BLOCKER - OctalNumber: /Users/path/to/foo/file.js [3, 10]: Replace the value of the octal number (056) by its decimal equivalent (46).
- Note that some code editors (e.g. VS Code) make SonarJS output clickable and you can easily move to the referenced file and line.
- Install SonarJS in your project
> npm install sonarjs
- Import it
- Provide options to inject callbacks for
analyzefunction to collect logs and to add some behavior before and after analysis
- Provide options to exclude folders from analysis
Note that SonarJS requires a JRE, so if it's not available on your machine (Java 1.8 version) it will be downloaded during the first analysis.