К основному содержанию
правило CX Codex

vue · sanjeed5 — правило для Cursor: что делает и как установить

Задаёт строгие стандарты для Vue 3: синтаксис <script setup>, Composition API, Pinia и чистые вычисляемые свойства. Применяется к файлам .vue, .js и .ts.

CC0-1.0 ★ 3 589 обновлён 2026-05-19

Установить в Cursor · Вручную: положить файлы Все способы и платформы ↓
.cursor/rules/vue.mdc
Открыть на GitHub

Что делает vue

Правило ориентирует модель на современный стек Vue 3. Оно запрещает смешивать несколько компонентов в одном файле и требует именовать файлы однофайловых компонентов в PascalCase. Для базовых презентационных компонентов предписаны префиксы Base, App или V, а для дочерних элементов родительского блока — составные имена вроде UserProfileAvatar.vue.

В шаблонах и скриптах закрепляется конкретный стиль: обязательный :key для циклов v-for, запрет на совместное использование v-if и v-for в одном теге в пользу computed, события в kebab-case и строгая валидация входных параметров через defineProps. Вычисляемые свойства должны оставаться чистыми функциями без сайд-эффектов вроде мутации исходных массивов.

Для глобального состояния правило прямо предписывает Pinia вместо устаревшего Vuex, требуя сохранять реактивность через storeToRefs. В кодовой базе на Vue 2 или старом Options API эти указания приведут к несовместимому коду.

Какие задачи решает

  • избавиться от устаревшего Options API и перехода на <script setup>
  • предотвратить неэффективную фильтрацию списков при совмещении v-if с v-for
  • навести порядок в именовании дочерних и презентационных компонентов
  • перевести хранение глобального состояния с Vuex на Pinia
  • обеспечить строгую типизацию и валидацию входящих props

Примеры запросов агенту

  • Создай компонент списка задач с валидацией пропсов и фильтрацией через computed
  • Вынеси аватар пользователя из UserProfile в отдельный связанный компонент по правилам именования
  • Подключи хранилище Pinia к компоненту профиля с сохранением реактивности через storeToRefs

Как установить vue

Вручную: положить файлы

.cursor/rules/vue.mdc

Во frontmatter: description, globs, alwaysApply

По шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules

Вопросы о vue

Как установить правило vue в Cursor?

Создайте файл .cursor/rules/vue.mdc в корне вашего проекта и добавьте в него текст правила.

Для каких файлов срабатывает это правило?

В секции globs правила указана маска **/*.{vue,js,ts}, поэтому ассистент применяет его ко всем файлам компонентов Vue, скриптам JavaScript и TypeScript.

Почему правило запрещает писать v-if вместе с v-for?

Директива v-for имеет более высокий приоритет, из-за чего итерация проходит по всему списку до фильтрации. Правило требует предварительно фильтровать элементы внутри чистого computed.

Исходный текст

vue.mdc · CC0-1.0
---
description: This guide provides definitive, opinionated best practices for writing clean, performant, and maintainable Vue 3 applications using modern patterns like the Composition API and Pinia.
globs: **/*.{vue,js,ts}
---
# Vue Best Practices

This document outlines the definitive best practices for Vue 3 development. Adhere to these guidelines to ensure consistent, high-quality, and performant code across our projects.

## Code Organization and Structure

### 1. Single-File Components (SFCs) Per File

Always place each Vue component in its own `.vue` file. This improves discoverability, modularity, and version control.

❌ BAD
```vue
<!-- components/TodoList.vue -->
<template>...</template>
<script>
export default {
  // ... TodoList logic
}
</script>

<!-- components/TodoItem.vue (in the same file) -->
<template>...</template>
<script>
export default {
  // ... TodoItem logic
}
</script>
```

✅ GOOD
```vue
<!-- components/TodoList.vue -->
<template>...</template>
<script setup>
// ... TodoList logic
</script>

<!-- components/TodoItem.vue -->
<template>...</template>
<script setup>
// ... TodoItem logic
</script>
```

### 2. Consistent Component Naming

Use **PascalCase** for Single-File Component filenames (e.g., `MyComponent.vue`). This aligns with how components are referenced in templates and JavaScript, improving IDE autocompletion.

❌ BAD
```
components/
├── my-component.vue
└── Mycomponent.vue
```

✅ GOOD
```
components/
├── MyComponent.vue
└── AnotherComponent.vue
```

### 3. Base Component Prefixing

Prefix "base" or "presentational" components (those that only contain HTML, other base components, or 3rd-party UI components, and no global state) with `Base`, `App`, or `V`.

❌ BAD
```
components/
├── Button.vue
└── Icon.vue
```

