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: README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,15 +11,18 @@ SonarQube plugin for TypeScript files
11
11
This is a **not even alpha-level yet** SonarQube plugin for analysing projects with TypeScript content that supports:
12
12
* TsLint for code quality information
13
13
* Importing LCOV files for unit test coverage information
14
+
* NCLOC metric generation
14
15
15
16
It's unfinished in the following respects:
16
17
* Plug-in code quality needs improved
17
-
*No unit test coverage of the plugin
18
+
*Incomplete unit test coverage of the plugin
18
19
* Exceptionally little error handling
19
-
* No overall code metrics like LOC, NCLOC
20
20
21
21
It's presented only for the interested, and the brave.
22
22
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
+
23
26
##Requirements
24
27
* Java 1.7+
25
28
* 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
29
32
30
33
##Building
31
34
* Download the source
32
-
* Build with maven, *mvn install*
35
+
* Build with maven, *mvn clean && mvn install*
33
36
34
37
##Installation
35
38
* Install Node.js
@@ -39,7 +42,8 @@ The plugin has so far *only been tested on Windows* and it'll be no surprise if
39
42
* Restart SonarQube server
40
43
* Browse to SonarQube web interface, login as Admin, hit up Settings
41
44
* 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
43
47
* 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)
44
48
* Run sonar-runner
45
49
* TsLint rule breaches should be shown in the web view
0 commit comments