Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Feature Request] File based regex rules

未关闭
#1,972 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
typescript
领域
cli, tooling

调研方向

从加载 code-analyzer.yml 的 CLI 入口点开始,跟踪 regex custom_rules 的解析方式。检查如何引用和共享外部 YAML 规则文件,然后在一次具有代表性的 CLI 运行中验证现有的内联规则仍能与基于文件的规则一起工作。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
TypeScript
星标
240
派生
52
平均合并
9 小时 48 分钟
30 天内合并 PR
3

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

forcedotcom/code-analyzer 的其他 Issue

查看 forcedotcom/code-analyzer 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。