Skip to content

Commit

Permalink
Update readme for the release
Browse files Browse the repository at this point in the history
  • Loading branch information
gretard committed Aug 8, 2018
1 parent 7561ad9 commit 3c486ac
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,25 @@ Repository for Powershell language plugin for Sonar
## Description ##
Currently plug-in supports:

- Rules by [PSScriptAnalyser](https://github.com/PowerShell/PSScriptAnalyzer)
- Reporting of issues found by [PSScriptAnalyser](https://github.com/PowerShell/PSScriptAnalyzer)
- Cyclomatic and cognitive complexity metrics (since version 0.3.0)

## Usage ##
1. Download and install SonarQube
2. Download plugin from the [releases](https://github.com/gretard/sonar-ps-plugin/releases) and copy it to sonarqube's extensions\plugins directory
3. Start SonarQube and enable rules
4. Install [PSScriptAnalyser](https://github.com/PowerShell/PSScriptAnalyzer) into your build machine where you plan to run sonar scanner


## Configuration ##

Currently there is a possibility to override the following options either on server in the Administration tab or on the project configuration files:

- **sonar.ps.tokenizer.skip** - if set to true - skips tokenizer, which might be time consuming, defaults to *false*
- **sonar.ps.file.suffixes** - allows to specify which files should be detected as Powershell files, defaults to *.ps1,.psm1,.psd1*
- **sonar.ps.tokenizer.skip** - if set to true - skips tokenizer, which might be time consuming, defaults to *false*
- **sonar.ps.file.suffixes** - allows to specify which files should be detected as Powershell files, defaults to *.ps1,.psm1,.psd1*
- **sonar.ps.executable** - allows to specify powershell executable, defaults to *powershell.exe* (since version 0.3.0)
- **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)

## Requirements ##
Different plugin versions supports the following:

- 0.3.0 - Sonarqube version 6.3+ and PSScriptAnalyser version 1.17.1 rules
- 0.2.2 - Sonarqube 5.6+ version and PSScriptAnalyser version 1.17.1 rules

0 comments on commit 3c486ac

Please sign in to comment.