SonarJS is a static code analyser for JavaScript language used as an extension for the SonarQube platform. It will allow you to produce stable and easily supported code by helping you to find and to correct bugs, vulnerabilities and smells in your code.
- 180+ rules (including 80+ bug detection)
- Compatible with ECMAScript 2015-2017
- React JSX and Vue single-file component .vue support
- Metrics (complexity, number of lines etc.)
- Import of test coverage reports
- Custom rules
- Project homepage
- Documentation
- Issue tracking
- Available rules
- Google Group for feedback (sonarqube@googlegroups.com)
- Demo project analysis
If you have a question on how to use analyser (and the docs don't help you) ask it on Stack Overflow with sonarjs tag.
If you want to report a bug, request a feature or provide other kind of feedback, create a GitHub issue.
To provide feedback or to report a bug for a SonarQube platform send an email to sonarqube@googlegroups.com, the SonarQube Google Group. Please do not forget to specify the details of your request, as well as analysers' and SonarQube versions.
To request a new feature, create a GitHub issue. Even if you plan to implement it yourself and submit it back to the community, please create an issue to be sure that we can follow up on it.
To submit a contribution, create a pull request for this repository. Please make sure that you follow our code style and all tests are passing (Travis build is created for each PR).
If you have an idea for a rule but you are not sure that everyone needs it you can implement a custom rule available only for you.
To run tests locally follow these instructions
To build the plugin and run its unit tests, execute this command from the project's root directory:
mvn clean install
To run integration tests, you will need to create a properties file like the one shown below, and set its location in an environment variable named ORCHESTRATOR_CONFIG_URL.
# version of SonarQube server
sonar.runtimeVersion=6.2
orchestrator.updateCenterUrl=http://update.sonarsource.org/update-center-dev.properties
Before running any of integration tests make sure the submodules are checked out:
git submodule init
git submodule update
The "Plugin Test" is an additional integration test which verifies plugin features such as metric calculation, coverage etc. To launch it, execute this command from directory its/plugin:
mvn clean install
The "Ruling Test" is a special integration test which launches the analysis of a large code base, saves the issues created by the plugin in report files, and then compares those results to the set of expected issues (stored as JSON files). To launch ruling test:
cd its/ruling
mvn clean install
This test gives you the opportunity to examine the issues created by each rule and make sure they're what you expect. You can inspect new/lost issues checking web-pages mentioned in the logs at the end of analysis:
INFO - HTML Issues Report generated: /path/to/project/sonar-javascript/its/sources/src/.sonar/issues-report/issues-report.html
INFO - Light HTML Issues Report generated: /path/to/project/sonar-javascript/its/sources/src/.sonar/issues-report/issues-report-light.html
If everything looks good to you, you can copy the file with the actual issues located at
sonar-javascript/its/ruling/target/actual/
into the directory with the expected issues
sonar-javascript/its/ruling/src/test/resources/expected/
Copyright 2011-2017 SonarSource.
Licensed under the GNU Lesser General Public License, Version 3.0