Cursor rule

1---
2description: Git Conventional Commits
3globs: 
4---
5Rule for automatically committing changes made by CursorAI using conventional commits format.
6 
7<rule>
8name: conventional_commits
9description: Automatically commit changes made by CursorAI using conventional commits format
10filters:
11  - type: event
12    pattern: "build_success"
13  - type: file_change
14    pattern: "*"
15 
16actions:
17  - type: execute
18    command: |
19      # Extract the change type and scope from the changes
20      CHANGE_TYPE=""
21      case "$CHANGE_DESCRIPTION" in
22        *"add"*|*"create"*|*"implement"*) CHANGE_TYPE="feat";;
23        *"fix"*|*"correct"*|*"resolve"*) CHANGE_TYPE="fix";;
24        *"refactor"*|*"restructure"*) CHANGE_TYPE="refactor";;
25        *"test"*) CHANGE_TYPE="test";;
26        *"doc"*|*"comment"*) CHANGE_TYPE="docs";;
27        *"style"*|*"format"*) CHANGE_TYPE="style";;
28        *"perf"*|*"optimize"*) CHANGE_TYPE="perf";;
29        *) CHANGE_TYPE="chore";;
30      esac
31 
32      # Extract scope from file path
33      SCOPE=$(dirname "$FILE" | tr '/' '-')W
34 
35      # Commit the changes
36      git add "$FILE"
37      git commit -m "$CHANGE_TYPE($SCOPE): $CHANGE_DESCRIPTION"
38 
39  - type: suggest
40    message: |
41      Changes should be committed using conventional commits format:
42 
43      Format: <type>(<scope>): <description>
44 
45      Types:
46      - feat: A new feature
47      - fix: A bug fix
48      - docs: Documentation only changes
49      - style: Changes that do not affect the meaning of the code
50      - refactor: A code change that neither fixes a bug nor adds a feature
51      - perf: A code change that improves performance
52      - test: Adding missing tests or correcting existing tests
53      - chore: Changes to the build process or auxiliary tools
54 
55      The scope should be derived from the file path or affected component.
56      The description should be clear and concise, written in imperative mood.
57      For anything in .github or ci folders, (ci) is the correct scope.
58 
59examples:
60  - input: |
61      # After adding a new function
62      CHANGE_DESCRIPTION="add user authentication function"
63      FILE="src/auth/login.ts"
64    output: "feat(src-auth): add user authentication function"
65 
66  - input: |
67      # After fixing a bug
68      CHANGE_DESCRIPTION="fix incorrect date parsing"
69      FILE="lib/utils/date.js"
70    output: "fix(lib-utils): fix incorrect date parsing"
71 
72metadata:
73  priority: high
74  version: 1.0
75</rule>