Merge branch 'master' of github.com:Pablissimo/SonarTsPlugin

samples/basic-setup/README.md

@@ -1,12 +1,12 @@
-#Basic setup example
+# Basic setup example
 This sample project can be analysed by SonarQube to demonstrate:
 
 * Linting information from ```tslint```, configured via a ```tslint.json``` file
 * Code coverage metrics from an LCOV file
 
 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%3Abasic-setup).
 
-##Building and analysing
+## Building and analysing
 
 * Run ```npm install``` from the cloned repo folder
 * Run ```npm test``` to regenerate code coverage information
@@ -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. We haven't specified anything here that isn't its default or automatically detected - these are explained under the table.
 

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

@@ -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:
 
@@ -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:
 
@@ -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.