All skills
hyf0 avatar

/vue-best-practices

@b9d14d0 official
by hyf0hyf0/vue-skills2.9k stars
167

MUST be used for Vue.js tasks. Strongly recommends Composition API with `<script setup>` and TypeScript as the standard approach. Covers Vue 3, SSR, Volar, vue-tsc. Load for any Vue, .vue files, Vue Router, Pinia, or Vite with Vue work. ALWAYS use Composition API unless the project explicitly requires Options API.

Use this Skill: https://skilld.dev/gh/hyf0/vue-skills/vue-best-practices

This session only. Nothing lands on disk.

referencesstate-management.md

≈845 tokens on demand. Your agent reads this file only when SKILL.md points to it.

State Management Strategy

Impact: HIGH - Use the lightest state solution that fits your app architecture. SPA-only apps can use lightweight global composables, while SSR/Nuxt apps should default to Pinia for request-safe isolation and predictable tooling.

Task List

  • Keep state local first, then promote to shared/global only when needed
  • Use singleton composables only in non-SSR applications
  • Expose global state as readonly and mutate through explicit actions
  • Prefer Pinia for SSR/Nuxt, large apps, and advanced debugging/plugin needs
  • Avoid exporting mutable module-level reactive state directly

Choose the Lightest Store Approach

  • Feature composable: Default for reusable logic with local/feature-level state.
  • Singleton composable or VueUse createGlobalState: Small non-SSR apps needing shared app state.
  • Pinia: SSR/Nuxt apps, medium-to-large apps, and cases requiring DevTools, plugins, or action tracing.

Avoid Exporting Mutable Module State

BAD:

// store/cart.ts
import { reactive } from 'vue'

export const cart = reactive({
  items: [] as Array<{ id: string; qty: number }>
})

GOOD:

// composables/useCartStore.ts
import { reactive, readonly } from 'vue'

let _store: ReturnType<typeof createCartStore> | null = null

function createCartStore() {
  const state = reactive({
    items: [] as Array<{ id: string; qty: number }>
  })

  function addItem(id: string, qty = 1) {
    const existing = state.items.find((item) => item.id === id)
    if (existing) {
      existing.qty += qty
      return
    }
    state.items.push({ id, qty })
  }

  return {
    state: readonly(state),
    addItem
  }
}

export function useCartStore() {
  if (!_store) _store = createCartStore()
  return _store
}

Do Not Use Runtime Singletons in SSR

Module singletons live for the runtime lifetime. In SSR this can leak state between requests.

BAD:

// shared singleton reused across requests
const cartStore = useCartStore()

export function useServerCart() {
  return cartStore
}

GOOD:

pinia dependency required.

// stores/cart.ts
import { defineStore } from 'pinia'

export const useCartStore = defineStore('cart', {
  state: () => ({
    items: [] as Array<{ id: string; qty: number }>
  }),
  actions: {
    addItem(id: string, qty = 1) {
      const existing = this.items.find((item) => item.id === id)
      if (existing) {
        existing.qty += qty
        return
      }
      this.items.push({ id, qty })
    }
  }
})

Use createGlobalState for Small SPA Global State

@vueuse/core dependency required.

If the app is non-SSR and already uses VueUse, createGlobalState removes singleton boilerplate.

import { createGlobalState } from '@vueuse/core'
import { computed, ref } from 'vue'

export const useAuthState = createGlobalState(() => {
  const token = ref<string | null>(null)
  const isAuthenticated = computed(() => token.value !== null)

  function setToken(next: string | null) {
    token.value = next
  }

  return {
    token,
    isAuthenticated,
    setToken
  }
})

Source: SKILL.md on GitHub

No alerts16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides a comprehensive set of best practices for Vue.js development, focusing on the Composition API, reactivity, and performance optimization. It includes standard coding guidelines and explicitly recommends security best practices such as sanitizing untrusted content to prevent XSS.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer7mo

    23 files scanned · No issues

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at b9d14d0. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 months ago.

Steadyupdated 8 months ago
metadata
{
  "author": "github.com/vuejs-ai",
  "version": "18.0.0"
}
  • Vue
  • TypeScript
  • composition-api
  • vue3
  • best-practices
  • component-design
  • reactivity
  • vite

README badge

README badge for hyf0/vue-skills/vue-best-practices

Provides a structured workflow for Vue 3 development using Composition API with `<script setup>` and TypeScript. Covers component splitting, reactivity patterns, data flow, composables, and optional features like transitions and async components, with performance optimization as a post-functionality pass.

Generated from the current SKILL.md.

Does this skill work with Vue 2 or only Vue 3?
This skill targets Vue 3 with Composition API and `<script setup>`. For Vue 2 or Options API projects, it recommends loading alternative skills if available.
Should I use Options API or Composition API with this skill?
Always use Composition API with `<script setup>` and TypeScript unless the project explicitly requires Options API, in which case you should load the `vue-options-api-best-practices` skill instead.
Does this skill provide reference documentation or just instructions?
The skill includes must-read references covering reactivity, SFC structure, component data flow, and composables that should be kept in active context throughout your work.
When should I add features like slots, Teleport, or Transition?
These optional features should only be loaded when your requirements explicitly call for them. The skill defaults to simpler patterns and treats advanced features as post-functionality additions.
Does this skill require TypeScript?
Yes. The skill strongly recommends TypeScript as part of the standard Composition API + `<script setup>` approach for Vue 3.

Generated from the current SKILL.md. These answers refresh after source changes.