✅ GOOD
```
components/
├── BaseButton.vue
└── BaseIcon.vue
```

### 4. Tightly Coupled Component Naming

Child components tightly coupled to a single parent must include the parent's name as a prefix. This groups related files alphabetically and clarifies relationships.

❌ BAD
```
components/
├── UserProfile.vue
├── Avatar.vue
└── EditButton.vue
```

✅ GOOD
```
components/
├── UserProfile.vue
├── UserProfileAvatar.vue
└── UserProfileEditButton.vue
```

## Common Patterns and Anti-patterns

### 5. Always Use `key` with `v-for`

Provide a unique `key` attribute on `v-for` loops. This gives Vue a stable reference for each item, crucial for efficient DOM updates, transitions, and component state management.

❌ BAD
```vue
<template>
  <div v-for="item in items">{{ item.name }}</div>
</template>
```

✅ GOOD
```vue
<template>
  <div v-for="item in items" :key="item.id">{{ item.name }}</div>
</template>
```

### 6. Kebab-Case for Custom Events

Emit and listen to custom events using `kebab-case`. This is consistent with HTML event naming conventions.

❌ BAD
```vue
<!-- ChildComponent.vue -->
<script setup>
const emit = defineEmits(['closeWindow']);
emit('closeWindow');
</script>

<!-- ParentComponent.vue -->
<template>
  <ChildComponent @closeWindow="handleClose" />
</template>
```

✅ GOOD
```vue
<!-- ChildComponent.vue -->
<script setup>
const emit = defineEmits(['close-window']);
emit('close-window');
</script>

<!-- ParentComponent.vue -->
<template>
  <ChildComponent @close-window="handleClose" />
</template>
```

### 7. Prop Naming Consistency

Declare props in `camelCase` within `<script setup>`, but use `kebab-case` when passing them in templates. Vue automatically handles the conversion.

❌ BAD
```vue
<!-- ChildComponent.vue -->
<script setup>
defineProps({
  titletext: String,
});
</script>

<!-- ParentComponent.vue -->
<template>
  <ChildComponent titletext="Hello" />
</template>
```

✅ GOOD
```vue
<!-- ChildComponent.vue -->
<script setup>
defineProps({
  titleText: String, // camelCase in script
});
</script>

<!-- ParentComponent.vue -->
<template>
  <ChildComponent title-text="Hello" /> <!-- kebab-case in template -->
</template>
```

### 8. Validate Props Explicitly

Always define prop types, `required` flags, and custom validators. This prevents runtime errors, improves component API clarity, and acts as self-documentation.

❌ BAD
```vue
<script setup>
defineProps(['status', 'count']);
</script>
```

✅ GOOD
```vue
<script setup>
defineProps({
  status: {
    type: String,
    required: true,
    validator: (value) => ['syncing', 'synced', 'error'].includes(value),
  },
  count: {
    type: Number,
    default: 0,
  },
});
</script>
```

### 9. Avoid `v-if` on `v-for` Elements

Never use `v-if` directly on an element with `v-for`. `v-for` takes precedence, leading to inefficient iteration over the entire list before filtering. Filter the list in a `computed` property instead.

❌ BAD
```vue
<template>
  <div v-for="product in products" v-if="product.price < 500">
    {{ product.name }}
  </div>
</template>
```

✅ GOOD
```vue
<script setup>
import { computed, ref } from 'vue';

const products = ref([/* ... */]);
const cheapProducts = computed(() => {
  return products.value.filter((product) => product.price < 500);
});
</script>

<template>
  <div v-for="product in cheapProducts" :key="product.id">
    {{ product.name }}
  </div>
</template>
```

## Performance Considerations

### 10. Pure and Deterministic Computed Properties

Write computed properties that are pure and deterministic (given the same inputs, they always produce the same output). This allows Vue's reactivity engine to cache results aggressively, boosting performance. Avoid side effects within computed properties.

❌ BAD
```vue
<script setup>
import { computed, ref } from 'vue';
const items = ref([1, 2, 3]);
const expensiveComputation = computed(() => {
  // Side effect: Modifies items, making it non-deterministic
  items.value.push(Math.random());
  return items.value.reduce((sum, val) => sum + val, 0);
});
</script>
```

✅ GOOD
```vue
<script setup>
import { computed, ref } from 'vue';
const items = ref([1, 2, 3]);
const sumOfItems = computed(() => {
  // Pure: Only depends on items.value, no side effects
  return items.value.reduce((sum, val) => sum + val, 0);
});
</script>
```

## State Management

### 11. Use Pinia for Global State

For global or complex shared state, use Pinia. It's the official and recommended state management library for Vue 3, offering a simpler API, better TypeScript support, and smaller bundle sizes than Vuex.

❌ BAD
```vue
<!-- Using Vuex (older pattern) -->
<script setup>
import { useStore } from 'vuex';
const store = useStore();
const user = computed(() => store.state.user);
</script>
```

✅ GOOD
```vue
<!-- Using Pinia -->
<script setup>
import { useUserStore } from '@/stores/user'; // Assuming @/stores/user.js
import { storeToRefs } from 'pinia';

const userStore = useUserStore();
const { user } = storeToRefs(userStore); // Keep reactivity for state properties
</script>
```

© sanjeed5 · CC0-1.0 · sanjeed5/awesome-cursor-rules-mdc

Похожие правила IDE

Все правила IDE по теме «Фронтенд и UI» →

Сначала — vue от других авторов.

vue официальный github Задаёт стандарты разработки на Vue 3. Подключается как файл инструкций и направляет Copilot при работе с компонентами, реактивностью, Pinia и TypeScript. CX Codex +1 ★ 41 430звёзд репо vue PatrickJS Задаёт агенту стиль работы с Vue: Composition API, Pinia, типизация и маршрутизация. Срабатывает на файлах .vue и .ts в проектах, где уже используется Vue. CX Codex +1 ★ 41 178звёзд репо vue-development travisjneuman Скилл vue-development для Claude Code помогает писать код на Vue 3 с синтаксисом Composition API и Script Setup. Подключается при настройке Pinia, создании композаблов и разработке на Nuxt 3. CX Codex +1 143установок vue-expert https://github.com/Jeffallan Скилл vue-expert для Claude Code пишет код на Vue 3 с Composition API, настраивает Nuxt 3, Pinia и Vite. Создаёт компоненты, PWA и гибридные приложения. CX Codex +1 4 800установок vue-best-practices github.com/vuejs-ai Скилл vue-best-practices задаёт стандарты разработки на Vue 3 с Composition API и TypeScript. Пригодится при написании SFC-компонентов, composables и настройке реактивности. CX Codex +1 45 800установок Expert Vue.js Frontend Engineer официальный github Субагент Expert Vue.js Frontend Engineer для GitHub Copilot, который пишет и правит фронтенд на Vue 3 с TypeScript. Берёт на себя компоненты, сторы Pinia, тесты и вопросы производительности в одном рабочем цикле. CX Codex +1 ★ 41 430звёзд репо script-setup patterns.dev Учит агента писать Vue 3-компоненты с <script setup> — без лишнего кода и явного return. CX Codex +1 195установок vue-expert-js https://github.com/Jeffallan Скилл vue-expert-js для Claude Code создаёт код Vue 3 на JavaScript с JSDoc-аннотациями вместо TypeScript. Создаёт компоненты, композаблы, роутинг и состояние в проектах без TS. CX Codex +1 4 400установок

Из того же набора241

Весь набор →
zod Задаёт стандарты работы с Zod: строгий режим TypeScript, вывод типов из схем и проверка данных на входе. CX Codex +1 ★ 3 589звёзд репо xgboost Задаёт стандарты работы с библиотекой xgboost в Python: однократную сборку DMatrix, выбор tree_method='hist' и оформление докстрингов по стилю NumPy. CX Codex +1 ★ 3 589звёзд репо webpack Правило подсказывает Cursor, как организовать webpack-конфигурацию и настроить сборку. Пригодится при работе с JavaScript-проектом, где нужны отдельные настройки для разработки и production. CX Codex +1 ★ 3 589звёзд репо vue3 Задаёт единый стиль Vue 3: Composition API, TypeScript, ESLint и Prettier. Выравнивает код в проектах с несколькими разработчиками. CX Codex +1 ★ 3 589звёзд репо vllm Правило задаёт рекомендации для Python-кода с vLLM: настройка окружения, организация инференса, производительность и наблюдаемость. Пригодится при разработке сервиса генерации на GPU. CX Codex +1 ★ 3 589звёзд репо vitest Правило задаёт Cursor, как писать юнит- и интеграционные тесты на Vitest: где держать файлы, как изолировать кейсы и мокать модули. CX Codex +1 ★ 3 589звёзд репо vite Задаёт стандарты проектов на Vite: требует чистый конфиг, прямой импорт модулей без barrel-файлов и использование import.meta.env. CX Codex +1 ★ 3 589звёзд репо vim Правило помогает Cursor подготовить настройки Vim и Neovim: от структуры конфигурации до ленивой загрузки плагинов и работы с LSP. CX Codex +1 ★ 3 589звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой