You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 8, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: samples/using-existing-tslint-output/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
#Using existing tslint output example
1
+
#Using existing tslint output example
2
2
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.
3
3
4
4
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).
5
5
6
6
This sample is identical to the basic-setup sample but with reuse of tslint output.
7
7
8
-
##Building and analysing
8
+
##Building and analysing
9
9
10
10
If you want, you can just analyse this project directly as the tslint output has already been generated. However, to rebuild fully:
11
11
@@ -16,7 +16,7 @@ To analyse with SonarQube just run ```sonar-scanner -X``` from the cloned repo f
16
16
17
17
* The -X flag will give us diagnostic information during the run, so you can see what the plugin is up to
18
18
19
-
##Breaking down the sonar-project.properties file
19
+
##Breaking down the sonar-project.properties file
20
20
21
21
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:
22
22
@@ -29,7 +29,7 @@ The sample has a ```sonar-project.properties``` file that controls how the analy
29
29
30
30
See the basic-setup example for detail on the other configured settings.
31
31
32
-
##Retionale
32
+
##Rationale
33
33
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.
34
34
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