Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaschmid/gradle-cpd-plugin
Gradle plugin to find duplicate code using PMDs copy/paste detection (= CPD).
https://github.com/aaschmid/gradle-cpd-plugin
copy cpd detection gradle-cpd-plugin gradle-plugin paste
Last synced: 12 days ago
JSON representation
Gradle plugin to find duplicate code using PMDs copy/paste detection (= CPD).
- Host: GitHub
- URL: https://github.com/aaschmid/gradle-cpd-plugin
- Owner: aaschmid
- License: apache-2.0
- Created: 2014-04-13T15:57:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T20:38:46.000Z (5 months ago)
- Last Synced: 2024-10-12T11:14:10.229Z (about 1 month ago)
- Topics: copy, cpd, detection, gradle-cpd-plugin, gradle-plugin, paste
- Language: Java
- Homepage:
- Size: 654 KB
- Stars: 95
- Watchers: 6
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.TXT
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/aaschmid/gradle-cpd-plugin)
[](https://circleci.com/gh/aaschmid/gradle-cpd-plugin)
[](https://coveralls.io/github/aaschmid/gradle-cpd-plugin?branch=master)
[](https://codecov.io/gh/aaschmid/gradle-cpd-plugin)
[](https://codebeat.co/projects/github-com-aaschmid-gradle-cpd-plugin)
[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22de.aaschmid%22%20AND%20a%3A%22gradle-cpd-plugin%22)
[](https://bintray.com/aaschmid/gradle-plugins/gradle-cpd-plugin/_latestVersion)
[](https://github.com/aaschmid/gradle-cpd-plugin)
[](https://github.com/aaschmid/gradle-cpd-plugin/issues)
[](https://github.com/aaschmid/gradle-cpd-plugin/network)
[](https://github.com/aaschmid/gradle-cpd-plugin/stargazers)
Gradle CPD plugin
=================
##### Table of Contents
* [What is it](#what-is-it)
* [Requirements](#requirements)
* [Usage](#usage)
* [Options](#options)
* [Contributing](#contributing)
* [Release notes](/../../releases)
What is it
----------
A [Gradle](http://gradle.org) plugin to find duplicate code using [PMD][]s copy/paste detection (= [CPD][]). See also
https://plugins.gradle.org/plugin/de.aaschmid.cpd.
Requirements
------------
This plugin requires [PMD](https://pmd.github.io/) greater or equal to version 7.0.0 such that ```toolVersion >= '7.0.0'```.
Explanation: v7.0.0 changed the internal API, see [PMD release notes](https://pmd.github.io/pmd/pmd_release_notes_pmd7.html#-api).
You can use older versions of this plugin if you want to use older versions of PMD (see table below).
### Supported versions
| G. CPD plugin | Gradle | PMD | Java¹ |
|:--------------|:------------ |:-------------|:------ |
| [v0.1][] | 1.10 - 4.x | 5.0.0 - 5.x | 6 - 8 |
| [v0.2][] | 2.0 - 4.x | 5.0.0 - 5.x | 6 - 8 |
| [v0.4][] | 2.3 - 4.x | 5.2.0 - 5.x | 6 - 8 |
| [v1.0][] | 2.14 - 5.0 | 5.2.0 - 5.x | 6 - 8 |
| [v1.1][] | 2.14 - 5.0 | 5.2.2 - 6.x | 6 - 9 |
| [v1.2][] | >= 3.5.1 | 5.2.2 - 6.x | >= 8 |
| [v1.3][] | >= 4.10.3 | 5.2.2 - 6.x | >= 8 |
| [v2.0][] | 4.10.3 - 5.5 | 6.1.0 - 6.x | >= 8 |
| [v3.0][] | 5.6 - 5.x | 6.10.0 - 6.x | >= 8 |
| [v3.1][] | >= 5.6 | 6.10.0 - 6.x | >= 8 |
| [v3.2][] | >= 6.6 | 6.10.0 - 6.x | >= 8 |
| [v3.3][] | >= 6.6 | 6.10.0 - 6.x | >= 8 |
| [v3.4][] | >= 7.4 | >= 7.0.0 | >= 8 |
¹: Java version may additionally depend on [PMD][]s version which is might not be properly reflected here.
Usage
-----
This plugin is available using either the new [Gradle plugins DSL](https://gradle.org/docs/current/userguide/plugins.html#sec:plugins_block)
```groovy
plugins {
id 'de.aaschmid.cpd' version '3.4'
}
```
or the old fashion [buildscript block](https://gradle.org/docs/current/userguide/plugins.html#sec:applying_plugins_buildscript)
from [Maven Central](http://search.maven.org/#search|ga|1|gradle-cpd-plugin) or
[jCenter](https://bintray.com/aaschmid/gradle-plugins/gradle-cpd-plugin/view).
```groovy
buildscript {
repositories {
// choose your preferred one
mavenCentral()
jcenter()
}
dependencies {
classpath 'de.aaschmid:gradle-cpd-plugin:3.4'
}
}
apply plugin: 'de.aaschmid.cpd'
```
**Attention:** The plugin's groupId was changed from ```de.aaschmid.gradle.plugins``` to ```de.aaschmid``` in [v1.0][].
By default, the copy-paste-detection looks at all source code of all projects which at least apply ```LifecycleBasePlugin```.
If you use a different programming language and want to get it configured out of the box, please open an issue :-)
### Single module project
If you have a single module project you just need to make sure that the ```LifecycleBasePlugin``` is also applied to it
(explicitly or implicitly through e.g. Java or Groovy plugin). Otherwise, you can simply add a dependency to a task you like by
```groovy
analyze.dependsOn(cpdCheck)
```
### Multi module project
If the root project of your multi-module project applies the ```LifecycleBasePlugin```, you are done. But most likely this
is not how your project looks like. If so, you need to manually add a task graph dependency manually to either one or all
of your subprojects such that the ```cpdCheck``` task is executed:
```groovy
// one single subproject where 'LifecycleBasePlugin' is available
subprojectOne.check.dependsOn(':cpdCheck')
// all subprojects where 'check' task is available (which comes with 'LifecycleBasePlugin')
subprojects {
plugins.withType(LifecycleBasePlugin) { // <- just if 'LifecycleBasePlugin' plugin is not applied to all subprojects
check.dependsOn(rootProject.cpdCheck)
}
}
```
### Custom sourceSets
If you are adding custom sourceSets (even in subProjects), it may occur that you either need to configure `cpdCheck`
afterwards or even manually configure `source`. Unfortunately, I have had problems with this case in the
[CpdAcceptanceTest](https://github.com/aaschmid/gradle-cpd-plugin/blob/master/src/integTest/groovy/de/aaschmid/gradle/plugins/cpd/test/CpdAcceptanceTest.groovy)
tests using Gradle [TestKit](https://docs.gradle.org/current/userguide/test_kit.html).
### Examples
This example shows a project where only ```main``` sources should be checked for duplicates:
```groovy
// optional - settings for every CPD task
cpd {
language = 'cpp'
toolVersion = '7.0.0' // defaults to '7.2.0'; just available for v7.0.0 and higher (see explanation above)
}
// optional - default report is xml and default sources are 'main' and 'test'
cpdCheck {
reports {
text.enabled = true
xml.enabled = false
}
source = sourceSets.main.allJava // only java, groovy and scala classes in 'main' sourceSets
}
```
*Note:* With v0.2, I have renamed the default task from ```cpd``` to ```cpdCheck``` so that it does not have a name clash anymore.
### Property `source`
Depending on your needs, java sourcesets of all projects will be automatically added to `source` and therefore checked for duplicates (see [Code](https://github.com/aaschmid/gradle-cpd-plugin/blob/%2350.text.fixture/src/main/java/de/aaschmid/gradle/plugins/cpd/CpdPlugin.java#L79-L88)). You have a lot of options for overriding this behaviour but note that the lazy evaluation - especially later configured subprojects - could add further `sourceSets` again unless you use `[evaluationDependsOnChildren()](https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html#evaluationDependsOnChildren--)` for your `rootProject`:
```groovy
source = subprojects*.sourceSets*.main*.java*.srcDirs
```
or
```groovy
source = subprojects*.sourceSets*.main*.java*.srcDirs + subprojects*.sourceSets*.test*.java*.srcDirs
```
or
```groovy
cpdCheck {
source = []
allprojects.forEach { project ->
project.plugins.withType(JavaPlugin) { plugin ->
project.sourceSets.main.java.forEach { s -> rootProject.cpdCheck.source(s) }
}
}
}
```
or same using kotlin DSL (Note: That works only if all `subprojects` have `sourceSets` `main` and `test` e.g. by appling the `java` plugins. Otherwise, you can just filter for `JavaBasePlugin` before)
```kotlin
setSource(files(
// only check java source code
subprojects.flatMap { it.the()["main"].java.srcDirs },
subprojects.flatMap { it.the()["test"].java.srcDirs }
))
```
or if you need a new cpd task for kotlin and not all `subprojects` apply a `java` plugin (see also [here](https://github.com/aaschmid/gradle-cpd-plugin/issues/39#issuecomment-488730600))
```kotlin
tasks.register("cpdKotlin") {
language = "kotlin"
exclude { it.file.extension.contains("java") }
allprojects.forEach { project ->
project.plugins.withType {
project.convention.getPlugin().sourceSets.configureEach {
allJava.srcDirTrees.forEach { [email protected](it) }
}
}
}
}
```
### Kotlin support
[CPD][] supports [Kotlin](https://kotlinlang.org/) since
[v6.10.0](https://search.maven.org/search?q=g:net.sourceforge.pmd%20AND%20a:pmd-kotlin&core=gav). For previous versions
you have to ignore files manually if you mixed it up with your Java files:
```groovy
tasks.withType(Cpd) {
exclude "*.kt"
}
```
Options
-------
This plugin supports the following options, either set for the plugin using ```cpd { }``` or for every task explicitly,
e.g. using ```cpdCheck { }```:
| Attribute | Default | Applies for ```language``` | since |
| ------------------ |:--------------------:|:--------------------------:|:--------:|
| encoding | System default | | [v0.1][] |
| ignoreAnnotations | ```false``` | ```'java'``` | [v0.4][] |
| ignoreFailures | ```false``` | | [v0.1][] |
| ignoreIdentifiers | ```false``` | ```'java'``` | [v0.4][] |
| ignoreLiterals | ```false``` | ```'java'``` | [v0.4][] |
| language | ```'java'``` | | [v0.4][] |
| minimumTokenCount | ```50``` | | [v0.1][] |
| skipDuplicateFiles | ```false``` | | [v0.5][] |
| skipLexicalErrors | ```false``` | | [v0.5][] |
| skipBlocks | ```true``` | ```'cpp'``` | [v0.4][] |
| skipBlocksPattern | ```'#if 0\|#endif'``` | ```'cpp'``` | [v0.4][] |
If a specified `language` cannot be found, analysis fails.
For more information about options and their descriptions, see [here](https://pmd.github.io/latest/pmd_userdocs_cpd.html#attribute-reference),
and for the available programming languages have a look on [CPD documentation](https://pmd.github.io/latest/pmd_userdocs_cpd.html#supported-languages).
To request more options, please file an issue [here](/../../issues).
Additionally, one can configure the following reports for every task analogous to
[Reporting](https://gradle.org/docs/current/dsl/org.gradle.api.reporting.Reporting.html) as for any other reporting plugin. See also
the example in [Usage](#usage) section above.
| Report | Default | since | Further options and their defaults |
| ------ |:--------:| -------- | --------------------------------------------------------- |
| csv | disabled | [v0.1][] | ```separator = ','```, ```includeLineCount = true```**²** |
| text | disabled | [v0.1][] | ```lineSeparator = '====================================================================='```, ```trimLeadingCommonSourceWhitespaces = false``` |
| vs | disabled | [v3.1][] | ```encoding = <>``` |
| xml | enabled | [v0.1][] | ```encoding = <>``` |
²: Since [v3.1][] but note that property `includeLineCount` is originally named `lineCountPerFile` and meaning is inverted which means that
`false` shows line count and `true` hides it, see
[here](https://github.com/pmd/pmd/blob/master/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java#L63).
Contributing
------------
You are very welcome to contribute by providing a patch/pull request.
Please note that running the test cases my take quite long because the acceptance test cases (see
```de.aaschmid.gradle.plugins.cpd.test.CpdAcceptanceTest``` will download [CPD][] and its dependencies for every version. I recommend to
get these dependencies in your ```localMaven()``` repository as the test cases look there for it first.
[PMD]: https://pmd.github.io/
[CPD]: https://pmd.github.io/latest/pmd_userdocs_cpd.html
[v0.1]: /../../releases/tag/v0.1
[v0.2]: /../../releases/tag/v0.2
[v0.4]: /../../releases/tag/v0.4
[v0.5]: /../../releases/tag/v0.5
[v1.0]: /../../releases/tag/v1.0
[v1.1]: /../../releases/tag/v1.1
[v1.2]: /../../releases/tag/v1.2
[v1.3]: /../../releases/tag/v1.3
[v2.0]: /../../releases/tag/v2.0
[v3.0]: /../../releases/tag/v3.0
[v3.1]: /../../releases/tag/v3.1
[v3.2]: /../../releases/tag/v3.2
[v3.3]: /../../releases/tag/v3.3
[v3.4]: /../../releases/tag/v3.4