Home

Welcome to Cursor Rules Dynamic

Project Overview

Cursor Rules Dynamic is a VSCode extension that provides dynamic management and analysis of .cursorrules files for Cursor AI projects. The project is focused on enhancing the development experience with Cursor AI through intelligent rule management and code pattern analysis.

MVP Status

• Current Phase: VSCode Extension Development
• Focus:
  • Core Extension Features: 100% Test Coverage
  • Dynamic Analysis Engine
  • Template Management System
• Key Features:
  • Dynamic code pattern analysis
  • Real-time rule monitoring
  • Template management system
  • Format conversion with preview
  • Project scanning capabilities
  • Version control and backups

Project Structure

cursor-rules-dynamic/
├── .github/
│   └── workflows/         # CI/CD pipelines
├── vscode-extension/
│   ├── src/
│   │   ├── converter/     # Format conversion logic
│   │   ├── templates/     # Template management
│   │   ├── test/          # Test suites
│   │   └── types/         # TypeScript types
│   ├── schemas/           # JSON schemas
│   └── scripts/           # Development tools
└── README.md

Documentation

MVP Documentation

• MVP Overview
• MVP Architecture
• MVP Implementation
• MVP Testing Strategy

Core Documentation

• Development Guide
• Extension API Specifications
• Rule Schema Documentation

Quality Metrics

Getting Started

1. Clone the repository:

   git clone https://github.com/fleXRPL/cursor-rules-dynamic.git
   cd cursor-rules-dynamic

2. Set up development environment:

   cd vscode-extension
   npm install

3. Run tests and checks:

   npm run test
   npm run lint

4. Build the extension:

   npm run compile

Development Requirements

• VSCode 1.96.0 or later
• Node.js 18.x or later
• TypeScript 5.3.3
• GitHub Personal Access Token for package publishing

Project Structure - Extension

src/
├── converter/              # Format conversion
│   └── textConverter.ts    # Text to JSON conversion
├── templates/              # Template management
│   └── templateService.ts  # Template handling
├── test/                   # Test suite
│   ├── runTest/            # Test runner
│   └── suite/              # Test cases
└── types/                  # Type definitions
    └── cursorrules.ts      # Rule types

Key Features:

• TypeScript with strict type checking
• Comprehensive test coverage
• Modular architecture
• Extensible template system

Contact

Project Lead: garotm Repository: fleXRPL/cursor-rules-dynamic

License

This project is licensed under the MIT License - see the LICENSE file for details.

© Cursor Rules Dynamic 2024