Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leibnizhu/sonar-pmd-p3c-jdk17
新版sonar-pmd + 新版p3c，支持jdk17
https://github.com/leibnizhu/sonar-pmd-p3c-jdk17
Last synced: 8 days ago
JSON representation
新版sonar-pmd + 新版p3c，支持jdk17
- Host: GitHub
- URL: https://github.com/leibnizhu/sonar-pmd-p3c-jdk17
- Owner: Leibnizhu
- License: lgpl-3.0
- Created: 2022-06-28T06:08:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T04:15:43.000Z (7 months ago)
- Last Synced: 2024-04-17T16:25:58.879Z (7 months ago)
- Language: Java
- Homepage:
- Size: 469 KB
- Stars: 39
- Watchers: 3
- Forks: 17
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SonarQube PMD Plugin [](https://maven-badges.herokuapp.com/maven-central/org.sonarsource.pmd/sonar-pmd-plugin) [](https://travis-ci.org/jborgers/sonar-pmd) [](https://sonarcloud.io/dashboard?id=org.sonarsource.pmd%3Asonar-pmd) [](https://sonarcloud.io/dashboard?id=org.sonarsource.pmd%3Asonar-pmd)
Sonar-PMD is a plugin that provides coding rules from [PMD](https://pmd.github.io/) for use in SonarQube.
Starting April 2022, the project has found a new home. We, [jborgers](https://github.com/jborgers) and [stokpop](https://github.com/stokpop),
aim to provide an active project and well-maintained sonar-pmd plugin. It is now sponsored by [Rabobank](https://www.rabobank.com/).
For a list of all rules and their status, see: [RULES.md](https://github.com/jborgers/sonar-pmd/blob/master/docs/RULES.md)
## Installation
The plugin should be available in the SonarQube marketplace and is preferably installed from within SonarQube (Administration --> Marketplace --> Search _pmd_).
Because of changed integration of the Java-plugin in SonarQube and our dependency on it, this plugin is temporarily not available from the Marketplace.
Hopefully this will be fixed quickly with the release of version 3.4.0.
Alternatively, download the [latest JAR file](https://github.com/jborgers/sonar-pmd/releases/latest), put it into the plugin directory (`./extensions/plugins`) and restart SonarQube.
## Usage
Usage should be straight forward:
1. Activate some PMD rules in your quality profile.
2. Run an analysis.
### Java version
Sonar-PMD analyzes the given source code with the Java source version defined in your Gradle or Maven project.
In case you are not using one of these build tools, or if that does not match the version you are using, set the `sonar.java.source` property to tell PMD which version of Java your source code complies to.
Possible values : 1.4 to 1.8/8 to 18
## Table of supported versions
| PMD Plugin |2.5|2.6|3.0.0|3.1.x|3.2.x|3.3.x| 3.4.0 |
|-----------------------------|---|---|---|---|---|---|----------------|
| PMD |5.4.0|5.4.2|5.4.2|6.9.0|6.10.0|6.30.0| 6.45.0 |
| Max. supported Java Version | 1.7 | 1.8 | 1.8 | 11 | | 15| 18 |
| Min. SonarQube Version | 4.5.4 | 4.5.4 | 6.6 | | | 6.7| _8.9(*)_ / 9.3 |
(*) Note: Plugin version 3.4.x runs in SonarQube 8.9, however, Java 17+ is only fully supported in SonarQube 9.3+.
A majority of the PMD rules have been rewritten in the Java plugin. Rewritten rules are marked "Deprecated" in the PMD plugin, but a [concise summary of replaced rules](http://dist.sonarsource.com/reports/coverage/pmd.html) is available.
## Rules on test
PMD tool provides some rules that can check the code of JUnit tests. Please note that these rules (and only these rules) will be applied only on the test files of your project.
## License
Sonar-PMD is licensed under the [GNU Lesser General Public License, Version 3.0](https://github.com/jborgers/sonar-pmd/blob/master/LICENSE.md).
Parts of the rule descriptions displayed in SonarQube have been extracted from [PMD](https://pmd.github.io/) and are licensed under a [BSD-style license](https://github.com/pmd/pmd/blob/master/LICENSE).
## Build and test the plugin
To build the plugin and run the integration tests:
./mvnw clean verify
## 关于Alibaba P3c
本repo在sonar-pmd基础上增加了alibaba-p3c规则，详细的修改包括：
1. sonar-pmd-plugin 增加依赖
```xml
com.alibaba.p3c
p3c-pmd
2.1.1
com.google.code.gson
gson
2.9.0
```
2. 修改 `/resources/org/sonar/l10n/pmd/rules/pmd.properties` ，增加 p3c 的规则。同时修改 `org.sonar.plugins.pmd.PmdRulesDefinitionTest.test` 里面对规则条数的断言，从268改实际的324。
3. 增加 `/resources/org/sonar/plugins/pmd/rules-p3c.xml`
4. 增加规则描述 html `/resources/org/sonar/l10n/pmd-p3c`
5. 修改 `/resources/com/sonar/sqale/pmd-model.xml` 增加P3c相关
6. 修改 PmdRulesDefinition.java，加入p3c规则：
```java
//org.sonar.plugins.pmd.rule.PmdRulesDefinition#define
extractRulesData(repository, "/org/sonar/plugins/pmd/rules-p3c.xml", "/org/sonar/l10n/pmd/rules/pmd-p3c");
```