This is the plugin for the SonarQube platform which provides static analysis of JavaScript code. It will allow you to produce stable and easily supported code by helping you find and correct bugs, vulnerabilities and smells in your code.
- 140+ rules (including 40+ bug detection)
- ES2015 support
- Metrics (complexity, number of lines etc.)
- Import of test coverage reports
- Custom rules
To provide feedback (request a feature, report a bug etc.) use the SonarQube Google Group. Please do not forget to specify the language (JavaScript!), plugin version and SonarQube version.
If you have a question on how to use plugin (and the docs don't help you) direct it to StackOverflow tagged both sonarqube and javascript.
To request a new feature, please create a new thread in SonarQube Google Group. Even if you plan to implement it yourself and submit it back to the community, please start a new thread first to be sure that we can use it.
To submit a contribution, create a pull request for this repository. Please make sure that 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=5.2
orchestrator.updateCenterUrl=http://update.sonarsource.org/update-center-dev.properties
The "Plugin Test" is an additional integration test which verifies plugin features such as metric calculation, coverage etc. To launch it:
mvn clean install -Pit-plugin
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 run the test, first make sure the submodules are checked out:
git submodule init
git submodule update
- 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/