Skip to content

Latest commit

 

History

History
932 lines (791 loc) · 26.6 KB

07-RuleLibrary-Part1.md

File metadata and controls

932 lines (791 loc) · 26.6 KB

规则库管理（第一部分）

概述

随着您创建的规则数量增加，有效管理这些规则变得至关重要。规则库是规则的集合，经过良好组织和管理，可以提高规则的可重用性、可维护性和共享性。本章将探讨如何创建、组织、分类和维护规则库，帮助您实现规则资产的最大价值。

学习目标

  • 了解规则库的概念和结构
  • 学习创建个人规则库的方法和最佳实践
  • 掌握规则组织和分类的策略
  • 了解规则版本控制和维护的技术

规则库基础

什么是规则库

规则库（Rule Library）是一组有组织的规则集合，它们按照特定的结构和分类进行管理。规则库可以是：

  1. 个人规则库：供个人开发者使用的规则集合
  2. 团队规则库：团队共享和协作开发的规则集合
  3. 组织规则库：整个组织范围内使用的标准规则集合
  4. 公共规则库：开源社区分享的规则集合

规则库的价值

规则库带来的主要价值包括：

  • 可重用性：避免重复创建类似功能的规则
  • 一致性：确保相同任务使用统一的规则
  • 知识共享：将个人经验转化为团队资产
  • 效率提升：快速找到并应用合适的规则
  • 质量保证：经过验证的规则可以保持一致的质量标准

规则库的结构

一个典型的规则库结构包括：

rules-library/
├── categories/           # 按类别组织的规则
│   ├── code-quality/
│   ├── workflow/
│   └── documentation/
├── templates/            # 规则模板
├── shared/               # 共享组件和辅助函数
└── metadata/             # 规则库元数据

创建个人规则库

个人规则库是您自己创建和维护的规则集合，它是规则库管理的起点。

设置规则库目录

首先，让我们创建一个基本的规则库目录结构：

# 创建规则库目录
mkdir -p ~/cursor-rules-library
cd ~/cursor-rules-library

# 创建基本目录结构
mkdir -p categories/{code-quality,workflow,documentation}
mkdir -p templates
mkdir -p shared
mkdir -p metadata

在Terminal中，可以使用以下命令：

CMD

# Windows CMD
@echo off
rem 创建规则库目录
set libraryPath=%USERPROFILE%\cursor-rules-library
if not exist "%libraryPath%" mkdir "%libraryPath%"

rem 创建基本目录结构
if not exist "%libraryPath%\categories\code-quality" mkdir "%libraryPath%\categories\code-quality"
if not exist "%libraryPath%\categories\workflow" mkdir "%libraryPath%\categories\workflow"
if not exist "%libraryPath%\categories\documentation" mkdir "%libraryPath%\categories\documentation"
if not exist "%libraryPath%\templates" mkdir "%libraryPath%\templates"
if not exist "%libraryPath%\shared" mkdir "%libraryPath%\shared"
if not exist "%libraryPath%\metadata" mkdir "%libraryPath%\metadata"

