Apache

Docs Plugins

PMD Plugin 3.28.0 · Other versions

A Maven plugin for the PMD toolkit, that produces a report on both code rule violations and detected copy and paste fragments, as well as being able to fail the build based on these metrics.

Source
Edit this page
Wrong?
Report a problem

Finding duplicated code in C#

By default, the maven-pmd-plugin only supports the languages Java, JavaScript and JSP. But CPD supports many more languages, e.g. C#. In order to enable C# in your build, you need to configure several parts:

  • Add an additional plugin dependency for c# (pmd-cs module)
  • Select the language cs.
  • Configure the includes filter to consider *.cs (otherwise only java files will be analyzed)
  • Configure the source directory (by default, only src/main/java is analyzed)
    <project>
      ...
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.28.0</version>
            <configuration>
              <language>cs</language>
              <minimumTokens>10</minimumTokens>
              <includes>
                <include>**/*.cs</include>
              </includes>
              <compileSourceRoots>
                <compileSourceRoot>${basedir}/src/main/cs</compileSourceRoot>
              </compileSourceRoots>
              <printFailingErrors>true</printFailingErrors>
            </configuration>
            <executions>
              <execution>
                <goals>
                  <goal>cpd-check</goal>
                </goals>
              </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>net.sourceforge.pmd</groupId>
                    <artifactId>pmd-cs</artifactId>
                    <version>7.17.0</version>
                </dependency>
            </dependencies>
          </plugin>
          ...
        </plugins>
      </build>
    </project>

    In this example, the C# source files are located in src/main/cs.

    Note: The version for net.sourceforge.pmd:pmd-cs needs to match the PMD version. If you upgrade PMD at runtime, you need to change the version here as well.