Skip to content

[Feature Request] File based regex rules #1972

@metalshark

Description

@metalshark

Product Area

The "code-analyzer" CLI

Your Need or Problem

Allow for regex rules to be placed into their own files and referenced from code-analyzer.yml so that they can be more easily shared between projects instead of merging them into existing files.

Your Desired Solution

Lets say we had the rule:

name: Salesforce Code Analyzer Configuration
version: 1.0.0

rulesets: []

engines:
    regex:
        custom_rules:
            ProhibitSuppressWarnings:
                regex: /@SuppressWarnings\([^)]*\)|\/\/\s*NOPMD/gi
                file_extensions: ['.apex', '.cls', '.trigger']
                description:
                    'Prohibits the use of @SuppressWarnings annotations and
                    NOPMD comments in Apex code. Suppressions hide code quality
                    issues; prefer fixing the underlying problems or improving
                    rules instead.'
                violation_message:
                    'Suppression of warnings is not allowed. Fix the underlying
                    issue or improve the rule instead of suppressing violations.'
                severity: 'High'
                tags: ['CodeStyle', 'Recommended']

I would like to take the details of that rule and put them in a different .yaml file, then refer to that .yaml file from code-analyzer.yml

Alternatives Considered

Keep adding rules to code-analyzer.yml like today, using a pre-processor/script ahead of every run, etc

Additional Context (Screenshots, Files, etc)

No response

Workaround

No response

Urgency

Low

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions