Skip to content

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.

Notifications You must be signed in to change notification settings

HugoRCD/nuxt-ui-rules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

For AI assistants with limited context β†’ Use the minimal rules

Using with Cursor

To integrate these guidelines with Cursor, follow these steps:

  1. Create a new file named nuxt-ui.mdc inside the .cursor/rules/ directory of your project.

  2. Copy the complete content from your chosen rule 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.

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project