net.sourceforge.pmd.cpd.CpdLanguageProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-core Show documentation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available. Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

There is a newer version: 7.5.0-metrics

Show newest version

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.cpd;

import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyFactory;

/**
 * These are language properties common to multiple {@link CpdCapableLanguage}s.
 *
 * @see net.sourceforge.pmd.lang.LanguagePropertyBundle
 */
public final class CpdLanguageProperties {
    private CpdLanguageProperties() {
        // utility class
    }

    public static final PropertyDescriptor CPD_IGNORE_LITERAL_SEQUENCES =
        PropertyFactory.booleanProperty("cpdIgnoreLiteralSequences")
                       .defaultValue(false)
                       .desc("Ignore sequences of literals, eg `0, 0, 0, 0`")
                       .build();
    public static final PropertyDescriptor CPD_IGNORE_LITERAL_AND_IDENTIFIER_SEQUENCES =
        PropertyFactory.booleanProperty("cpdIgnoreLiteralAndIdentifierSequences")
                       .defaultValue(false)
                       .desc("Ignore sequences of literals and identifiers, eg `a, b, 0, 0`")
                       .build();
    public static final PropertyDescriptor CPD_ANONYMIZE_LITERALS =
        PropertyFactory.booleanProperty("cpdAnonymizeLiterals")
                       .defaultValue(false)
                       .desc("Anonymize literals. They are still part of the token stream but all literals appear to have the same value.")
                       .build();
    public static final PropertyDescriptor CPD_ANONYMIZE_IDENTIFIERS =
        PropertyFactory.booleanProperty("cpdAnonymizeIdentifiers")
                       .defaultValue(false)
                       .desc("Anonymize identifiers. They are still part of the token stream but all identifiers appear to have the same value.")
                       .build();
    public static final PropertyDescriptor CPD_IGNORE_IMPORTS =
        PropertyFactory.booleanProperty("cpdIgnoreImports")
                       .defaultValue(true)
                       .desc("Ignore import statements and equivalent (eg using statements in C#).")
                       .build();
    public static final PropertyDescriptor CPD_IGNORE_METADATA =
        PropertyFactory.booleanProperty("cpdIgnoreMetadata")
                       .defaultValue(false)
                       .desc("Ignore metadata such as Java annotations or C# attributes.")
                       .build();
}