🎯 Cursor Rules & Prompts

# 🎯 Cursor Rules & Prompts

> 💡 **Stop repeating yourself.** Make Cursor AI follow your coding standards automatically.

[![License](https://img.shields.io/badge/License-Proprietary-red.svg)](LICENSE)
[![Maintained](https://img.shields.io/badge/Maintained-Yes-success.svg)](https://github.com)

A comprehensive collection of rules and prompts that transform Cursor from a helpful assistant into a team member who knows your codebase conventions. These rules enforce best practices, maintain code quality, and ensure consistency—without you having to explain the same things over and over.

<div align="left">

<a href=".cursor/rules" style="text-decoration: none; display: inline-block; margin: 10px;">
  <img src="https://img.shields.io/badge/📋_RULES-4A90E2?style=for-the-badge&logo=book&logoColor=white" alt="Rules" style="height: 70px;"/>
</a>
<a href=".cursor/prompts" style="text-decoration: none; display: inline-block; margin: 10px;">
  <img src="https://img.shields.io/badge/💬_PROMPTS-50C878?style=for-the-badge&logo=lightbulb&logoColor=white" alt="Prompts" style="height: 70px;"/>
</a>

</div>

## 📖 What This Is

Ever find yourself constantly reminding Cursor to "use `@/` instead of relative paths" or "don't add inline styles"? This repository solves that. 🤯

Instead of manually correcting the AI every time, these rules ensure it follows your standards automatically. Think of it as a coding style guide that the AI actually reads, understands, and applies consistently across your entire project.

> 💼 **It's like having a senior developer review every AI-generated change before it hits your codebase.**

## Key Features

✨ **Automatic Enforcement** - Rules apply automatically, no manual intervention needed  
🎯 **Project-Agnostic** - Works with any tech stack, easily customizable  
📚 **Comprehensive** - Covers code style, organization, documentation, and more  
🔄 **Maintainable** - Well-organized, easy to understand and modify  
🚀 **Time-Saving** - Stop repeating the same instructions to AI

## 🎁 Why Use This

- ✅ **Consistency**: Your codebase stays consistent even when multiple people (or AI) work on it
- ⚡ **Less Review Time**: Fewer style issues means faster code reviews
- 🚀 **Better Onboarding**: New team members (and AI) understand your patterns immediately
- 🛡️ **Quality by Default**: Best practices are enforced automatically, not by memory
- ⏱️ **Time Savings**: Stop explaining the same conventions repeatedly

## 💡 Real-World Example

**❌ Before**: You ask Cursor to create a component, and it generates:
```typescript
import { Button } from '../../../components/ui/button';
import { MyType } from '../types';
```

**✅ After**: With these rules, Cursor automatically generates:
```typescript
import { Button } from '@/components/ui/button';
import { MyType } from '@/components/quiz/types';
```

🎉 The AI knows your conventions and follows them without being told!

## 🚀 Quick Start

### Option 1: Manual Setup
1. 📥 **Clone or copy this repository** into your project
2. 📁 **Place the `.cursor` folder** in your project root
3. ✨ **That's it** - Cursor will automatically use these rules

### Option 2: Automatic Sync (Recommended)
Use the sync script to automatically keep your `.cursor` directory updated across all your projects:

```bash
# Add alias to ~/.zshrc (or ~/.bashrc)
alias sync-cursor="~/PycharmProjects/cursor-rules-and-prompts/sync-cursor.sh"

# Reload shell configuration
source ~/.zshrc

# Run sync from any directory
sync-cursor
```

> 📌 **Sync Script:** `sync-cursor.sh`
> 
> ⚠️ **Important:** The script requires a `.include` file in each destination's `.cursor/` directory to specify what to sync. See [sync-cursor.md](docs/sync-cursor.md) for detailed documentation.

The script will:
- 🔄 Sync files from source to all destinations in `~/PycharmProjects/`
- 🆔 Use ID-based matching to handle file renames and updates
- 📁 Support path-based syncing via `.include` file
- 🗑️ Automatically clean up orphaned files
- 📊 Show progress for each destination

> 💡 **Note:** The old `fetch-cursor-rules.sh` script is deprecated. Use `sync-cursor.sh` instead. See [sync-cursor.md](docs/sync-cursor.md) for full documentation.

> 💬 The rules are organized by category and apply automatically when you're working in Cursor. No configuration needed.

## 📦 What's Included

This repository contains a growing collection of rules and prompts organized by category. The rules cover areas like:

- 🎨 **Code Style**: Import patterns, component structure, styling conventions
- 📂 **Organization**: File structure, feature organization, code migration
- 📝 **Documentation**: Writing standards, comment style, documentation patterns
- 🏗️ **Infrastructure**: Route management, configuration patterns
- 🚫 **Constraints**: What to avoid, best practices
- 📚 **Dependencies**: Library selection, component usage

> 📍 Rules are stored in `.cursor/rules/` organized by category, and reusable prompts are in `.cursor/prompts/`. The 

... (truncated)