how to pass a custom config to a pmd-plugin? #3007

XenoAmess · 2020-04-22T11:45:56Z

XenoAmess
Apr 22, 2020

Description:
We have a pmd plugin and we use it like

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-pmd-plugin</artifactId>
                <version>${maven-pmd-plugin.version}</version>
                <configuration>
                    <sourceEncoding>${project.build.sourceEncoding}
                    </sourceEncoding>
                    <targetJdk>${maven.compiler.target}</targetJdk>
                    <printFailingErrors>true</printFailingErrors>
                    <failurePriority>3</failurePriority>
                    <rulesets>
                        <ruleset>rulesets/java/ali-comment.xml</ruleset>
                        <ruleset>rulesets/java/ali-concurrent.xml</ruleset>
                        <ruleset>rulesets/java/ali-constant.xml</ruleset>
                        <ruleset>rulesets/java/ali-exception.xml</ruleset>
                        <ruleset>rulesets/java/ali-flowcontrol.xml</ruleset>
                        <ruleset>rulesets/java/ali-naming.xml</ruleset>
                        <ruleset>rulesets/java/ali-oop.xml</ruleset>
                        <ruleset>rulesets/java/ali-orm.xml</ruleset>
                        <ruleset>rulesets/java/ali-other.xml</ruleset>
                        <ruleset>rulesets/java/ali-set.xml</ruleset>
                    </rulesets>
                    <excludes>
                        <exclude>**/FixClassTypeResolver.java</exclude>
                    </excludes>
                </configuration>
                <executions>
                    <execution>
                        <phase>verify</phase>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>${myplugin.groupId}</groupId>
                        <artifactId>${myplugin.artifactId}</artifactId>
                        <version>[1,${myplugin.version}]</version>
                    </dependency>
                </dependencies>
            </plugin>

the plugin is myplugin above.

However, now due to some reason we want to make it somehow configurable.

we need to make the myplugin can receive a String, means its config file path, and make myplugin can read from this path.

I wonder how can we pass that string in your pmd-maven-plugin.

Thanks a lot.