cpd4sbt - Static code analysis via PMD/CPD from within SBT

This SBT plug-in enables you to analyze your code with the help of the great PMD Copy/Paste Detector tool. It defines a cpd sbt action for that purpose.

For SBT 0.13, you've basically got to add the following to your project's build.sbt file:

import de.johoop.cpd4sbt.CopyPasteDetector._

cpdSettings

Also, you have to add the plugin dependency to your project's ./project/plugins.sbt or the global .sbt/project/build.sbt:

addSbtPlugin("de.johoop" % "cpd4sbt" % "1.1.4")

The settings specified below are still mostly valid, but they're now specified using the new settings system of SBT 0.13.

Settings

(see also the CPD documentation)

cpdReportType

• Description: Selects the output format for the CPD report.
• Accepts: CPDReportType.{Simple, XML, CSV, VS}
• Default: CPDReportType.Xml

cpdOutputPath

• Description: Output path for CPD reports.
• Accepts: any sbt.Path
• Default: outputPath / "cpd"

cpdReportName

• Description: Name of the report file to generate.
• Accepts: any legal filename
• Default: "cpd.xml"

cpdLanguage

• Description: Language to analyze. - If you want Scala specifically, you still need to extend the CPD tokenizers! Otherwise, choosing Scala will default to the "AnyLanguage" tokenizer
• Accepts: Language.{Java, C, CPP, PHP, Ruby, Fortran, ECMAScript, JavaScript, JSP, Scala}
• Default: Language.Scala

cpdMaxMemoryInMB

• Description: Maximum amount of memory to allow for FindBugs (in MB).
• Accepts: any reasonable amount of memory as an integer value
• Default: 512

cpdMinimumTokens

• Description: Minimum number of tokens of potential duplicates.
• Accepts: A positive Int
• Default: 100

cpdSourceEncoding

• Description: Source file encoding.
• Accepts: String representations of valid encodings.
• Default: "utf-8"

cpdOutputEncoding

• Description: Output file encoding.
• Accepts: String representations of valid encodings.
• Default: "utf-8"

cpdSourcePaths

• Description: Paths of the source files to analyze.
• Accepts: A List of Paths
• Default: List(mainSourcePath).

cpdSkipDuplicateFiles

• Description: Ignore multiple copies of files of the same name and length in comparison.
• Accepts: Boolean
• Default: false

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