#hj-sonar This package is written for hujiang font-end team. By default, it set the sonar server url in the package. If some others want to use this package, please set some options as described in this document. ##setup

npm install hj-sonar

if the runner needs authentication, you should put an file named "sonaruser" under cwd folder, the content of this file is JSON format. it should be as follows:

{ "userName": "****", "password": "*****" }

##options

• projectName

  the name of the project which you want to run in sonar.

• projectKey

  the key of the project which you want to run in sonar, this is unique in sonar.

• projectVersion

  the version of the project which you want to run in sonar.

• sources

  An file folder contains files which will run in sonar.
  Note: the path should be an relative path which relate with the cwd.

• langugae

  this option is optional, the meaning is same as langugae option in sonnar-runner, default value is javascript.

• host

  a value discribe the host of sonnar server.

• url

  the sonar server's URL.

• sourceEncoding

  The encoding of the files.

• jdbc

  this option is config for database, please see the documentation in sonnar-runner.