Skip to content

Commit 873ebcf

Browse files
committed
Be specific on the supported SQ versions
1 parent d5bac83 commit 873ebcf

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,48 @@
55

66
## SonarQube plugin for Rust (Community)
77

8-
The plugin enables analysis of Rust language within [SonarQube](https://www.sonarqube.org), which is an open platform to manage code quality.
9-
It is compatible with SonarQube 7.9 and above.
8+
The plugin enables analysis of Rust language within [SonarQube](https://www.sonarqube.org), which is an open platform to
9+
manage code quality. It is compatible with SonarQube 8.9 and above (Latest tested SonarQube version is v9.7)
1010

11-
It leverages [Clippy lints](https://rust-lang.github.io/rust-clippy/master/) to raise issues against coding rules, [LCOV](https://wiki.documentfoundation.org/Development/Lcov) or [Cobertura](http://cobertura.github.io/cobertura/) for code coverage.
11+
It leverages [Clippy lints](https://rust-lang.github.io/rust-clippy/master/) to raise issues against coding
12+
rules, [LCOV](https://wiki.documentfoundation.org/Development/Lcov)
13+
or [Cobertura](http://cobertura.github.io/cobertura/) for code coverage.
1214

1315
### How ?
1416

1517
#### tl;dr
1618

1719
* Generate a Clippy report
18-
20+
1921
`cargo clippy --message-format=json &> <CLIPPY REPORT FILE>`
22+
2023
* Import it into SonarQube
21-
24+
2225
set analysis parameter `community.rust.clippy.reportPaths=<CLIPPY REPORT FILE>`
2326

2427
* Optionally import tests measures (`junit` report)
2528

2629
use `community.rust.test.reportPath`
2730

28-
* Optionally import coverage measures
31+
* Optionally import coverage measures
2932

30-
use either
33+
use either
3134

32-
`community.rust.lcov.reportPaths`
35+
`community.rust.lcov.reportPaths`
3336

34-
or
37+
or
3538

3639
`community.rust.cobertura.reportPaths`
3740

38-
3941
For more details, you may want to read :
42+
4043
* The [documentation](./DOC.md)
4144
* The [FAQ page](./FAQ.md)
4245

4346
***
44-
*This plugin is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.*
47+
*This plugin is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
48+
License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later
49+
version.*
4550

4651
Your contribution and/or user feedback is welcomed
4752

0 commit comments

Comments
 (0)