-| sonar.ts.tslintpath | Recommended | Path to the installed copy of TsLint to use - see note below |
-| sonar.ts.tslintconfigpath | Recommended | Path to the tslint.json file that configures the rules to be used in linting - see note below |
-| sonar.ts.excludetypedefinitionfiles | Optional | Excludes .d.ts files from analysis, defaults to true |
-| sonar.ts.forceZeroCoverage | Optional | Forces code coverage percentage to zero when no report is supplied, defaults to false |
-| sonar.ts.ignoreNotFound | Optional | Don't set code coverage percentage to zero when file is not found in report, defaults to false |
-| sonar.ts.tslinttimeout | Optional | Max time to wait for TsLint to finish processing a single file (in milliseconds), defaults to 60 seconds |
-| sonar.ts.tslintrulesdir | Optional | Path to a folder containing custom TsLint rules referenced in tslint.json |
-| sonar.ts.lcov.reportpath | Optional | Path to an LCOV code-coverage report to be included in analysis |
+| sonar.ts.tslint.path | Optional | Path to the installed copy of `tslint` to use - will be automatically sought in node_modules next to the sonar-project.properties file if not specified |
+| sonar.ts.tslint.configPath | Optional | Path to the tslint.json file that configures the rules to be used in linting - will be automatically sought in the same folder as the sonar-project.properties file if not specified |
+| sonar.ts.tslint.outputPath | Optional | If your existing CI process already runs `tslint` you can have the plugin re-use its output using the `outputPath` setting. The output is expected to be in JSON form |
+| sonar.ts.excludeTypeDefinitionFiles | Optional | Excludes .d.ts files from analysis, defaults to true |
+| sonar.ts.coverage.forceZeroIfUnspecified | Optional | Forces code coverage percentage to zero for all files when no LCOV report is supplied, defaults to false |
+| sonar.ts.coverage.ignoreNotFound | Optional | Controls if a single file should be reported as 0% covered if it doesn't appear in the LCOV report, defaults to false |
+| sonar.ts.tslint.timeout | Optional | Max time to wait for `tslint` to finish processing a single file (in milliseconds), defaults to 60 seconds |
+| sonar.ts.tslint.rulesDir | Optional | Path to a folder containing custom `tslint` rules referenced in tslint.json, if any is required |
+| sonar.ts.coverage.lcovReportpath | Optional | Path to an LCOV code-coverage report to be used to calculate coverage metrics for your project |
-##TsLint installation and configuration
+## TsLint installation and configuration
By default, SonarTsPlugin will look for a version of TsLint installed locally within your project (i.e. in node_modules\tslint\bin), relative to the sonar-project.properties file. This may not be what you want, so you can set this directly via the ```sonar.ts.tslintpath``` configuration setting:
* At project level
* Globally, for all projects
-If analysis is failing, run ```sonar-runner``` with the ```-X -e``` options for more diagnostic information, including a note of where the plugin is searching for ```tslint```. Bear in mind that if running on a build server, the account running the build will need access to the path to ```tslint```.
+If analysis is failing, run ```sonar-scanner``` with the ```-X``` option for more diagnostic information, including a note of where the plugin is searching for ```tslint```. Bear in mind that if running on a build server, the account running the build will need access to the path to ```tslint```.
-By default, SonarTsPlugin will look for a TsLint configuration file called tslint.json next to the sonar-project.properties file. You can override this using the ```sonar.ts.tslintconfigpath``` configuration setting if this isn't the case for your project.
+By default, SonarTsPlugin will look for a `tslint` configuration file called tslint.json next to the sonar-project.properties file. You can override this using the ```sonar.ts.tslint.configPath``` configuration setting if this isn't the case for your project.
## TsLint Custom Rules
-To present custom TsLint rules in SonarQube analysis, you can provide a configuration that maps the TsLint rules from your `sonar.ts.tslintrulesdir`
-directory to dedicated Sonar rules for analysis.
-The configuration for a TSLint Sonar rule consists of a line declaring the TSLint rule id, a boolean switch to enable or disable the rule if needed
-and some attached properties that are used by Sonar for analysis and reporting.
+To present custom `tslint` rules in SonarQube analysis, you can provide a configuration that maps the rules from your `sonar.ts.tslint.rulesDir` directory to dedicated Sonar rules for analysis.
+
+The configuration for a `tslint` Sonar rule consists of a line declaring the TSLint rule id, a boolean switch to enable or disable the rule if needed and some attached properties that are used by Sonar for analysis and reporting.
-For example taking the `export-name` rule from the [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib) package,
-a configuration for that rule in SonarTsPlugin could look as follows:
+For example, let's take the `export-name` rule from the [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib) package. A configuration for that rule in SonarTsPlugin could look as follows:
export-name=true
export-name.name=The name of the exported module must match the filename of the source file.