feat: configure Salesforce Code Analyzer with custom PMD rules

Add code-analyzer.yml configuration file to customize PMD rules and engines. Create custom PMD ruleset that relaxes ApexDoc requirements for test data factories by ignoring missing @description while keeping other documentation checks. Update analysis script to use both Recommended rules and the new custom TestDataFactoryDocs ruleset.

Author: benahm

code-analyzer.yml

@@ -0,0 +1,10 @@
+# Custom settings for Salesforce Code Analyzer
+rules:
+  pmd:
+    ApexDoc:
+      # Remove the Recommended tag so the stock ApexDoc rule isn't pulled in automatically
+      tags: []
+engines:
+  pmd:
+    custom_rulesets:
+      - config/pmd-test-data-factory-overrides.xml

config/pmd-test-data-factory-overrides.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="TestDataFactoryDocs"
+         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>
+        Overrides ApexDoc so missing @description is ignored while keeping the rest of the documentation checks.
+    </description>
+
+    <rule ref="category/apex/documentation.xml/ApexDoc">
+        <properties>
+            <property name="reportMissingDescription" value="false"/>
+        </properties>
+    </rule>
+</ruleset>

generateCodeAnalysis.sh

@@ -10,11 +10,13 @@ if ! command -v sf >/dev/null 2>&1; then
   exit 1
 fi
 
-echo "Running Salesforce Code Analyzer with Recommended rules..."
+RULE_SELECTORS="Recommended,pmd:TestDataFactoryDocs"
+
+echo "Running Salesforce Code Analyzer with rule selectors: $RULE_SELECTORS"
 sf code-analyzer run \
   --workspace "$ROOT_DIR" \
   --target "$ROOT_DIR/force-app" \
-  --rule-selector Recommended \
+  --rule-selector "$RULE_SELECTORS" \
   --output-file "$OUTPUT_JSON" \
   --output-file "$OUTPUT_HTML" \
   --view table