PMD and Salesforce

Question

Does anyone maybe know how to disable some rules from Apex PMD, for example, I want to disable this one "ClassNamingConventions". I don't want to show me warning related to that rule in .csv file downloaded after running sfdx scanner? Thanks in advance!

Answer 1

If you want to exclude it from a particular class/method you can use the @SupressWarnings annotation. For your particular scenario it should be:

@SuppressWarnings('PMD.ClassNamingConventions')
public class Bar {
    void bar() {
        int foo;
    }
}

If you want to exclude the rule for all your codebase then you should:

1. Create a PMD ruleset xml file;
2. Add that rule as an exclusion on your pmd-ruleset.xml file. Something such as:

<rule ref="category/apex/codestyle.xml" >
    <exclude name="ClassNamingConventions"/>    
</rule>

3. Run the sfdx:scanner command including the --pmdconfig flag to point out the location of PMD rule reference XML file.