[Feature Request] Configure properties in code-analyzer.yml

[metalshark]

Product Area

The "code-analyzer" CLI

Your Need or Problem

You have to create one or more .xml files to customise the properties of rules, then refer to those .xml files from code-analyzer.yml which is overly complicated.

Your Desired Solution

When customising rule properties, allow us to do it from within code-analyzer.yml helping us keep all project related configuration in the one file, whilst more easily adding 1st and 3rd party rulesets and configuring them.

Alternatives Considered

No response

Additional Context (Screenshots, Files, etc)

No response

Workaround

No response

Urgency

Low

[stephen-carter-at-sf]

@metalshark

Can you please provide more information? Are you talking about PMD custom ruleset xml files or some other xml files? The more details you can provide the better we can understand your pain points.

[metalshark]

Yes, so to override a property right now I'd need to create an override file:

<?xml version="1.0" ?>
<ruleset
    name="Custom Overrides"
    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
    <description>Description here</description>
    
    <rule ref="category/apex/design.xml/RuleName">
        <properties>
            <property name="propertyName" value="newValue"/>
        </properties>
    </rule>
</ruleset>

then refer to it from code-analyzer.yml.

In an ideal world, instead I'd be able to configure those override properties from within code-analyzer.yml instead:

engines:
    pmd:
        rulesets:
            - property: override