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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pablissimo committed Mar 29, 2017
1 parent 11fc92f commit 6243356
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions samples/using-existing-tslint-output/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#Using existing tslint output example
# Using existing tslint output example
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.

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).

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

##Building and analysing
## Building and analysing

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

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

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

##Breaking down the sonar-project.properties file
## Breaking down the sonar-project.properties file

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:

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

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

##Retionale
## Rationale
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.

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.
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 comments on commit 6243356

Please sign in to comment.