# p3c-pmd-plus

**Repository Path**: justinjiangcode/p3c-pmd-plus

## Basic Information

- **Project Name**: p3c-pmd-plus
- **Description**: 继承自com.alibaba.p3c.p3c-pmd
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-07-06
- **Last Updated**: 2024-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 来源
https://github.com/alibaba/p3c/tree/master/p3c-pmd  

# 目的
原工程已经不再持续更新，本工程是基于原工程，用于继续维护和更新，满足项目组的需求。

# 打包
```shell
mvn clean deploy
```  

# 如何在业务工程中引入
## 在 maven 中如何引用
在maven的pom.xml中添加如下配置
```xml
</dependencies>
    ...
    <dependency>
        <groupId>com.nuoson.p3c</groupId>
        <artifactId>p3c-pmd-plus</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <scope>test</scope>
    </dependency>
    ...
</dependencies>

<build>
    <plugins>
        ...
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.21.0</version>
            <configuration>
                <rulesets>
                    <!-- 指定“规则配置”文件 -->
                    <ruleset>p3c-ruleset.xml</ruleset>
                </rulesets>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>com.nuoson.p3c</groupId>
                    <artifactId>p3c-pmd-plus</artifactId>
                    <version>0.0.1-SNAPSHOT</version>
                </dependency>
            </dependencies>
        </plugin>
        ...
<plugins>    
</build>
```    

# 如何在业务工程执行代码检查
## maven
在工程目录下执行如下命令
```shell
mvn clean pmd:check
```  

# 附件
## pmd 工具，用于查看代码对应的AST，辅助编写规则
### mac上安装
1. 下载 [pmd](https://github.com/pmd/pmd/releases/download/pmd_releases%2F6.55.0/pmd-bin-6.55.0.zip) 并解压(建议版本 -- 6.55.0)  
1. 下载 [javaFX](https://gluonhq.com/products/javafx/) 并解压(建议版本 -- 21.0.2)  
1. 配置环境变量  
    ```shell
    export JAVAFX_HOME=<pmd根目录，例如：~/javafx-sdk-21.0.2>  
    ```
1. 启动pmd  
    ```shell
    cd <pmd根目录>
    sh bin/run.sh designer
    ```
### 使用示例
![pmd示例](./docs/pmd_design.png)