@mallardbay/cursor-rules

Cursor Rules

A tool for managing Cursor IDE rules across different environment types with shared base configurations.

Overview

This project provides a structured way to manage Cursor IDE rules for different development environments while maintaining a shared base configuration. It supports three main environment types:

• frontend: Basic frontend development rules
• frontend-lib: Extended rules for frontend library development, inheriting from frontend rules
• backend: Backend development rules

Installation

npm install @mallardbay/cursor-rules

Usage

To set up Cursor rules for your project, run:

npx @mallardbay/cursor-rules <env-type>

Where <env-type> can be either:

• frontend
• frontend-lib
• backend

Example

# For frontend development
npx @mallardbay/cursor-rules frontend

# For frontend library development
npx @mallardbay/cursor-rules frontend-lib

# For backend development
npx @mallardbay/cursor-rules backend

Project Structure

The rules are organized in the following directory structure:

.cursor/
├── shared/
│   └── rules/     # Shared base rules
├── frontend/
│   └── rules/     # Frontend-specific rules
├── frontend-lib/
│   └── rules/     # Frontend library-specific rules
└── backend/
    └── rules/     # Backend-specific rules

Rule Inheritance

The rules follow an inheritance pattern:

• All environments include the shared base rules
• frontend-lib inherits rules from both frontend and frontend-lib directories

Development

Adding New Rules

1. Create .mdc files in the appropriate rules directory
2. Rules will be automatically copied to .cursor/rules/ when running the setup script

Directory Structure

• bin/setup-cursor.sh: Main setup script
• .cursor/shared/rules/: Shared base rules
• .cursor/frontend/rules/: Frontend-specific rules
• .cursor/frontend-lib/rules/: Frontend library-specific rules
• .cursor/backend/rules/: Backend-specific rules

License

[Add your license information here]