**Linux/macOS**
```bash
# Linux/macOS
#!/bin/bash
# 创建规则库目录
libraryPath="$HOME/cursor-rules-library"
mkdir -p "$libraryPath"

# 创建基本目录结构
mkdir -p "$libraryPath/categories/code-quality"
mkdir -p "$libraryPath/categories/workflow"
mkdir -p "$libraryPath/categories/documentation"
mkdir -p "$libraryPath/templates"
mkdir -p "$libraryPath/shared"
mkdir -p "$libraryPath/metadata"

创建规则库清单

接下来，创建一个规则库清单文件，用于描述规则库的基本信息：

# 创建规则库清单
cat > ~/cursor-rules-library/library.json << EOL
{
  "name": "Personal Cursor Rules Library",
  "description": "我的个人Cursor规则集合",
  "version": "1.0.0",
  "author": "Your Name",
  "created": "$(date '+%Y-%m-%d')",
  "updated": "$(date '+%Y-%m-%d')",
  "categories": [
    "code-quality",
    "workflow",
    "documentation"
  ],
  "rules_count": 0
}
EOL

在Terminal中，可以这样创建：

CMD

# Windows CMD
@echo off
rem 创建规则库清单
for /f "tokens=2-4 delims=/ " %%a in ('date /t') do (
    set currentDate=%%c-%%a-%%b
)

echo {> "%libraryPath%\library.json"
echo   "name": "Personal Cursor Rules Library",>> "%libraryPath%\library.json"
echo   "description": "我的个人Cursor规则集合",>> "%libraryPath%\library.json"
echo   "version": "1.0.0",>> "%libraryPath%\library.json"
echo   "author": "Your Name",>> "%libraryPath%\library.json"
echo   "created": "%currentDate%",>> "%libraryPath%\library.json"
echo   "updated": "%currentDate%",>> "%libraryPath%\library.json"
echo   "categories": [>> "%libraryPath%\library.json"
echo     "code-quality",>> "%libraryPath%\library.json"
echo     "workflow",>> "%libraryPath%\library.json"
echo     "documentation">> "%libraryPath%\library.json"
echo   ],>> "%libraryPath%\library.json"
echo   "rules_count": 0>> "%libraryPath%\library.json"
echo }>> "%libraryPath%\library.json"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 创建规则库清单
currentDate=$(date +"%Y-%m-%d")

cat > "$libraryPath/library.json" << EOF
{
  "name": "Personal Cursor Rules Library",
  "description": "我的个人Cursor规则集合",
  "version": "1.0.0",
  "author": "Your Name",
  "created": "$currentDate",
  "updated": "$currentDate",
  "categories": [
    "code-quality",
    "workflow",
    "documentation"
  ],
  "rules_count": 0
}
EOF

创建规则模板

规则模板可以帮助您更快地创建新规则。以下是一个基本的规则模板：

# 创建基本规则模板
cat > ~/cursor-rules-library/templates/basic-rule.mdc << EOL
---
description: 规则描述
globs: **/*
---
# 规则标题

<rule>
name: rule_name
description: 详细描述规则的用途

filters:
  - type: filter_type
    pattern: "pattern"

actions:
  - type: action_type
    message: |
      消息内容

metadata:
  priority: medium
  version: 1.0.0
  tags: ["tag1", "tag2"]
  category: "category-name"
  author: "Your Name"
  created: "$(date '+%Y-%m-%d')"
  updated: "$(date '+%Y-%m-%d')"
</rule>
EOL

在Terminal中：

CMD

# Windows CMD
@echo off
rem 创建基本规则模板
for /f "tokens=2-4 delims=/ " %%a in ('date /t') do (
    set currentDate=%%c-%%a-%%b
)

echo --->> "%libraryPath%\templates\basic-rule.mdc"
echo description: 规则描述>> "%libraryPath%\templates\basic-rule.mdc"
echo globs: **/*>> "%libraryPath%\templates\basic-rule.mdc"
echo --->> "%libraryPath%\templates\basic-rule.mdc"
echo # 规则标题>> "%libraryPath%\templates\basic-rule.mdc"
echo.>> "%libraryPath%\templates\basic-rule.mdc"
echo ^<rule^>>> "%libraryPath%\templates\basic-rule.mdc"
echo name: rule_name>> "%libraryPath%\templates\basic-rule.mdc"
echo description: 详细描述规则的用途>> "%libraryPath%\templates\basic-rule.mdc"
echo.>> "%libraryPath%\templates\basic-rule.mdc"
echo filters:>> "%libraryPath%\templates\basic-rule.mdc"
echo   - type: filter_type>> "%libraryPath%\templates\basic-rule.mdc"
echo     pattern: "pattern">> "%libraryPath%\templates\basic-rule.mdc"
echo.>> "%libraryPath%\templates\basic-rule.mdc"
echo actions:>> "%libraryPath%\templates\basic-rule.mdc"
echo   - type: action_type>> "%libraryPath%\templates\basic-rule.mdc"
echo     message: ^|>> "%libraryPath%\templates\basic-rule.mdc"
echo       消息内容>> "%libraryPath%\templates\basic-rule.mdc"
echo.>> "%libraryPath%\templates\basic-rule.mdc"
echo metadata:>> "%libraryPath%\templates\basic-rule.mdc"
echo   priority: medium>> "%libraryPath%\templates\basic-rule.mdc"
echo   version: 1.0.0>> "%libraryPath%\templates\basic-rule.mdc"
echo   tags: ["tag1", "tag2"]>> "%libraryPath%\templates\basic-rule.mdc"
echo   category: "category-name">> "%libraryPath%\templates\basic-rule.mdc"
echo   author: "Your Name">> "%libraryPath%\templates\basic-rule.mdc"
echo   created: "%currentDate%">> "%libraryPath%\templates\basic-rule.mdc"
echo   updated: "%currentDate%">> "%libraryPath%\templates\basic-rule.mdc"
echo ^</rule^>>> "%libraryPath%\templates\basic-rule.mdc"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 创建基本规则模板
currentDate=$(date +"%Y-%m-%d")

cat > "$libraryPath/templates/basic-rule.mdc" << 'EOF'
---
description: 规则描述
globs: **/*
---
# 规则标题

<rule>
name: rule_name
description: 详细描述规则的用途

filters:
  - type: filter_type
    pattern: "pattern"

actions:
  - type: action_type
    message: |
      消息内容

metadata:
  priority: medium
  version: 1.0.0
  tags: ["tag1", "tag2"]
  category: "category-name"
  author: "Your Name"
  created: "'$currentDate'"
  updated: "'$currentDate'"
</rule>
EOF

添加示例规则

让我们添加一个示例规则到规则库：

# 创建示例规则
cat > ~/cursor-rules-library/categories/code-quality/js-best-practices.mdc << EOL
---
description: JavaScript最佳实践检查
globs: **/*.js,**/*.jsx,**/*.ts,**/*.tsx
---
# JavaScript最佳实践

<rule>
name: js_best_practices
description: 检查JavaScript代码中的常见最佳实践

filters:
  - type: file_extension
    pattern: "\\.(js|jsx|ts|tsx)$"
  
  - type: content
    pattern: "var\\s+\\w+"

actions:
  - type: suggest
    message: |
      ## JavaScript最佳实践建议
      
      检测到使用 \`var\` 声明变量。推荐使用 \`const\` 或 \`let\` 来声明变量，以获得更好的作用域控制：
      
      ```javascript
      // 不推荐
      var x = 10;
      
      // 推荐
      const x = 10; // 对于不会改变的值
      let y = 20;   // 对于可能会改变的值
      ```
      
      使用 \`const\` 和 \`let\` 的好处：
      - 块级作用域，避免变量提升问题
      - \`const\` 可以防止变量被意外重新赋值
      - 代码更容易理解和维护

metadata:
  priority: high
  version: 1.0.0
  tags: ["javascript", "best-practices", "code-quality"]
  category: "code-quality"
  author: "Your Name"
  created: "$(date '+%Y-%m-%d')"
  updated: "$(date '+%Y-%m-%d')"
</rule>
EOL

在Terminal中：

CMD

# Windows CMD
@echo off
rem 创建示例规则
for /f "tokens=2-4 delims=/ " %%a in ('date /t') do (
    set currentDate=%%c-%%a-%%b
)

set rulePath=%libraryPath%\categories\code-quality\js-best-practices.mdc

echo --->> "%rulePath%"
echo description: JavaScript最佳实践检查>> "%rulePath%"
echo globs: **/*.js,**/*.jsx,**/*.ts,**/*.tsx>> "%rulePath%"
echo --->> "%rulePath%"
echo # JavaScript最佳实践>> "%rulePath%"
echo.>> "%rulePath%"
echo ^<rule^>>> "%rulePath%"
echo name: js_best_practices>> "%rulePath%"
echo description: 检查JavaScript代码中的常见最佳实践>> "%rulePath%"
echo.>> "%rulePath%"
echo filters:>> "%rulePath%"
echo   - type: file_extension>> "%rulePath%"
echo     pattern: "\\.(js^|jsx^|ts^|tsx)$">> "%rulePath%"
echo.>> "%rulePath%"
echo   - type: content>> "%rulePath%"
echo     pattern: "var\\s+\\w+">> "%rulePath%"
echo.>> "%rulePath%"
echo actions:>> "%rulePath%"
echo   - type: suggest>> "%rulePath%"
echo     message: ^|>> "%rulePath%"
echo       ## JavaScript最佳实践建议>> "%rulePath%"
echo.>> "%rulePath%"      
echo       检测到使用 `var` 声明变量。推荐使用 `const` 或 `let` 来声明变量，以获得更好的作用域控制：>> "%rulePath%"
echo.>> "%rulePath%"      
echo       ```javascript>> "%rulePath%"
echo       // 不推荐>> "%rulePath%"
echo       var x = 10;>> "%rulePath%"
echo.>> "%rulePath%"      
echo       // 推荐>> "%rulePath%"
echo       const x = 10; // 对于不会改变的值>> "%rulePath%"
echo       let y = 20;   // 对于可能会改变的值>> "%rulePath%"
echo       ```>> "%rulePath%"
echo.>> "%rulePath%"      
echo       使用 `const` 和 `let` 的好处：>> "%rulePath%"
echo       - 块级作用域，避免变量提升问题>> "%rulePath%"
echo       - `const` 可以防止变量被意外重新赋值>> "%rulePath%"
echo       - 代码更容易理解和维护>> "%rulePath%"
echo.>> "%rulePath%"
echo metadata:>> "%rulePath%"
echo   priority: high>> "%rulePath%"
echo   version: 1.0.0>> "%rulePath%"
echo   tags: ["javascript", "best-practices", "code-quality"]>> "%rulePath%"
echo   category: "code-quality">> "%rulePath%"
echo   author: "Your Name">> "%rulePath%"
echo   created: "%currentDate%">> "%rulePath%"
echo   updated: "%currentDate%">> "%rulePath%"
echo ^</rule^>>> "%rulePath%"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 创建示例规则
currentDate=$(date +"%Y-%m-%d")

cat > "$libraryPath/categories/code-quality/js-best-practices.mdc" << 'EOF'
---
description: JavaScript最佳实践检查
globs: **/*.js,**/*.jsx,**/*.ts,**/*.tsx
---
# JavaScript最佳实践

<rule>
name: js_best_practices
description: 检查JavaScript代码中的常见最佳实践

filters:
  - type: file_extension
    pattern: "\\.(js|jsx|ts|tsx)$"
  
  - type: content
    pattern: "var\\s+\\w+"

actions:
  - type: suggest
    message: |
      ## JavaScript最佳实践建议
      
      检测到使用 `var` 声明变量。推荐使用 `const` 或 `let` 来声明变量，以获得更好的作用域控制：
      
      ```javascript
      // 不推荐
      var x = 10;
      
      // 推荐
      const x = 10; // 对于不会改变的值
      let y = 20;   // 对于可能会改变的值
      ```
      
      使用 `const` 和 `let` 的好处：
      - 块级作用域，避免变量提升问题
      - `const` 可以防止变量被意外重新赋值
      - 代码更容易理解和维护

metadata:
  priority: high
  version: 1.0.0
  tags: ["javascript", "best-practices", "code-quality"]
  category: "code-quality"
  author: "Your Name"
  created: "'$currentDate'"
  updated: "'$currentDate'"
</rule>
EOF

创建规则库索引

为了更好地管理规则，让我们创建一个索引文件，记录规则库中的所有规则：

# 创建规则库索引
cat > ~/cursor-rules-library/rules-index.json << EOL
{
  "rules": [
    {
      "id": "js_best_practices",
      "name": "JavaScript最佳实践",
      "description": "检查JavaScript代码中的常见最佳实践",
      "path": "categories/code-quality/js-best-practices.mdc",
      "category": "code-quality",
      "tags": ["javascript", "best-practices", "code-quality"],
      "version": "1.0.0",
      "created": "$(date '+%Y-%m-%d')",
      "updated": "$(date '+%Y-%m-%d')"
    }
  ]
}
EOL

在Terminal中：

CMD

# Windows CMD
@echo off
rem 创建规则库索引
for /f "tokens=2-4 delims=/ " %%a in ('date /t') do (
    set currentDate=%%c-%%a-%%b
)

echo {> "%libraryPath%\rules-index.json"
echo   "rules": [>> "%libraryPath%\rules-index.json"
echo     {>> "%libraryPath%\rules-index.json"
echo       "id": "js_best_practices",>> "%libraryPath%\rules-index.json"
echo       "name": "JavaScript最佳实践",>> "%libraryPath%\rules-index.json"
echo       "description": "检查JavaScript代码中的常见最佳实践",>> "%libraryPath%\rules-index.json"
echo       "path": "categories/code-quality/js-best-practices.mdc",>> "%libraryPath%\rules-index.json"
echo       "category": "code-quality",>> "%libraryPath%\rules-index.json"
echo       "tags": ["javascript", "best-practices", "code-quality"],>> "%libraryPath%\rules-index.json"
echo       "version": "1.0.0",>> "%libraryPath%\rules-index.json"
echo       "created": "%currentDate%",>> "%libraryPath%\rules-index.json"
echo       "updated": "%currentDate%">> "%libraryPath%\rules-index.json"
echo     }>> "%libraryPath%\rules-index.json"
echo   ]>> "%libraryPath%\rules-index.json"
echo }>> "%libraryPath%\rules-index.json"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 创建规则库索引
currentDate=$(date +"%Y-%m-%d")

cat > "$libraryPath/rules-index.json" << EOF
{
  "rules": [
    {
      "id": "js_best_practices",
      "name": "JavaScript最佳实践",
      "description": "检查JavaScript代码中的常见最佳实践",
      "path": "categories/code-quality/js-best-practices.mdc",
      "category": "code-quality",
      "tags": ["javascript", "best-practices", "code-quality"],
      "version": "1.0.0",
      "created": "$currentDate",
      "updated": "$currentDate"
    }
  ]
}
EOF

创建规则库管理脚本

为了简化规则库的管理，我们可以创建一个管理脚本。以下是一个基本的脚本示例：

# 创建规则库管理脚本
cat > ~/cursor-rules-library/manage-library.sh << EOL
#!/bin/bash

# Cursor规则库管理脚本

LIBRARY_DIR="\$HOME/cursor-rules-library"
RULES_INDEX="\$LIBRARY_DIR/rules-index.json"
LIBRARY_JSON="\$LIBRARY_DIR/library.json"

function show_help {
    echo "Cursor规则库管理工具"
    echo ""
    echo "用法:"
    echo "  ./manage-library.sh [命令] [参数]"
    echo ""
    echo "命令:"
    echo "  list                列出所有规则"
    echo "  add [模板] [路径]    添加新规则"
    echo "  find [关键词]       搜索规则"
    echo "  update [id] [路径]  更新规则"
    echo "  help               显示帮助信息"
}

function list_rules {
    echo "规则库中的规则:"
    jq -r '.rules[] | "- \(.id): \(.name) [\(.category)]\"" "\$RULES_INDEX"
}

function find_rules {
    if [ -z "\$1" ]; then
        echo "错误: 请提供搜索关键词"
        return 1
    fi
    
    echo "搜索关键词: \$1"
    jq -r ".rules[] | select(.name | contains(\"\$1\") or .description | contains(\"\$1\") or .tags[] | contains(\"\$1\")) | \"- \(.id): \(.name) [\(.category)]\"" "\$RULES_INDEX"
}

function add_rule {
    if [ -z "\$1" ] || [ -z "\$2" ]; then
        echo "错误: 请提供模板和目标路径"
        echo "用法: ./manage-library.sh add [模板] [路径]"
        return 1
    fi
    
    TEMPLATE="\$LIBRARY_DIR/templates/\$1.mdc"
    TARGET="\$LIBRARY_DIR/\$2"
    
    if [ ! -f "\$TEMPLATE" ]; then
        echo "错误: 模板 '\$1' 不存在"
        return 1
    fi
    
    mkdir -p "\$(dirname "\$TARGET")"
    cp "\$TEMPLATE" "\$TARGET"
    echo "创建新规则: \$TARGET"
    echo "请编辑新创建的规则文件"
}

function update_rule {
    if [ -z "\$1" ] || [ -z "\$2" ]; then
        echo "错误: 请提供规则ID和新路径"
        echo "用法: ./manage-library.sh update [id] [路径]"
        return 1
    fi
    
    # 更新规则索引
    TMP_FILE="\$(mktemp)"
    jq ".rules[] | select(.id == \"\$1\").updated = \"$(date '+%Y-%m-%d')\"" "\$RULES_INDEX" > "\$TMP_FILE"
    mv "\$TMP_FILE" "\$RULES_INDEX"
    
    echo "更新规则 '\$1' 到 '\$2'"
}

# 主函数
case "\$1" in
    list)
        list_rules
        ;;
    find)
        find_rules "\$2"
        ;;
    add)
        add_rule "\$2" "\$3"
        ;;
    update)
        update_rule "\$2" "\$3"
        ;;
    help|*)
        show_help
        ;;
esac
EOL

# 添加执行权限
chmod +x ~/cursor-rules-library/manage-library.sh

在Terminal中，我们可以创建一个脚本：

CMD

# Windows CMD
@echo off
rem 创建规则库管理脚本
set scriptPath=%libraryPath%\manage-library.bat

echo @echo off> "%scriptPath%"
echo rem Cursor规则库管理脚本>> "%scriptPath%"
echo.>> "%scriptPath%"
echo set libraryDir=%%USERPROFILE%%\cursor-rules-library>> "%scriptPath%"
echo set rulesIndex=%%libraryDir%%\rules-index.json>> "%scriptPath%"
echo set libraryJson=%%libraryDir%%\library.json>> "%scriptPath%"
echo.>> "%scriptPath%"
echo if "%%1"=="list" goto list_rules>> "%scriptPath%"
echo if "%%1"=="find" goto find_rules>> "%scriptPath%"
echo if "%%1"=="add" goto add_rule>> "%scriptPath%"
echo if "%%1"=="update" goto update_rule>> "%scriptPath%"
echo goto show_help>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :show_help>> "%scriptPath%"
echo echo Cursor规则库管理工具>> "%scriptPath%"
echo echo.>> "%scriptPath%"
echo echo 用法:>> "%scriptPath%"
echo echo   manage-library.bat [命令] [参数]>> "%scriptPath%"
echo echo.>> "%scriptPath%"
echo echo 命令:>> "%scriptPath%"
echo echo   list                列出所有规则>> "%scriptPath%"
echo echo   add [模板] [路径]    添加新规则>> "%scriptPath%"
echo echo   find [关键词]       搜索规则>> "%scriptPath%"
echo echo   update [id] [路径]  更新规则>> "%scriptPath%"
echo echo   help               显示帮助信息>> "%scriptPath%"
echo exit /b>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :list_rules>> "%scriptPath%"
echo echo 规则库中的规则:>> "%scriptPath%"
echo findstr /C:"id" "%%rulesIndex%%" | findstr /C:"name">> "%scriptPath%"
echo exit /b>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :find_rules>> "%scriptPath%"
echo if "%%2"=="" (>> "%scriptPath%"
echo   echo 错误: 请提供搜索关键词>> "%scriptPath%"
echo   exit /b 1>> "%scriptPath%"
echo )>> "%scriptPath%"
echo.>> "%scriptPath%"
echo echo 搜索关键词: %%2>> "%scriptPath%"
echo findstr /C:"%%2" "%%rulesIndex%%">> "%scriptPath%"
echo exit /b>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :add_rule>> "%scriptPath%"
echo if "%%2"=="" goto add_rule_error>> "%scriptPath%"
echo if "%%3"=="" goto add_rule_error>> "%scriptPath%"
echo.>> "%scriptPath%"
echo set templatePath=%%libraryDir%%\templates\%%2.mdc>> "%scriptPath%"
echo set targetPath=%%libraryDir%%\%%3>> "%scriptPath%"
echo.>> "%scriptPath%"
echo if not exist "%%templatePath%%" (>> "%scriptPath%"
echo   echo 错误: 模板 '%%2' 不存在>> "%scriptPath%"
echo   exit /b 1>> "%scriptPath%"
echo )>> "%scriptPath%"
echo.>> "%scriptPath%"
echo for %%I in ("%%targetPath%%") do set targetDir=%%~dpI>> "%scriptPath%"
echo if not exist "%%targetDir%%" mkdir "%%targetDir%%">> "%scriptPath%"
echo.>> "%scriptPath%"
echo copy "%%templatePath%%" "%%targetPath%%">> "%scriptPath%"
echo echo 创建新规则: %%targetPath%%>> "%scriptPath%"
echo echo 请编辑新创建的规则文件>> "%scriptPath%"
echo exit /b>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :add_rule_error>> "%scriptPath%"
echo echo 错误: 请提供模板和目标路径>> "%scriptPath%"
echo echo 用法: manage-library.bat add [模板] [路径]>> "%scriptPath%"
echo exit /b 1>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :update_rule>> "%scriptPath%"
echo if "%%2"=="" goto update_rule_error>> "%scriptPath%"
echo if "%%3"=="" goto update_rule_error>> "%scriptPath%"
echo.>> "%scriptPath%"
echo for /f "tokens=2-4 delims=/ " %%%%a in ('date /t') do (>> "%scriptPath%"
echo   set currentDate=%%%%c-%%%%a-%%%%b>> "%scriptPath%"
echo )>> "%scriptPath%"
echo.>> "%scriptPath%"
echo echo 更新规则 '%%2' 到 '%%3'>> "%scriptPath%"
echo exit /b>> "%scriptPath%"
echo.>> "%scriptPath%"
echo :update_rule_error>> "%scriptPath%"
echo echo 错误: 请提供规则ID和新路径>> "%scriptPath%"
echo echo 用法: manage-library.bat update [id] [路径]>> "%scriptPath%"
echo exit /b 1>> "%scriptPath%"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 创建规则库管理脚本
cat > "$libraryPath/manage-library.sh" << 'EOF'
#!/bin/bash

# Cursor规则库管理脚本

LIBRARY_DIR="$HOME/cursor-rules-library"
RULES_INDEX="$LIBRARY_DIR/rules-index.json"
LIBRARY_JSON="$LIBRARY_DIR/library.json"

function show_help {
    echo "Cursor规则库管理工具"
    echo ""
    echo "用法:"
    echo "  ./manage-library.sh [命令] [参数]"
    echo ""
    echo "命令:"
    echo "  list                列出所有规则"
    echo "  add [模板] [路径]    添加新规则"
    echo "  find [关键词]       搜索规则"
    echo "  update [id] [路径]  更新规则"
    echo "  help               显示帮助信息"
}

function list_rules {
    echo "规则库中的规则:"
    grep -E "id|name" "$RULES_INDEX" | grep -v "rules"
}

function find_rules {
    if [ -z "$1" ]; then
        echo "错误: 请提供搜索关键词"
        return 1
    fi
    
    echo "搜索关键词: $1"
    grep -i "$1" "$RULES_INDEX"
}

function add_rule {
    if [ -z "$1" ] || [ -z "$2" ]; then
        echo "错误: 请提供模板和目标路径"
        echo "用法: ./manage-library.sh add [模板] [路径]"
        return 1
    fi
    
    TEMPLATE="$LIBRARY_DIR/templates/$1.mdc"
    TARGET="$LIBRARY_DIR/$2"
    
    if [ ! -f "$TEMPLATE" ]; then
        echo "错误: 模板 '$1' 不存在"
        return 1
    fi
    
    mkdir -p "$(dirname "$TARGET")"
    cp "$TEMPLATE" "$TARGET"
    echo "创建新规则: $TARGET"
    echo "请编辑新创建的规则文件"
}

function update_rule {
    if [ -z "$1" ] || [ -z "$2" ]; then
        echo "错误: 请提供规则ID和新路径"
        echo "用法: ./manage-library.sh update [id] [路径]"
        return 1
    fi
    
    # 更新规则索引
    currentDate=$(date +"%Y-%m-%d")
    
    echo "更新规则 '$1' 到 '$2'"
}

# 主函数
case "$1" in
    list)
        list_rules
        ;;
    find)
        find_rules "$2"
        ;;
    add)
        add_rule "$2" "$3"
        ;;
    update)
        update_rule "$2" "$3"
        ;;
    help|*)
        show_help
        ;;
esac
EOF

chmod +x "$libraryPath/manage-library.sh"

链接到项目

最后，我们可以创建一个符号链接，将规则库链接到当前项目：

# 链接规则库到当前项目
PROJECT_DIR=$(pwd)
mkdir -p "$PROJECT_DIR/.cursor/rules"
ln -sf ~/cursor-rules-library/categories/code-quality/js-best-practices.mdc "$PROJECT_DIR/.cursor/rules/js-best-practices.mdc"

在Terminal中，可以使用以下命令创建符号链接（需要管理员权限）：

CMD

# Windows CMD 
@echo off
rem 链接规则库到当前项目
set projectDir=%CD%
if not exist "%projectDir%\.cursor\rules" mkdir "%projectDir%\.cursor\rules"

rem CMD中创建符号链接（需要管理员权限）
mklink "%projectDir%\.cursor\rules\js-best-practices.mdc" "%USERPROFILE%\cursor-rules-library\categories\code-quality\js-best-practices.mdc"

rem 如果没有管理员权限，使用复制替代
rem copy "%USERPROFILE%\cursor-rules-library\categories\code-quality\js-best-practices.mdc" "%projectDir%\.cursor\rules\js-best-practices.mdc"

Linux/macOS

# Linux/macOS
#!/bin/bash
# 链接规则库到当前项目
PROJECT_DIR=$(pwd)
mkdir -p "$PROJECT_DIR/.cursor/rules"
ln -sf ~/cursor-rules-library/categories/code-quality/js-best-practices.mdc "$PROJECT_DIR/.cursor/rules/js-best-practices.mdc"

使用个人规则库

创建好个人规则库后，您可以使用以下方法将其应用到项目中：

1. 从规则库导入规则

# 将规则从规则库导入到项目
cp ~/cursor-rules-library/categories/code-quality/js-best-practices.mdc .cursor/rules/

2. 使用管理脚本

# 列出规则库中的所有规则
~/cursor-rules-library/manage-library.sh list

# 添加新规则
~/cursor-rules-library/manage-library.sh add basic-rule categories/workflow/git-commit.mdc

# 搜索规则
~/cursor-rules-library/manage-library.sh find javascript

3. 创建规则引用文件

您可以创建一个引用文件，指向规则库中的规则：

# 创建引用文件
cat > .cursor/rules/library-refs.json << EOL
{
  "references": [
    {
      "id": "js_best_practices",
      "source": "$HOME/cursor-rules-library/categories/code-quality/js-best-practices.mdc"
    }
  ]
}
EOL

在下一部分，我们将探讨如何有效地组织和分类规则，以便更好地管理您的规则库。