Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbt/sbt-cpd
Copy & Paste Detector plugin using PMD for sbt.
https://github.com/sbt/sbt-cpd
cpd pmd sbt sbt-plugin scala static-analysis
Last synced: 11 days ago
JSON representation
Copy & Paste Detector plugin using PMD for sbt.
- Host: GitHub
- URL: https://github.com/sbt/sbt-cpd
- Owner: sbt
- License: epl-1.0
- Created: 2013-10-20T08:15:02.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2021-07-02T08:54:03.000Z (over 3 years ago)
- Last Synced: 2024-10-27T01:01:39.973Z (24 days ago)
- Topics: cpd, pmd, sbt, sbt-plugin, scala, static-analysis
- Language: Scala
- Homepage:
- Size: 126 KB
- Stars: 48
- Watchers: 12
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-sbt-plugins - cpd4sbt - Integrating PMD's Copy/Paste Detector into SBT as a plug-in. (TEST & QA)
README
# sbt-cpd - Copy & Paste Detection using PMD/CPD for sbt
[](https://travis-ci.org/sbt/sbt-cpd)
[](https://www.codacy.com/app/stringbean/sbt-cpd)
[](https://bintray.com/stringbean/sbt-plugins/sbt-cpd)
[](https://bintray.com/stringbean/sbt-plugins/sbt-cpd)
This is an [sbt](http://scala-sbt.org/) plugin for duplicate code detection using
[Copy/Paste Detector](https://pmd.github.io/latest/usage/cpd-usage.html) (CPD) from the [PMD](https://pmd.github.io)
project.
Install the plugin by adding the following to `project/plugins.sbt`:
```scala
addSbtPlugin("com.github.sbt" % "sbt-cpd" % "")
```
And then execute the plugin with `sbt cpd`. This will scan your source code under `src/main/scala` and output a report
containing the duplicates to `target/scala-2.xx/cpd/cpd.xml`.
## Settings
(see also the [CPD documentation](https://pmd.github.io/pmd-5.8.1/usage/cpd-usage.html))
| Key | Type | Default | Description |
| ----------------------- | ----------------- | ------------------- | ----------- |
| `cpdReportType` | `CpdReportType` | `CpdReportType.XML` | Selects the output format for the CPD report. Valid types: `XML`, `Simple`, `CSV` & `VS` |
| `cpdLanguage` | `CpdLanguage` | `CpdLanguage.Scala` | Language to analyze.1 |
| `cpdMaxMemoryInMB` | Integer | `512` | Maximum amount of memory to allow for CPD (in MB). |
| `cpdMinimumTokens` | Integer | `100` | Minimum number of tokens of potential duplicates. |
| `cpdSourceEncoding` | String | `utf-8` | Source file encoding. |
| `cpdSourceDirectories` | `Seq` (Paths) | main source path(s) | Paths of the source files to analyze. |
| `cpdOutputType` | `CpdOutputType` | `CpdOutputType.File`| Selects the output type for the CPD report.2 Valid types: `File`, `Console` |
| `cpdTargetPath` | File Path | `/cpd`| Output path for CPD reports. |
| `cpdReportName` | String (filename) | `cpd.xml` | Name of the report file to generate (under `cpdTargetPath`). |
| `cpdReportFileEncoding` | String | `utf-8` | Report file encoding. |
| `cpdSkipDuplicateFiles` | Boolean | `false` | Ignore multiple copies of files of the same name and length in comparison. |
| `cpdSkipLexicalErrors` | Boolean | `false` | Skip files which can't be tokenized due to invalid characters instead of aborting. |
| `cpdIgnoreLiterals` | Boolean | `false` | Ignore literal value differences when evaluating a duplicate block. |
| `cpdIgnoreIdentifiers` | Boolean | `false` | Ignore identifier name differences when evaluating a duplicate block. |
| `cpdIgnoreAnnotations` | Boolean | `false` | Ignore language annotations when evaluating a duplicate block. |
| `cpdFailOnDuplicates` | Boolean | `false` | Fail the build if duplicates are detected. |
1. Valid languages:
* `Scala`
* `Java`
* `C`
* `CPP`
* `CS`
* `CSharp`
* `ECMAScript`
* `Fortran`
* `Go`
* `JSP`
* `JavaScript`
* `Matlab`
* `ObjectiveC`
* `PHP`
* `PLSQ`
* `Ruby`
* `Swift`
1. If set to `CpdOutputType.Console` then `cpdTargetPath` and `cpdReportName` are ignored.
## Contributors
Many thanks to
* [corux](https://github.com/corux)
* [Jentsch](https://github.com/Jentsch)
* [Martin Mauch](https://github.com/nightscape)
* [Matic Potočnik](https://github.com/HairyFotr)
for their awesome contributions!
## License
This program and the accompanying materials are made available under the terms of the **Eclipse Public License v1.0**
which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html