跳到主要内容

MDC 规则最佳实践和故障排除

提示

MDC（模型驱动代码）规则帮助您在 Cursor 中维护一致的代码质量并自动化重复性任务。

理解 MDC 规则​

MDC 规则是强大的工具，可以让您：

  • 自动化代码审查和格式化
  • 实施团队编码标准
  • 检测和修复常见问题
  • 提高代码质量和一致性

规则类型​

  1. 语法规则

    • 代码格式化
    • 命名约定
    • 文件结构

  2. 语义规则

    • 代码复杂度
    • 最佳实践检查
    • 安全漏洞检测

  3. 自定义规则

    • 项目特定要求
    • 团队约定
    • 业务逻辑验证

配置规则​

基本设置​

在项目根目录创建 .cursor/rules 目录：

mkdir -p .cursor/rules

规则定义​

创建规则文件：

.cursor/rules/naming.json
{
  "name": "命名约定",
  "description": "强制执行一致的命名风格",
  "patterns": [
    {
      "type": "变量",
      "style": "camelCase",
      "exceptions": ["CONSTANTS"]
    }
  ]
}

规则优先级​

按重要性设置规则优先级：

.cursor/rules/config.json
{
  "priority": {
    "security": 1,
    "formatting": 2,
    "naming": 3
  }
}

常见问题和解决方案​

规则不生效​

如果规则未被应用：

  1. 检查配置

    # 验证规则文件
    cat .cursor/rules/config.json

    # 检查语法错误
    jsonlint .cursor/rules/*.json

  2. 刷新规则缓存

    • 重新启动 Cursor
    • 清除规则缓存
    • 重新加载项目

规则冲突​

处理规则冲突：

.cursor/rules/override.json
{
  "conflicts": {
    "rule1": {
      "priority": "high",
      "override": ["rule2", "rule3"]
    }
  }
}

性能问题​

优化规则执行：

  1. 限制范围

    {
      "include": ["src/**/*.ts"],
      "exclude": ["**/*.test.ts"]
    }

  2. 批处理验证

    {
      "batch": {
        "size": 100,
        "concurrent": true
      }
    }

最佳实践​

1. 规则组织​

  • 按功能分类规则
  • 使用清晰的命名
  • 保持规则简单明确

2. 版本控制​

  • 将规则纳入版本控制
  • 记录规则更改
  • 维护规则文档

3. 团队协作​

  • 与团队讨论规则
  • 收集反馈
  • 定期审查和更新

高级功能​

自定义验证器​

创建特定项目的验证器：

.cursor/rules/custom-validator.js
module.exports = {
  validate: (code, context) => {
    // 自定义验证逻辑
    return {
      valid: true,
      messages: []
    };
  }
};

自动修复​

实现自动修复功能：

module.exports = {
  fix: (code, issues) => {
    // 自动修复逻辑
    return fixedCode;
  }
};

集成测试​

为规则添加测试：

rules.test.js
describe('MDC 规则测试', () => {
  test('命名约定', () => {
    // 测试规则逻辑
  });
});

调试工具​

规则诊断​

启用详细日志：

.cursor/settings.json
{
  "mdc.rules.debug": true,
  "mdc.rules.logLevel": "verbose"
}

性能分析​

监控规则执行：

# 分析规则性能
cursor analyze-rules

# 生成性能报告
cursor rules-report

常见场景​

1. 代码审查​

自动化代码审查流程：

{
  "review": {
    "autoFix": true,
    "blockOnError": true,
    "notifyReviewer": true
  }
}

2. CI/CD 集成​

在持续集成中使用规则：

.github/workflows/mdc.yml
steps:
  - name: 检查 MDC 规则
    run: cursor check-rules

3. IDE 集成​

配置编辑器集成：

.vscode/settings.json
{
  "cursor.rules.enableFormatting": true,
  "cursor.rules.showInlineHints": true
}

相关资源​