vue-best-practices

Guide Vue 3 projects toward Composition API, TypeScript, and SFC best practices.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/shuretokki/void --skill vue-best-practices-shuretokki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: vue-best-practices
Source: https://github.com/shuretokki/void/tree/main/.agents/skills/vue-best-practices
Command: npx skills add https://github.com/shuretokki/void --skill vue-best-practices-shuretokki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides an opinionated, operational workflow to prevent inconsistent patterns, fragile state, and poor component boundaries in Vue projects by enforcing modern Vue 3 practices and tooling guidance.

Core Features & Use Cases

  • Default stack enforcement: recommends Vue 3 + Composition API with <script setup> and TypeScript as the standard approach.
  • Architecture & planning: requires confirming architecture, planning component boundaries, and defining props/emits contracts before coding.
  • Foundational guidance: keeps reactivity minimal and predictable, prescribes SFC structure and template safety, and promotes small focused components and typed composables.
  • Target scenarios: ideal for migrating legacy Options API codebases, implementing new Vue 3 features, preparing SSR/Vite projects, and ensuring consistent developer tooling (Volar, vue-tsc).
  • Performance & final checks: advises post-functionality performance passes, virtualization for large lists, and a final self-check to ensure references and patterns were applied.

Quick Start

Use the vue-best-practices skill to review my Vue project and provide step-by-step changes to adopt Composition API with <script setup> and TypeScript for all relevant .vue files.

Frequently Asked Questions about vue-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I refactor a Vue 3 project to use Composition API and script setup?▼

Refactoring Vue 3 projects to Composition API requires confirming architecture, defining component boundaries, and establishing props/emits contracts before coding. You apply typed composables and Single-File Components with <script setup> and TypeScript to ensure maintainable component data flow.

What's the best way to structure Vue 3 Single-File Components with TypeScript?▼

The best way to structure Vue 3 Single-File Components is enforcing predictable reactivity and prescribed SFC structures while using <script setup> with TypeScript. This approach promotes small, focused components and typed composable patterns for consistent component data flow.

How do I migrate legacy Options API codebases to Vue 3 Composition API?▼

Migrating legacy Options API codebases involves converting to Vue 3 Composition API with <script setup> and TypeScript. You apply operational workflows to prevent inconsistent patterns and fragile state, ensuring predictable reactivity and typed composable patterns.

Does this Vue best practices guidance work with Pinia and Vue Router?▼

Yes, this Vue best practices guidance applies specifically to Vue 3 projects using Pinia and Vue Router. It enforces a default stack of Composition API with <script setup> and TypeScript while providing actionable guidance for state management and routing workflows.

Why should I use Volar and vue-tsc for Vue 3 development?▼

You should use Volar and vue-tsc to ensure consistent developer tooling and type checking in Vue 3 projects. These tools support TypeScript and Composition API workflows, preventing poor component boundaries and fragile state during implementation.

When do I need virtualization for large lists in Vue 3 applications?▼

You need virtualization for large lists during the post-functionality performance pass in Vue 3 applications. After implementing features with Composition API and TypeScript, you apply virtualization and final self-checks to ensure optimal performance and consistent patterns.