mcpField
R
rule-research

rule-research

github.com/millionco开发15.1k446 次安装2 周前更新
代码仓库

关于 rule-research

rule-research 是用于编写检测规则前明确规则契约的开发 Skill。它通过研究证据与边界情况,形成可供 rule-writing 实现的行为规范,减少猜测。

主要功能

  1. 01定义规则行为与运行时原因
  2. 02检查相邻规则、测试和工具
  3. 03区分有效模式与应报告情况
  4. 04明确检测分析范围
  5. 05产出可供实现的规则契约

适用场景

  1. 01编码前界定新的 lint 规则
  2. 02厘清影响检测的边界情况
  3. 03为 rule-writing 准备规则契约

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/millionco/react-doctor --skill rule-research

安装后在 Claude Code 中输入/rule-research确认已加载。

详细介绍

研究一条规则

制定一份规则契约,让 rule-writing 无需猜测即可实现。

定义行为

只解决会影响正确性的问题:

  • 哪种代码模式应触发报告?
  • 哪种运行时行为会造成危害?
  • 哪些相似代码必须保持静默?
  • 检测是否需要语法、作用域或路径分析?
  • 哪些导入、动态、类型驱动或跨过程场景不在范围内?

如果用户请求了实现,请精简契约并继续。

收集证据

  1. 用一句话定义规则:This rule catches <pattern> that causes <problem>.

  2. 解释其运行时原因。

  3. 检查附近的规则、测试、实用工具和生成的注册表。

  4. 提议新的检测器或辅助工具前,先使用 truffler:

    bunx @rayhanadev/truffler "<symbol-or-behavior>" \
      packages/oxlint-plugin-react-doctor/src/plugin \
      --kind function,interface,type,constant --limit 20
    
  5. 收集官方文档、实现说明、相关代码检查工具的行为和开源示例。

  6. 区分强阳性、相邻模式、有效陷阱和不支持的场景。

  7. 选择仅基于语法、感知作用域或感知路径的检测方式。

当范围有限的开源样本可能改变契约时,使用 rde-eval。最终拉取请求的行为一致性留给 rule-validate 检查。

编写契约

返回:

Rule definition:
<pattern and specific problem>

Runtime reason:
<short explanation>

Detector precision:
<syntax-only, scope-aware, or path-aware>

Evidence:

- <source and implication>

Strong positives:

- <reportable examples>

False-positive traps:

- <valid examples>

In scope:

- <supported cases>

Out of scope:

- <explicit boundaries>

Test seeds:

- <invalid and valid fixtures>

Open questions:

- <correctness blockers only>

将误报视为正确性问题。诊断范围不得超出已证实行为的范围。将相邻想法拆分为独立规则。

评论

支持 Markdown