nuxt-ui-rules

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 62 Open GitHub ↗

Comprehensive guidelines for AI assistants working with Nuxt UI v3. Prevents common v2→v3 migration errors and provides best practices for modern Nuxt UI development.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Guidelines for AI Assistants

Leverage the full power of Nuxt UI in your AI-powered workflow. These guidelines are designed to help AI coding assistants like Cursor, Windsurf, Claude Code, and others understand the best practices for working with the Nuxt UI component library.

## Available Rule Sets

We provide two versions of Nuxt UI rules to fit different needs:

### 📚 Complete Rules (`nuxt-ui.md`) - **Recommended**
- **~600 lines** - Comprehensive documentation and examples
- **Detailed breaking changes** - Full v2 → v3 migration guide
- **Advanced patterns** - Theming, performance, accessibility, TypeScript
- **Best for most projects and learning**

### 📋 Minimal Rules (`nuxt-ui-minimal.md`) 
- **~140 lines** - Optimized for AI assistants with token limits
- **Essential changes only** - Core breaking changes and patterns
- **Quick reference** - Most common pitfalls to avoid
- **For AI assistants with limited context**

## Getting Started

**Recommended** → Use the [complete rules](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1)

**For AI assistants with limited context** → Use the [minimal rules](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui-minimal.md?plain=1)

## Using with Cursor

**Option 1 - Via Settings Interface (Recommended)** 🎯
1. Open Cursor Settings (`Cmd/Ctrl + ,`)
2. Navigate to **"Rules for AI"** tab
3. Copy and paste your chosen rule content:
   - **Complete**: Copy from [nuxt-ui.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1)
   - **Minimal**: Copy from [nuxt-ui-minimal.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui-minimal.md?plain=1)

**Option 2 - Via File Configuration**
1. Create `.cursor/rules/nuxt-ui.mdc` in your project root
2. Copy your chosen rule content into this file

## Using with Claude Code

### On-Demand Context

Place your chosen rule file in your project directory, for instance, `rules/nuxt-ui.md`. Then, anytime you need Claude to understand Nuxt UI best practices, simply `@`-mention the file path in your prompt to load it into the current session's context.

nuxt-ui-rules

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README