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

Commit 6b5fd54

Browse files
committed
Amending readme for 0.2 breaking changes
1 parent f45aff4 commit 6b5fd54

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ SonarQube plugin for TypeScript files
1111
This is a **not even alpha-level yet** SonarQube plugin for analysing projects with TypeScript content that supports:
1212
* TsLint for code quality information
1313
* Importing LCOV files for unit test coverage information
14+
* NCLOC metric generation
1415

1516
It's unfinished in the following respects:
1617
* Plug-in code quality needs improved
17-
* No unit test coverage of the plugin
18+
* Incomplete unit test coverage of the plugin
1819
* Exceptionally little error handling
19-
* No overall code metrics like LOC, NCLOC
2020

2121
It's presented only for the interested, and the brave.
2222

23+
###Breaking change in 0.2###
24+
To more easily support changes to the rules TsLint understands, the plugin no longer generates a TsLint configuration file for you but instead you must now specify your own using the sonar.ts.tslintconfigpath configuration property (either in the web interface, or in your sonar-project.properties file).
25+
2326
##Requirements
2427
* Java 1.7+
2528
* SonarQube 4.4+ (may or may not work with others)
@@ -29,7 +32,7 @@ The plugin has so far *only been tested on Windows* and it'll be no surprise if
2932

3033
##Building
3134
* Download the source
32-
* Build with maven, *mvn install*
35+
* Build with maven, *mvn clean && mvn install*
3336

3437
##Installation
3538
* Install Node.js
@@ -39,7 +42,8 @@ The plugin has so far *only been tested on Windows* and it'll be no surprise if
3942
* Restart SonarQube server
4043
* Browse to SonarQube web interface, login as Admin, hit up Settings
4144
* Find the TypeScript tab, paste in the TsLint path
42-
* Hit the Rules tab, then the TsLint rule set, then apply it to your project - configure rules as required
45+
* Hit the Rules tab, then the TsLint rule set, then apply it to your project - alter rule activation as required
46+
* Add *sonar.ts.tslintconfigpath=tslint.json* to your sonar-project.properties file - change the path as required, relative to your properties file
4347
* If LCOV data available, add *sonar.ts.lcov.reportpath=lcov.dat* to your sonar-project.properties file (replace lcov.dat with your lcov output, will be sought relative to the sonar-project.properties file)
4448
* Run sonar-runner
4549
* TsLint rule breaches should be shown in the web view

0 commit comments

Comments
 (0)