mcpField
P
pinia

pinia

github.com/antfuDevelopment6.0k19.9k installsUpdated 5d ago
Repository

About pinia

A Pinia skill offering references and recommendations for managing state in Vue applications. It covers stores, plugins, composability, testing, SSR, Nuxt, and hot module replacement, with TypeScript and devtools support described in the source.

Key features

  1. 01Store definitions, state, getters, and actions
  2. 02Plugins and store composition
  3. 03Testing and use outside components
  4. 04SSR, Nuxt, and HMR guidance
  5. 05Recommendations for reactive store usage

Use cases

  1. 01Structuring state in a Vue application
  2. 02Composing stores and using composables
  3. 03Testing stores with mocked state
  4. 04Managing stores in Nuxt or SSR

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/antfu/skills --skill pinia

After installing, type/piniain Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

GENERATION.md
references/
advanced-hmr.md
advanced-nuxt.md
advanced-ssr.md
best-practices-outside-component.md
best-practices-testing.md
core-stores.md
features-composables.md
features-composing-stores.md
features-plugins.md

Details

From the project README

Pinia

Pinia is the official state management library for Vue, designed to be intuitive and type-safe. It supports both Options API and Composition API styles, with first-class TypeScript support and devtools integration.

The skill is based on Pinia v4.0.3, generated at 2026-09-25.

Core References

TopicDescriptionReference
StoresDefining stores, state, getters, actions, storeToRefs, subscriptionscore-stores

Features

Extensibility
TopicDescriptionReference
PluginsExtend stores with custom properties, state, and behaviorfeatures-plugins
Composability
TopicDescriptionReference
ComposablesUsing Vue composables within stores (VueUse, etc.)features-composables
Composing StoresStore-to-store communication, avoiding circular dependenciesfeatures-composing-stores

Best Practices

TopicDescriptionReference
TestingUnit testing with @pinia/testing, mocking, stubbingbest-practices-testing
Outside ComponentsUsing stores in navigation guards, plugins, middlewaresbest-practices-outside-component

Advanced

TopicDescriptionReference
SSRServer-side rendering, state hydrationadvanced-ssr
NuxtNuxt integration, auto-imports, SSR best practicesadvanced-nuxt
HMRHot module replacement for developmentadvanced-hmr

Key Recommendations

  • Prefer Setup Stores for complex logic, composables, and watchers
  • Use storeToRefs() when destructuring state/getters to preserve reactivity
  • Actions can be destructured directly - they're bound to the store
  • Call stores inside functions not at module scope, especially for SSR
  • Add HMR support to each store for better development experience
  • Use @pinia/testing for component tests with mocked stores

Comments

Markdown supported