@@ -4,18 +4,25 @@ Repository for Powershell language plugin for Sonar
44## Description ##
55Currently plug-in supports:
66
7- - Rules by [ PSScriptAnalyser] ( https://github.com/PowerShell/PSScriptAnalyzer )
7+ - Reporting of issues found by [ PSScriptAnalyser] ( https://github.com/PowerShell/PSScriptAnalyzer )
8+ - Cyclomatic and cognitive complexity metrics (since version 0.3.0)
89
910## Usage ##
10111 . Download and install SonarQube
11122 . Download plugin from the [ releases] ( https://github.com/gretard/sonar-ps-plugin/releases ) and copy it to sonarqube's extensions\plugins directory
12133 . Start SonarQube and enable rules
13144 . Install [ PSScriptAnalyser] ( https://github.com/PowerShell/PSScriptAnalyzer ) into your build machine where you plan to run sonar scanner
1415
15-
1616## Configuration ##
17-
1817Currently there is a possibility to override the following options either on server in the Administration tab or on the project configuration files:
1918
20- - ** sonar.ps.tokenizer.skip** - if set to true - skips tokenizer, which might be time consuming, defaults to * false*
21- - ** sonar.ps.file.suffixes** - allows to specify which files should be detected as Powershell files, defaults to * .ps1,.psm1,.psd1*
19+ - ** sonar.ps.tokenizer.skip** - if set to true - skips tokenizer, which might be time consuming, defaults to * false*
20+ - ** sonar.ps.file.suffixes** - allows to specify which files should be detected as Powershell files, defaults to * .ps1,.psm1,.psd1*
21+ - ** sonar.ps.executable** - allows to specify powershell executable, defaults to * powershell.exe* (since version 0.3.0)
22+ - ** sonar.ps.plugin.skip** - if set to true - skips plugin in general, meaning that no sensors are run, defaults to * false* (since version 0.3.0)
23+
24+ ## Requirements ##
25+ Different plugin versions supports the following:
26+
27+ - 0.3.0 - Sonarqube version 6.3+ and PSScriptAnalyser version 1.17.1 rules
28+ - 0.2.2 - Sonarqube 5.6+ version and PSScriptAnalyser version 1.17.1 rules
0 commit comments