typescript-vscode-extension

Cursor Project Rules Extension Development Guidelines

This document outlines best practices for developing and maintaining the Cursor Project Rules extension, which manages .mdc rule files from Git repositories to enhance AI coding assistance.

1. Extension Architecture

1.1. Project Structure

• Core Components:

  cursor-project-rules/
  ├── src/
  │   ├── extension.ts                # Entry point, registers commands
  │   ├── commands/                   # Command implementations
  │   │   ├── addCursorRule.ts        # UI for selecting and adding rules
  │   │   ├── addAllRules.ts          # Adds all available rules
  │   │   ├── refreshRepositories.ts  # Updates rule repositories
  │   │   ├── manageRepositories.ts   # UI for repository management
  │   │   ├── commandA.ts
  │   │   ├── commandB.ts
  │   ├── utils/                      # Utility modules
  │   │   ├── ruleManager.ts          # Manages rule loading and installation
  │   │   ├── repositoryManager.ts    # Handles Git repositories
  │   │   ├── githubApi.ts            # GitHub API integration
  │   │   ├── cache.ts                # Caching utilities
  │   ├── models/                     # Type definitions and models
  │   │   ├── types.ts
  ├── package.json                    # Extension manifest
  ├── tsconfig.json                   # TypeScript configuration
  ├── .vscodeignore                   # Files to exclude from the extension package
  ├── README.md
  

1.2. Manager Classes

• RuleManager: Responsible for finding, loading, and installing .mdc rule files.
• RepositoryManager: Handles Git repository operations (clone, pull, etc.).
• Both managers should implement the singleton pattern:

  export class RuleManager {
      private static instance: RuleManager;
      private constructor(private context: vscode.ExtensionContext) {
          this.repositoryManager = RepositoryManager.getInstance(context);
      }
      
      static getInstance(context: vscode.ExtensionContext): RuleManager {
          if (!RuleManager.instance) {
              RuleManager.instance = new RuleManager(context);
          }
          return RuleManager.instance;
      }
  }