Skip to content
This repository was archived by the owner on Jul 8, 2019. It is now read-only.

Commit 6243356

Browse files
authored
Update README.md
1 parent 11fc92f commit 6243356

File tree

1 file changed

+5
-5
lines changed
  • samples/using-existing-tslint-output

1 file changed

+5
-5
lines changed

samples/using-existing-tslint-output/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
#Using existing tslint output example
1+
# Using existing tslint output example
22
This sample project can be analysed by SonarQube to demonstrate re-using the output of a build-step ```tslint``` pass, instead of having the plugin perform the analysis itself.
33

44
You can see a live example of the results of analysing this project at [https://sonar.pablissimo.com](https://sonar.pablissimo.com/dashboard?id=com.pablissimo.sonar%3Ausing-existing-tslint-output).
55

66
This sample is identical to the basic-setup sample but with reuse of tslint output.
77

8-
##Building and analysing
8+
## Building and analysing
99

1010
If you want, you can just analyse this project directly as the tslint output has already been generated. However, to rebuild fully:
1111

@@ -16,7 +16,7 @@ To analyse with SonarQube just run ```sonar-scanner -X``` from the cloned repo f
1616

1717
* The -X flag will give us diagnostic information during the run, so you can see what the plugin is up to
1818

19-
##Breaking down the sonar-project.properties file
19+
## Breaking down the sonar-project.properties file
2020

2121
The sample has a ```sonar-project.properties``` file that controls how the analysis gets run. This file differs from the basic-setup example only in one interesting respect:
2222

@@ -29,7 +29,7 @@ The sample has a ```sonar-project.properties``` file that controls how the analy
2929

3030
See the basic-setup example for detail on the other configured settings.
3131

32-
##Retionale
32+
## Rationale
3333
It's possible that your CI build already performs a ```tslint``` path, since a tslint failure might be considered important enough to break your build (or at least otherwise report on). Since a ```tslint``` path on a large project can take a while, the ```sonar.ts.tslint.outputPath``` setting can be set to reuse the output of the CI call to ```tslint```, reducing the time it takes to perform analysis.
3434

35-
It also allows you to call ```tslint``` with parameters or configuration that the plugin may not easily handle, or otherwise filter or transform the ```tslint``` output before it gets consumed by the plugin.
35+
It also allows you to call ```tslint``` with parameters or configuration that the plugin may not easily handle, or otherwise filter or transform the ```tslint``` output before it gets consumed by the plugin.

0 commit comments

Comments
 (0)