|
5 | 5 |
|
6 | 6 | ## SonarQube plugin for Rust (Community)
|
7 | 7 |
|
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) |
10 | 10 |
|
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. |
12 | 14 |
|
13 | 15 | ### How ?
|
14 | 16 |
|
15 | 17 | #### tl;dr
|
16 | 18 |
|
17 | 19 | * Generate a Clippy report
|
18 |
| - |
| 20 | + |
19 | 21 | `cargo clippy --message-format=json &> <CLIPPY REPORT FILE>`
|
| 22 | + |
20 | 23 | * Import it into SonarQube
|
21 |
| - |
| 24 | + |
22 | 25 | set analysis parameter `community.rust.clippy.reportPaths=<CLIPPY REPORT FILE>`
|
23 | 26 |
|
24 | 27 | * Optionally import tests measures (`junit` report)
|
25 | 28 |
|
26 | 29 | use `community.rust.test.reportPath`
|
27 | 30 |
|
28 |
| -* Optionally import coverage measures |
| 31 | +* Optionally import coverage measures |
29 | 32 |
|
30 |
| -use either |
| 33 | +use either |
31 | 34 |
|
32 |
| -`community.rust.lcov.reportPaths` |
| 35 | +`community.rust.lcov.reportPaths` |
33 | 36 |
|
34 |
| -or |
| 37 | +or |
35 | 38 |
|
36 | 39 | `community.rust.cobertura.reportPaths`
|
37 | 40 |
|
38 |
| - |
39 | 41 | For more details, you may want to read :
|
| 42 | + |
40 | 43 | * The [documentation](./DOC.md)
|
41 | 44 | * The [FAQ page](./FAQ.md)
|
42 | 45 |
|
43 | 46 | ***
|
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.* |
45 | 50 |
|
46 | 51 | Your contribution and/or user feedback is welcomed
|
47 | 52 |
|
|
0 commit comments