Sonar

Tasks

• npm run site <url> will analyze the website with the current configuration and using the latest build available in the dist directory.
• npm run site -- --debug <url> same as above, but will show all the debug information.
• npm run lint will lint the code.
• npm run watch will start watchmode. This is the recommended task to run in the background while developing. It does the following:
  • sync all the resources from src to dist (basically anything that is not a .ts file).
  • compile the typescript files incrementally to dist.
  • run all the tests incrementally.
• npm run build will do the same as the watch task but only once and without running the tests.
• npm test will run the tests with code coverage using the code available in dist. It is better to run this task after build.

The initialization of the watch task is a bit especial: it will compile and copy the assets before starting to watch for new files to copy, build, or test. Because of concurrency, it might be that the tests are run twice initially.

Documentation

Developer guides

Collectors

• How to develop a collector
• List of events emitted by a collector

Formatters

• How to develop a formatter

Rules

• How to develop a rule
• How to test a rule

User guides

• Getting started

  • Collectors
  • Formatters
  • Rules

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating in this project you agree to abide by its terms.

License

The code is available under the Apache 2.0 license.