Components Rule Adder

import * as fs from 'fs'; import * as path from 'path';

export interface ComponentInfo { name: string; path: string; }

• 自动分析 src/components 目录及其子目录中的所有文件
• 提取位于文件开头的特定格式的注释
• 将提取的注释以特定格式添加到 .mrules、.mcopilotrules 或 .cursorrules 文件中的 "## 全局组件" 部分
• 支持将组件注释同步到 .mdc 文件
• 支持中英文命令，方便不同语言用户使用

使用方法

1. 在 VSCode 中打开包含 React 项目的文件夹

2. 确保项目中有 src/components 目录，并且包含需要分析的文件

3. 打开命令面板（Cmd+Shift+P 或 Ctrl+Shift+P）

4. 执行以下命令（支持中英文）：

   a. 创建规则模板：

   • 输入并选择 "Create Rules Template" 或 "创建规则模板"
   • 从插件提供的模板列表中选择一个模板
   • 选择创建 .mrules、.mcopilotrules 或 .cursorrules 文件
   • 如果选择的文件已存在，选择是否覆盖（提示中会显示具体的文件名）

   b. 提取组件注释：

   • 输入并选择 "Extract Component Comments" 或 "提取组件注释"
   • 插件将自动分析所有文件，提取注释，并更新所有存在的 .mrules、.mcopilotrules 和 .cursorrules 文件

   c. 创建 MDC 规则模板：

   • 输入并选择 "Create MDC Rules Template" 或 "创建 MDC 规则模板"
   • 输入要创建的 MDC 文件名（不包含 .mdc 扩展名）
   • 从插件提供的模板列表中选择一个模板
   • 插件将在 .cursor/rules 目录下创建 .mdc 文件
   • 如果选择的文件已存在，选择是否覆盖

   d. 同步 MDC 规则：

   • 输入并选择 "Sync MDC Rules" 或 "同步 MDC 规则"
   • 选择要同步到的 MDC 文件
   • 插件将自动分析所有文件，提取注释，并更新选定的 .mdc 文件

注意事项

• 只有位于文件开头的特定格式注释会被提取
• 注释必须以 /** 开始，以 */ 结束
• 注释必须包含 @params 和 @description 关键字
• 如果在注释开始之前有任何非空行，该文件的注释将不会被提取

注释格式要求

为了正确提取组件信息，请按以下格式编写注释：

/**
 * 组件名称
 *
 * @params
 * -参数1
 * -参数2
 * 
 * @description
 * - 描述行1
 * - 描述行2
 */

输出格式

提取的注释将以以下格式添加到 .mrules、.mcopilotrules、.cursorrules 和 .mdc 文件中：

## 全局组件
- {组件名称}：
  -路径：{文件路径}

要求

• Visual Studio Code 1.96.0 或更高版本
• 项目中必须有 src/components 目录
• 对于 MDC 相关功能，需要有 .cursor/rules 目录（如果不存在，插件会自动创建）

扩展设置

目前，该扩展不需要任何额外的设置。

命令列表

享受使用 componentsRuleAdder 组件注释提取器！