@exelalfanso/puppets-orchestration 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (345) hide show
  1. package/.agents/architect.md +29 -0
  2. package/.agents/backend.md +33 -0
  3. package/.agents/debugger.md +29 -0
  4. package/.agents/explorer.md +29 -0
  5. package/.agents/frontend.md +33 -0
  6. package/.agents/orchestrator.md +35 -0
  7. package/.agents/reviewer.md +42 -0
  8. package/.agents/tester.md +29 -0
  9. package/.agents/worker-skills.md +24 -0
  10. package/AGENTS.md +33 -0
  11. package/README.md +150 -0
  12. package/bin/puppets.mjs +152 -0
  13. package/docs/README.md +64 -0
  14. package/docs/architecture/decisions/README.md +36 -0
  15. package/docs/architecture/overview.md +41 -0
  16. package/docs/engineering/conventions.md +30 -0
  17. package/docs/engineering/project-orchestration.md +118 -0
  18. package/docs/engineering/testing-strategy.md +41 -0
  19. package/docs/javascript-typescript-stack.md +59 -0
  20. package/docs/product/PRD.md +56 -0
  21. package/docs/requirements/SRS.md +35 -0
  22. package/package.json +20 -0
  23. package/skills/README.md +12 -0
  24. package/skills/be/backend-architect/SKILL.md +333 -0
  25. package/skills/be/backend-development-feature-development/SKILL.md +180 -0
  26. package/skills/be/backend-security-coder/SKILL.md +156 -0
  27. package/skills/be/nodejs-backend-patterns/SKILL.md +35 -0
  28. package/skills/be/nodejs-backend-patterns/resources/implementation-playbook.md +1019 -0
  29. package/skills/fe/frontend-design/LICENSE.txt +177 -0
  30. package/skills/fe/frontend-design/SKILL.md +71 -0
  31. package/skills/fe/web-design-guidelines/SKILL.md +39 -0
  32. package/skills/qa/ai-qa-review/SKILL.md +357 -0
  33. package/skills/qa/ai-qa-review/references/mutation-testing.md +38 -0
  34. package/skills/qa/ai-qa-review/references/smell-examples.md +232 -0
  35. package/skills/qa/ai-qa-review/references/testability-refactors.md +97 -0
  36. package/skills/qa/coverage-analysis/SKILL.md +308 -0
  37. package/skills/qa/coverage-analysis/references/ci-gating.md +132 -0
  38. package/skills/qa/coverage-analysis/references/mutation-testing.md +29 -0
  39. package/skills/qa/coverage-analysis/references/tool-config.md +195 -0
  40. package/skills/qa/qa-project-context/SKILL.md +289 -0
  41. package/skills/qa/qa-project-context/references/examples.md +237 -0
  42. package/skills/qa/release-readiness/SKILL.md +443 -0
  43. package/skills/qa/release-readiness/references/communication-templates.md +38 -0
  44. package/skills/qa/release-readiness/references/rollout-automation.md +47 -0
  45. package/skills/qa/risk-based-testing/SKILL.md +337 -0
  46. package/skills/qa/risk-based-testing/references/examples.md +81 -0
  47. package/skills/react/vercel-composition-patterns/AGENTS.md +946 -0
  48. package/skills/react/vercel-composition-patterns/README.md +60 -0
  49. package/skills/react/vercel-composition-patterns/SKILL.md +89 -0
  50. package/skills/react/vercel-composition-patterns/rules/_sections.md +29 -0
  51. package/skills/react/vercel-composition-patterns/rules/_template.md +24 -0
  52. package/skills/react/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
  53. package/skills/react/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
  54. package/skills/react/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
  55. package/skills/react/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
  56. package/skills/react/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
  57. package/skills/react/vercel-composition-patterns/rules/state-context-interface.md +191 -0
  58. package/skills/react/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
  59. package/skills/react/vercel-composition-patterns/rules/state-lift-state.md +125 -0
  60. package/skills/react/vercel-react-best-practices/AGENTS.md +3810 -0
  61. package/skills/react/vercel-react-best-practices/README.md +123 -0
  62. package/skills/react/vercel-react-best-practices/SKILL.md +149 -0
  63. package/skills/react/vercel-react-best-practices/rules/_sections.md +46 -0
  64. package/skills/react/vercel-react-best-practices/rules/_template.md +28 -0
  65. package/skills/react/vercel-react-best-practices/rules/advanced-effect-event-deps.md +56 -0
  66. package/skills/react/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
  67. package/skills/react/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
  68. package/skills/react/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
  69. package/skills/react/vercel-react-best-practices/rules/async-api-routes.md +38 -0
  70. package/skills/react/vercel-react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
  71. package/skills/react/vercel-react-best-practices/rules/async-defer-await.md +82 -0
  72. package/skills/react/vercel-react-best-practices/rules/async-dependencies.md +51 -0
  73. package/skills/react/vercel-react-best-practices/rules/async-parallel.md +28 -0
  74. package/skills/react/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
  75. package/skills/react/vercel-react-best-practices/rules/bundle-analyzable-paths.md +63 -0
  76. package/skills/react/vercel-react-best-practices/rules/bundle-barrel-imports.md +60 -0
  77. package/skills/react/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
  78. package/skills/react/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
  79. package/skills/react/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
  80. package/skills/react/vercel-react-best-practices/rules/bundle-preload.md +50 -0
  81. package/skills/react/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
  82. package/skills/react/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
  83. package/skills/react/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
  84. package/skills/react/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
  85. package/skills/react/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
  86. package/skills/react/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
  87. package/skills/react/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
  88. package/skills/react/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
  89. package/skills/react/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
  90. package/skills/react/vercel-react-best-practices/rules/js-early-exit.md +50 -0
  91. package/skills/react/vercel-react-best-practices/rules/js-flatmap-filter.md +60 -0
  92. package/skills/react/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
  93. package/skills/react/vercel-react-best-practices/rules/js-index-maps.md +37 -0
  94. package/skills/react/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
  95. package/skills/react/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
  96. package/skills/react/vercel-react-best-practices/rules/js-request-idle-callback.md +105 -0
  97. package/skills/react/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
  98. package/skills/react/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
  99. package/skills/react/vercel-react-best-practices/rules/rendering-activity.md +26 -0
  100. package/skills/react/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
  101. package/skills/react/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
  102. package/skills/react/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
  103. package/skills/react/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
  104. package/skills/react/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
  105. package/skills/react/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
  106. package/skills/react/vercel-react-best-practices/rules/rendering-resource-hints.md +85 -0
  107. package/skills/react/vercel-react-best-practices/rules/rendering-script-defer-async.md +68 -0
  108. package/skills/react/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
  109. package/skills/react/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
  110. package/skills/react/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
  111. package/skills/react/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
  112. package/skills/react/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
  113. package/skills/react/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
  114. package/skills/react/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
  115. package/skills/react/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
  116. package/skills/react/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
  117. package/skills/react/vercel-react-best-practices/rules/rerender-memo.md +44 -0
  118. package/skills/react/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
  119. package/skills/react/vercel-react-best-practices/rules/rerender-no-inline-components.md +82 -0
  120. package/skills/react/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
  121. package/skills/react/vercel-react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
  122. package/skills/react/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
  123. package/skills/react/vercel-react-best-practices/rules/rerender-use-deferred-value.md +59 -0
  124. package/skills/react/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
  125. package/skills/react/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
  126. package/skills/react/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
  127. package/skills/react/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
  128. package/skills/react/vercel-react-best-practices/rules/server-cache-react.md +76 -0
  129. package/skills/react/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
  130. package/skills/react/vercel-react-best-practices/rules/server-hoist-static-io.md +149 -0
  131. package/skills/react/vercel-react-best-practices/rules/server-no-shared-module-state.md +50 -0
  132. package/skills/react/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
  133. package/skills/react/vercel-react-best-practices/rules/server-parallel-nested-fetching.md +34 -0
  134. package/skills/react/vercel-react-best-practices/rules/server-serialization.md +38 -0
  135. package/skills/vue/create-adaptable-composable/SKILL.md +76 -0
  136. package/skills/vue/vue-best-practices/SKILL.md +154 -0
  137. package/skills/vue/vue-best-practices/references/animation-class-based-technique.md +254 -0
  138. package/skills/vue/vue-best-practices/references/animation-state-driven-technique.md +291 -0
  139. package/skills/vue/vue-best-practices/references/component-async.md +97 -0
  140. package/skills/vue/vue-best-practices/references/component-data-flow.md +307 -0
  141. package/skills/vue/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
  142. package/skills/vue/vue-best-practices/references/component-keep-alive.md +137 -0
  143. package/skills/vue/vue-best-practices/references/component-slots.md +216 -0
  144. package/skills/vue/vue-best-practices/references/component-suspense.md +228 -0
  145. package/skills/vue/vue-best-practices/references/component-teleport.md +108 -0
  146. package/skills/vue/vue-best-practices/references/component-transition-group.md +128 -0
  147. package/skills/vue/vue-best-practices/references/component-transition.md +125 -0
  148. package/skills/vue/vue-best-practices/references/composables.md +290 -0
  149. package/skills/vue/vue-best-practices/references/directives.md +162 -0
  150. package/skills/vue/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
  151. package/skills/vue/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
  152. package/skills/vue/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
  153. package/skills/vue/vue-best-practices/references/plugins.md +166 -0
  154. package/skills/vue/vue-best-practices/references/reactivity.md +344 -0
  155. package/skills/vue/vue-best-practices/references/render-functions.md +201 -0
  156. package/skills/vue/vue-best-practices/references/sfc.md +310 -0
  157. package/skills/vue/vue-best-practices/references/state-management.md +135 -0
  158. package/skills/vue/vue-best-practices/references/updated-hook-performance.md +187 -0
  159. package/skills/vue/vue-debug-guides/SKILL.md +202 -0
  160. package/skills/vue/vue-debug-guides/reference/animation-key-for-rerender.md +160 -0
  161. package/skills/vue/vue-debug-guides/reference/animation-transitiongroup-performance.md +241 -0
  162. package/skills/vue/vue-debug-guides/reference/async-component-error-handling.md +115 -0
  163. package/skills/vue/vue-debug-guides/reference/async-component-keepalive-ref-issue.md +112 -0
  164. package/skills/vue/vue-debug-guides/reference/async-component-suspense-control.md +84 -0
  165. package/skills/vue/vue-debug-guides/reference/async-component-vue-router.md +109 -0
  166. package/skills/vue/vue-debug-guides/reference/attrs-event-listener-merging.md +205 -0
  167. package/skills/vue/vue-debug-guides/reference/checkbox-true-false-value-form-submission.md +118 -0
  168. package/skills/vue/vue-debug-guides/reference/cleanup-side-effects.md +172 -0
  169. package/skills/vue/vue-debug-guides/reference/click-events-on-components.md +180 -0
  170. package/skills/vue/vue-debug-guides/reference/component-naming-conflicts.md +159 -0
  171. package/skills/vue/vue-debug-guides/reference/component-ref-requires-defineexpose.md +176 -0
  172. package/skills/vue/vue-debug-guides/reference/composable-avoid-hidden-side-effects.md +208 -0
  173. package/skills/vue/vue-debug-guides/reference/composable-call-location-restrictions.md +141 -0
  174. package/skills/vue/vue-debug-guides/reference/composable-naming-return-pattern.md +139 -0
  175. package/skills/vue/vue-debug-guides/reference/composable-tovalue-inside-watcheffect.md +182 -0
  176. package/skills/vue/vue-debug-guides/reference/composition-api-not-functional-programming.md +120 -0
  177. package/skills/vue/vue-debug-guides/reference/composition-api-script-setup-async-context.md +203 -0
  178. package/skills/vue/vue-debug-guides/reference/composition-api-vs-react-hooks-differences.md +156 -0
  179. package/skills/vue/vue-debug-guides/reference/computed-array-mutation.md +148 -0
  180. package/skills/vue/vue-debug-guides/reference/computed-conditional-dependencies.md +147 -0
  181. package/skills/vue/vue-debug-guides/reference/computed-no-parameters.md +159 -0
  182. package/skills/vue/vue-debug-guides/reference/computed-no-side-effects.md +107 -0
  183. package/skills/vue/vue-debug-guides/reference/computed-return-value-readonly.md +160 -0
  184. package/skills/vue/vue-debug-guides/reference/configure-app-before-mount.md +89 -0
  185. package/skills/vue/vue-debug-guides/reference/declare-emits-for-documentation.md +212 -0
  186. package/skills/vue/vue-debug-guides/reference/define-expose-before-await.md +192 -0
  187. package/skills/vue/vue-debug-guides/reference/define-model-default-value-sync.md +139 -0
  188. package/skills/vue/vue-debug-guides/reference/defineEmits-must-be-top-level.md +164 -0
  189. package/skills/vue/vue-debug-guides/reference/defineEmits-no-runtime-and-type-mixed.md +170 -0
  190. package/skills/vue/vue-debug-guides/reference/definemodel-object-mutation-no-emit.md +148 -0
  191. package/skills/vue/vue-debug-guides/reference/dom-update-timing-nexttick.md +90 -0
  192. package/skills/vue/vue-debug-guides/reference/dynamic-argument-constraints.md +146 -0
  193. package/skills/vue/vue-debug-guides/reference/dynamic-component-registration-vite.md +147 -0
  194. package/skills/vue/vue-debug-guides/reference/event-modifier-order-matters.md +101 -0
  195. package/skills/vue/vue-debug-guides/reference/exact-modifier-for-precise-shortcuts.md +155 -0
  196. package/skills/vue/vue-debug-guides/reference/fallthrough-attrs-overwrite-vue3.md +159 -0
  197. package/skills/vue/vue-debug-guides/reference/in-dom-template-parsing-caveats.md +149 -0
  198. package/skills/vue/vue-debug-guides/reference/inheritattrs-false-for-wrapper-components.md +230 -0
  199. package/skills/vue/vue-debug-guides/reference/keepalive-router-nested-double-mount.md +222 -0
  200. package/skills/vue/vue-debug-guides/reference/keepalive-transition-memory-leak.md +144 -0
  201. package/skills/vue/vue-debug-guides/reference/keyup-modifier-timing.md +137 -0
  202. package/skills/vue/vue-debug-guides/reference/lifecycle-dom-access-timing.md +216 -0
  203. package/skills/vue/vue-debug-guides/reference/lifecycle-hooks-synchronous-registration.md +156 -0
  204. package/skills/vue/vue-debug-guides/reference/lifecycle-ssr-awareness.md +184 -0
  205. package/skills/vue/vue-debug-guides/reference/local-components-not-in-descendants.md +151 -0
  206. package/skills/vue/vue-debug-guides/reference/mount-return-value.md +88 -0
  207. package/skills/vue/vue-debug-guides/reference/multi-root-component-class-attrs.md +93 -0
  208. package/skills/vue/vue-debug-guides/reference/native-event-collision-with-emits.md +162 -0
  209. package/skills/vue/vue-debug-guides/reference/no-passive-with-prevent.md +141 -0
  210. package/skills/vue/vue-debug-guides/reference/no-v-if-with-v-for.md +136 -0
  211. package/skills/vue/vue-debug-guides/reference/perf-computed-object-stability.md +157 -0
  212. package/skills/vue/vue-debug-guides/reference/perf-props-stability-update-optimization.md +140 -0
  213. package/skills/vue/vue-debug-guides/reference/plugin-global-properties-sparingly.md +109 -0
  214. package/skills/vue/vue-debug-guides/reference/plugin-install-before-mount.md +124 -0
  215. package/skills/vue/vue-debug-guides/reference/plugin-prefer-provide-inject-over-global-properties.md +120 -0
  216. package/skills/vue/vue-debug-guides/reference/plugin-typescript-type-augmentation.md +157 -0
  217. package/skills/vue/vue-debug-guides/reference/prop-defineprops-scope-limitation.md +161 -0
  218. package/skills/vue/vue-debug-guides/reference/provide-inject-debugging-challenges.md +203 -0
  219. package/skills/vue/vue-debug-guides/reference/provide-inject-default-value-factory.md +244 -0
  220. package/skills/vue/vue-debug-guides/reference/provide-inject-reactivity-not-automatic.md +226 -0
  221. package/skills/vue/vue-debug-guides/reference/provide-inject-synchronous-setup.md +235 -0
  222. package/skills/vue/vue-debug-guides/reference/reactive-destructuring.md +89 -0
  223. package/skills/vue/vue-debug-guides/reference/reactivity-debugging-hooks.md +132 -0
  224. package/skills/vue/vue-debug-guides/reference/reactivity-markraw-for-non-reactive.md +149 -0
  225. package/skills/vue/vue-debug-guides/reference/reactivity-proxy-identity-hazard.md +96 -0
  226. package/skills/vue/vue-debug-guides/reference/reactivity-same-tick-batching.md +166 -0
  227. package/skills/vue/vue-debug-guides/reference/ref-value-access.md +61 -0
  228. package/skills/vue/vue-debug-guides/reference/refs-in-collections-need-value.md +81 -0
  229. package/skills/vue/vue-debug-guides/reference/render-function-avoid-internal-vnode-properties.md +151 -0
  230. package/skills/vue/vue-debug-guides/reference/render-function-vnodes-must-be-unique.md +133 -0
  231. package/skills/vue/vue-debug-guides/reference/rendering-render-function-h-import-vue3.md +148 -0
  232. package/skills/vue/vue-debug-guides/reference/rendering-render-function-return-from-setup.md +148 -0
  233. package/skills/vue/vue-debug-guides/reference/rendering-render-function-slots-as-functions.md +168 -0
  234. package/skills/vue/vue-debug-guides/reference/rendering-resolve-component-for-string-names.md +231 -0
  235. package/skills/vue/vue-debug-guides/reference/select-initial-value-ios-bug.md +91 -0
  236. package/skills/vue/vue-debug-guides/reference/self-referencing-component-name.md +157 -0
  237. package/skills/vue/vue-debug-guides/reference/sfc-named-exports-forbidden.md +184 -0
  238. package/skills/vue/vue-debug-guides/reference/sfc-scoped-css-child-component-styling.md +156 -0
  239. package/skills/vue/vue-debug-guides/reference/sfc-scoped-css-dynamic-content.md +193 -0
  240. package/skills/vue/vue-debug-guides/reference/sfc-scoped-css-slot-content.md +242 -0
  241. package/skills/vue/vue-debug-guides/reference/sfc-script-setup-reactivity.md +195 -0
  242. package/skills/vue/vue-debug-guides/reference/slot-forwarding-to-child-components.md +143 -0
  243. package/skills/vue/vue-debug-guides/reference/slot-implicit-default-content.md +155 -0
  244. package/skills/vue/vue-debug-guides/reference/slot-name-reserved-prop.md +109 -0
  245. package/skills/vue/vue-debug-guides/reference/slot-named-scoped-explicit-default.md +95 -0
  246. package/skills/vue/vue-debug-guides/reference/slot-render-scope-parent-only.md +135 -0
  247. package/skills/vue/vue-debug-guides/reference/slot-v-slot-on-components-or-templates-only.md +122 -0
  248. package/skills/vue/vue-debug-guides/reference/ssr-hydration-mismatch-causes.md +280 -0
  249. package/skills/vue/vue-debug-guides/reference/ssr-platform-specific-apis.md +256 -0
  250. package/skills/vue/vue-debug-guides/reference/state-ssr-cross-request-pollution.md +276 -0
  251. package/skills/vue/vue-debug-guides/reference/suspense-no-builtin-error-handling.md +127 -0
  252. package/skills/vue/vue-debug-guides/reference/suspense-ssr-hydration-issues.md +159 -0
  253. package/skills/vue/vue-debug-guides/reference/tailwind-dynamic-class-generation.md +144 -0
  254. package/skills/vue/vue-debug-guides/reference/teleport-scoped-styles-limitation.md +191 -0
  255. package/skills/vue/vue-debug-guides/reference/teleport-ssr-hydration.md +152 -0
  256. package/skills/vue/vue-debug-guides/reference/teleport-target-must-exist.md +113 -0
  257. package/skills/vue/vue-debug-guides/reference/template-expressions-restrictions.md +114 -0
  258. package/skills/vue/vue-debug-guides/reference/template-functions-no-side-effects.md +187 -0
  259. package/skills/vue/vue-debug-guides/reference/template-ref-null-with-v-if.md +123 -0
  260. package/skills/vue/vue-debug-guides/reference/template-ref-unwrapping-top-level.md +104 -0
  261. package/skills/vue/vue-debug-guides/reference/template-ref-v-for-order.md +172 -0
  262. package/skills/vue/vue-debug-guides/reference/textarea-no-interpolation.md +72 -0
  263. package/skills/vue/vue-debug-guides/reference/transition-group-flip-inline-elements.md +152 -0
  264. package/skills/vue/vue-debug-guides/reference/transition-group-move-animation-position-absolute.md +130 -0
  265. package/skills/vue/vue-debug-guides/reference/transition-group-no-default-wrapper-vue3.md +152 -0
  266. package/skills/vue/vue-debug-guides/reference/transition-js-hooks-done-callback.md +251 -0
  267. package/skills/vue/vue-debug-guides/reference/transition-nested-duration.md +182 -0
  268. package/skills/vue/vue-debug-guides/reference/transition-reusable-scoped-style.md +245 -0
  269. package/skills/vue/vue-debug-guides/reference/transition-router-view-appear.md +193 -0
  270. package/skills/vue/vue-debug-guides/reference/transition-type-when-mixed.md +172 -0
  271. package/skills/vue/vue-debug-guides/reference/transition-unmount-hook-timing.md +149 -0
  272. package/skills/vue/vue-debug-guides/reference/ts-defineprops-boolean-default-false.md +225 -0
  273. package/skills/vue/vue-debug-guides/reference/ts-defineprops-imported-types-limitations.md +281 -0
  274. package/skills/vue/vue-debug-guides/reference/ts-event-handler-explicit-typing.md +213 -0
  275. package/skills/vue/vue-debug-guides/reference/ts-reactive-no-generic-argument.md +196 -0
  276. package/skills/vue/vue-debug-guides/reference/ts-shallowref-for-dynamic-components.md +218 -0
  277. package/skills/vue/vue-debug-guides/reference/ts-template-ref-null-handling.md +249 -0
  278. package/skills/vue/vue-debug-guides/reference/ts-template-type-casting.md +214 -0
  279. package/skills/vue/vue-debug-guides/reference/ts-withdefaults-mutable-factory-function.md +171 -0
  280. package/skills/vue/vue-debug-guides/reference/undeclared-emits-double-firing.md +195 -0
  281. package/skills/vue/vue-debug-guides/reference/use-template-ref-vue35.md +158 -0
  282. package/skills/vue/vue-debug-guides/reference/v-else-must-follow-v-if.md +136 -0
  283. package/skills/vue/vue-debug-guides/reference/v-for-component-props.md +95 -0
  284. package/skills/vue/vue-debug-guides/reference/v-for-computed-reverse-sort.md +86 -0
  285. package/skills/vue/vue-debug-guides/reference/v-for-key-attribute.md +90 -0
  286. package/skills/vue/vue-debug-guides/reference/v-for-range-starts-at-one.md +66 -0
  287. package/skills/vue/vue-debug-guides/reference/v-if-null-check-order.md +171 -0
  288. package/skills/vue/vue-debug-guides/reference/v-model-ignores-html-attributes.md +83 -0
  289. package/skills/vue/vue-debug-guides/reference/v-model-ime-composition.md +83 -0
  290. package/skills/vue/vue-debug-guides/reference/v-model-number-modifier-behavior.md +124 -0
  291. package/skills/vue/vue-debug-guides/reference/v-show-template-limitation.md +124 -0
  292. package/skills/vue/vue-debug-guides/reference/watch-async-cleanup.md +180 -0
  293. package/skills/vue/vue-debug-guides/reference/watch-async-creation-memory-leak.md +176 -0
  294. package/skills/vue/vue-debug-guides/reference/watch-deep-same-object-reference.md +165 -0
  295. package/skills/vue/vue-debug-guides/reference/watch-flush-timing.md +189 -0
  296. package/skills/vue/vue-debug-guides/reference/watch-reactive-property-getter.md +108 -0
  297. package/skills/vue/vue-debug-guides/reference/watcheffect-async-dependency-tracking.md +173 -0
  298. package/skills/vue/vue-debug-guides/reference/watcheffect-flush-post-for-refs.md +176 -0
  299. package/skills/vue/vue-jsx-best-practices/SKILL.md +12 -0
  300. package/skills/vue/vue-jsx-best-practices/reference/render-function-jsx-vue-vs-react.md +141 -0
  301. package/skills/vue/vue-options-api-best-practices/SKILL.md +23 -0
  302. package/skills/vue/vue-options-api-best-practices/reference/no-arrow-functions-in-lifecycle-hooks.md +95 -0
  303. package/skills/vue/vue-options-api-best-practices/reference/no-arrow-functions-in-methods.md +68 -0
  304. package/skills/vue/vue-options-api-best-practices/reference/stateful-methods-lifecycle.md +61 -0
  305. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-arrow-functions-validators.md +141 -0
  306. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-computed-return-types.md +192 -0
  307. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-proptype-complex-types.md +212 -0
  308. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-provide-inject-limitations.md +135 -0
  309. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-type-event-handlers.md +202 -0
  310. package/skills/vue/vue-options-api-best-practices/reference/ts-options-api-use-definecomponent.md +172 -0
  311. package/skills/vue/vue-options-api-best-practices/reference/ts-strict-mode-options-api.md +197 -0
  312. package/skills/vue/vue-pinia-best-practices/SKILL.md +21 -0
  313. package/skills/vue/vue-pinia-best-practices/reference/pinia-no-active-pinia-error.md +248 -0
  314. package/skills/vue/vue-pinia-best-practices/reference/pinia-setup-store-return-all-state.md +227 -0
  315. package/skills/vue/vue-pinia-best-practices/reference/pinia-store-destructuring-breaks-reactivity.md +193 -0
  316. package/skills/vue/vue-pinia-best-practices/reference/state-url-for-ephemeral-filters.md +238 -0
  317. package/skills/vue/vue-pinia-best-practices/reference/state-use-pinia-for-large-apps.md +262 -0
  318. package/skills/vue/vue-pinia-best-practices/reference/store-method-binding-parentheses.md +191 -0
  319. package/skills/vue/vue-router-best-practices/SKILL.md +23 -0
  320. package/skills/vue/vue-router-best-practices/reference/router-beforeenter-no-param-trigger.md +167 -0
  321. package/skills/vue/vue-router-best-practices/reference/router-beforerouteenter-no-this.md +176 -0
  322. package/skills/vue/vue-router-best-practices/reference/router-guard-async-await-pattern.md +227 -0
  323. package/skills/vue/vue-router-best-practices/reference/router-navigation-guard-infinite-loop.md +187 -0
  324. package/skills/vue/vue-router-best-practices/reference/router-navigation-guard-next-deprecated.md +150 -0
  325. package/skills/vue/vue-router-best-practices/reference/router-param-change-no-lifecycle.md +181 -0
  326. package/skills/vue/vue-router-best-practices/reference/router-simple-routing-cleanup.md +209 -0
  327. package/skills/vue/vue-router-best-practices/reference/router-use-vue-router-for-production.md +183 -0
  328. package/skills/vue/vue-testing-best-practices/SKILL.md +29 -0
  329. package/skills/vue/vue-testing-best-practices/reference/async-component-testing.md +163 -0
  330. package/skills/vue/vue-testing-best-practices/reference/teleport-testing-complexity.md +158 -0
  331. package/skills/vue/vue-testing-best-practices/reference/testing-async-await-flushpromises.md +175 -0
  332. package/skills/vue/vue-testing-best-practices/reference/testing-browser-vs-node-runners.md +208 -0
  333. package/skills/vue/vue-testing-best-practices/reference/testing-component-blackbox-approach.md +144 -0
  334. package/skills/vue/vue-testing-best-practices/reference/testing-composables-helper-wrapper.md +238 -0
  335. package/skills/vue/vue-testing-best-practices/reference/testing-e2e-playwright-recommended.md +242 -0
  336. package/skills/vue/vue-testing-best-practices/reference/testing-no-snapshot-only.md +197 -0
  337. package/skills/vue/vue-testing-best-practices/reference/testing-pinia-store-setup.md +228 -0
  338. package/skills/vue/vue-testing-best-practices/reference/testing-suspense-async-components.md +229 -0
  339. package/skills/vue/vue-testing-best-practices/reference/testing-vitest-recommended-for-vue.md +204 -0
  340. package/skills/worker/README.md +10 -0
  341. package/skills/worker/caveman/README.md +48 -0
  342. package/skills/worker/caveman/SKILL.md +88 -0
  343. package/skills/worker/ponytail/SKILL.md +120 -0
  344. package/skills-lock.json +131 -0
  345. package/templates/state.md +16 -0
@@ -0,0 +1,65 @@
1
+ ---
2
+ title: Avoid Duplicate Serialization in RSC Props
3
+ impact: LOW
4
+ impactDescription: reduces network payload by avoiding duplicate serialization
5
+ tags: server, rsc, serialization, props, client-components
6
+ ---
7
+
8
+ ## Avoid Duplicate Serialization in RSC Props
9
+
10
+ **Impact: LOW (reduces network payload by avoiding duplicate serialization)**
11
+
12
+ RSC→client serialization deduplicates by object reference, not value. Same reference = serialized once; new reference = serialized again. Do transformations (`.toSorted()`, `.filter()`, `.map()`) in client, not server.
13
+
14
+ **Incorrect (duplicates array):**
15
+
16
+ ```tsx
17
+ // RSC: sends 6 strings (2 arrays × 3 items)
18
+ <ClientList usernames={usernames} usernamesOrdered={usernames.toSorted()} />
19
+ ```
20
+
21
+ **Correct (sends 3 strings):**
22
+
23
+ ```tsx
24
+ // RSC: send once
25
+ <ClientList usernames={usernames} />
26
+
27
+ // Client: transform there
28
+ 'use client'
29
+ const sorted = useMemo(() => [...usernames].sort(), [usernames])
30
+ ```
31
+
32
+ **Nested deduplication behavior:**
33
+
34
+ Deduplication works recursively. Impact varies by data type:
35
+
36
+ - `string[]`, `number[]`, `boolean[]`: **HIGH impact** - array + all primitives fully duplicated
37
+ - `object[]`: **LOW impact** - array duplicated, but nested objects deduplicated by reference
38
+
39
+ ```tsx
40
+ // string[] - duplicates everything
41
+ usernames={['a','b']} sorted={usernames.toSorted()} // sends 4 strings
42
+
43
+ // object[] - duplicates array structure only
44
+ users={[{id:1},{id:2}]} sorted={users.toSorted()} // sends 2 arrays + 2 unique objects (not 4)
45
+ ```
46
+
47
+ **Operations breaking deduplication (create new references):**
48
+
49
+ - Arrays: `.toSorted()`, `.filter()`, `.map()`, `.slice()`, `[...arr]`
50
+ - Objects: `{...obj}`, `Object.assign()`, `structuredClone()`, `JSON.parse(JSON.stringify())`
51
+
52
+ **More examples:**
53
+
54
+ ```tsx
55
+ // ❌ Bad
56
+ <C users={users} active={users.filter(u => u.active)} />
57
+ <C product={product} productName={product.name} />
58
+
59
+ // ✅ Good
60
+ <C users={users} />
61
+ <C product={product} />
62
+ // Do filtering/destructuring in client
63
+ ```
64
+
65
+ **Exception:** Pass derived data when transformation is expensive or client doesn't need original.
@@ -0,0 +1,149 @@
1
+ ---
2
+ title: Hoist Static I/O to Module Level
3
+ impact: HIGH
4
+ impactDescription: avoids repeated file/network I/O per request
5
+ tags: server, io, performance, next.js, route-handlers, og-image
6
+ ---
7
+
8
+ ## Hoist Static I/O to Module Level
9
+
10
+ **Impact: HIGH (avoids repeated file/network I/O per request)**
11
+
12
+ When loading static assets (fonts, logos, images, config files) in route handlers or server functions, hoist the I/O operation to module level. Module-level code runs once when the module is first imported, not on every request. This eliminates redundant file system reads or network fetches that would otherwise run on every invocation.
13
+
14
+ **Incorrect (reads font file on every request):**
15
+
16
+ ```typescript
17
+ // app/api/og/route.tsx
18
+ import { ImageResponse } from 'next/og'
19
+
20
+ export async function GET(request: Request) {
21
+ // Runs on EVERY request - expensive!
22
+ const fontData = await fetch(
23
+ new URL('./fonts/Inter.ttf', import.meta.url)
24
+ ).then(res => res.arrayBuffer())
25
+
26
+ const logoData = await fetch(
27
+ new URL('./images/logo.png', import.meta.url)
28
+ ).then(res => res.arrayBuffer())
29
+
30
+ return new ImageResponse(
31
+ <div style={{ fontFamily: 'Inter' }}>
32
+ <img src={logoData} />
33
+ Hello World
34
+ </div>,
35
+ { fonts: [{ name: 'Inter', data: fontData }] }
36
+ )
37
+ }
38
+ ```
39
+
40
+ **Correct (loads once at module initialization):**
41
+
42
+ ```typescript
43
+ // app/api/og/route.tsx
44
+ import { ImageResponse } from 'next/og'
45
+
46
+ // Module-level: runs ONCE when module is first imported
47
+ const fontData = fetch(
48
+ new URL('./fonts/Inter.ttf', import.meta.url)
49
+ ).then(res => res.arrayBuffer())
50
+
51
+ const logoData = fetch(
52
+ new URL('./images/logo.png', import.meta.url)
53
+ ).then(res => res.arrayBuffer())
54
+
55
+ export async function GET(request: Request) {
56
+ // Await the already-started promises
57
+ const [font, logo] = await Promise.all([fontData, logoData])
58
+
59
+ return new ImageResponse(
60
+ <div style={{ fontFamily: 'Inter' }}>
61
+ <img src={logo} />
62
+ Hello World
63
+ </div>,
64
+ { fonts: [{ name: 'Inter', data: font }] }
65
+ )
66
+ }
67
+ ```
68
+
69
+ **Correct (synchronous fs at module level):**
70
+
71
+ ```typescript
72
+ // app/api/og/route.tsx
73
+ import { ImageResponse } from 'next/og'
74
+ import { readFileSync } from 'fs'
75
+ import { join } from 'path'
76
+
77
+ // Synchronous read at module level - blocks only during module init
78
+ const fontData = readFileSync(
79
+ join(process.cwd(), 'public/fonts/Inter.ttf')
80
+ )
81
+
82
+ const logoData = readFileSync(
83
+ join(process.cwd(), 'public/images/logo.png')
84
+ )
85
+
86
+ export async function GET(request: Request) {
87
+ return new ImageResponse(
88
+ <div style={{ fontFamily: 'Inter' }}>
89
+ <img src={logoData} />
90
+ Hello World
91
+ </div>,
92
+ { fonts: [{ name: 'Inter', data: fontData }] }
93
+ )
94
+ }
95
+ ```
96
+
97
+ **Incorrect (reads config on every call):**
98
+
99
+ ```typescript
100
+ import fs from 'node:fs/promises'
101
+
102
+ export async function processRequest(data: Data) {
103
+ const config = JSON.parse(
104
+ await fs.readFile('./config.json', 'utf-8')
105
+ )
106
+ const template = await fs.readFile('./template.html', 'utf-8')
107
+
108
+ return render(template, data, config)
109
+ }
110
+ ```
111
+
112
+ **Correct (hoists config and template to module level):**
113
+
114
+ ```typescript
115
+ import fs from 'node:fs/promises'
116
+
117
+ const configPromise = fs
118
+ .readFile('./config.json', 'utf-8')
119
+ .then(JSON.parse)
120
+ const templatePromise = fs.readFile('./template.html', 'utf-8')
121
+
122
+ export async function processRequest(data: Data) {
123
+ const [config, template] = await Promise.all([
124
+ configPromise,
125
+ templatePromise,
126
+ ])
127
+
128
+ return render(template, data, config)
129
+ }
130
+ ```
131
+
132
+ When to use this pattern:
133
+
134
+ - Loading fonts for OG image generation
135
+ - Loading static logos, icons, or watermarks
136
+ - Reading configuration files that don't change at runtime
137
+ - Loading email templates or other static templates
138
+ - Any static asset that's the same across all requests
139
+
140
+ When not to use this pattern:
141
+
142
+ - Assets that vary per request or user
143
+ - Files that may change during runtime (use caching with TTL instead)
144
+ - Large files that would consume too much memory if kept loaded
145
+ - Sensitive data that shouldn't persist in memory
146
+
147
+ With Vercel's [Fluid Compute](https://vercel.com/docs/fluid-compute), module-level caching is especially effective because multiple concurrent requests share the same function instance. The static assets stay loaded in memory across requests without cold start penalties.
148
+
149
+ In traditional serverless, each cold start re-executes module-level code, but subsequent warm invocations reuse the loaded assets until the instance is recycled.
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: Avoid Shared Module State for Request Data
3
+ impact: HIGH
4
+ impactDescription: prevents concurrency bugs and request data leaks
5
+ tags: server, rsc, ssr, concurrency, security, state
6
+ ---
7
+
8
+ ## Avoid Shared Module State for Request Data
9
+
10
+ For React Server Components and client components rendered during SSR, avoid using mutable module-level variables to share request-scoped data. Server renders can run concurrently in the same process. If one render writes to shared module state and another render reads it, you can get race conditions, cross-request contamination, and security bugs where one user's data appears in another user's response.
11
+
12
+ Treat module scope on the server as process-wide shared memory, not request-local state.
13
+
14
+ **Incorrect (request data leaks across concurrent renders):**
15
+
16
+ ```tsx
17
+ let currentUser: User | null = null
18
+
19
+ export default async function Page() {
20
+ currentUser = await auth()
21
+ return <Dashboard />
22
+ }
23
+
24
+ async function Dashboard() {
25
+ return <div>{currentUser?.name}</div>
26
+ }
27
+ ```
28
+
29
+ If two requests overlap, request A can set `currentUser`, then request B overwrites it before request A finishes rendering `Dashboard`.
30
+
31
+ **Correct (keep request data local to the render tree):**
32
+
33
+ ```tsx
34
+ export default async function Page() {
35
+ const user = await auth()
36
+ return <Dashboard user={user} />
37
+ }
38
+
39
+ function Dashboard({ user }: { user: User | null }) {
40
+ return <div>{user?.name}</div>
41
+ }
42
+ ```
43
+
44
+ Safe exceptions:
45
+
46
+ - Immutable static assets or config loaded once at module scope
47
+ - Shared caches intentionally designed for cross-request reuse and keyed correctly
48
+ - Process-wide singletons that do not store request- or user-specific mutable data
49
+
50
+ For static assets and config, see [Hoist Static I/O to Module Level](./server-hoist-static-io.md).
@@ -0,0 +1,83 @@
1
+ ---
2
+ title: Parallel Data Fetching with Component Composition
3
+ impact: CRITICAL
4
+ impactDescription: eliminates server-side waterfalls
5
+ tags: server, rsc, parallel-fetching, composition
6
+ ---
7
+
8
+ ## Parallel Data Fetching with Component Composition
9
+
10
+ React Server Components execute sequentially within a tree. Restructure with composition to parallelize data fetching.
11
+
12
+ **Incorrect (Sidebar waits for Page's fetch to complete):**
13
+
14
+ ```tsx
15
+ export default async function Page() {
16
+ const header = await fetchHeader()
17
+ return (
18
+ <div>
19
+ <div>{header}</div>
20
+ <Sidebar />
21
+ </div>
22
+ )
23
+ }
24
+
25
+ async function Sidebar() {
26
+ const items = await fetchSidebarItems()
27
+ return <nav>{items.map(renderItem)}</nav>
28
+ }
29
+ ```
30
+
31
+ **Correct (both fetch simultaneously):**
32
+
33
+ ```tsx
34
+ async function Header() {
35
+ const data = await fetchHeader()
36
+ return <div>{data}</div>
37
+ }
38
+
39
+ async function Sidebar() {
40
+ const items = await fetchSidebarItems()
41
+ return <nav>{items.map(renderItem)}</nav>
42
+ }
43
+
44
+ export default function Page() {
45
+ return (
46
+ <div>
47
+ <Header />
48
+ <Sidebar />
49
+ </div>
50
+ )
51
+ }
52
+ ```
53
+
54
+ **Alternative with children prop:**
55
+
56
+ ```tsx
57
+ async function Header() {
58
+ const data = await fetchHeader()
59
+ return <div>{data}</div>
60
+ }
61
+
62
+ async function Sidebar() {
63
+ const items = await fetchSidebarItems()
64
+ return <nav>{items.map(renderItem)}</nav>
65
+ }
66
+
67
+ function Layout({ children }: { children: ReactNode }) {
68
+ return (
69
+ <div>
70
+ <Header />
71
+ {children}
72
+ </div>
73
+ )
74
+ }
75
+
76
+ export default function Page() {
77
+ return (
78
+ <Layout>
79
+ <Sidebar />
80
+ </Layout>
81
+ )
82
+ }
83
+ ```
@@ -0,0 +1,34 @@
1
+ ---
2
+ title: Parallel Nested Data Fetching
3
+ impact: CRITICAL
4
+ impactDescription: eliminates server-side waterfalls
5
+ tags: server, rsc, parallel-fetching, promise-chaining
6
+ ---
7
+
8
+ ## Parallel Nested Data Fetching
9
+
10
+ When fetching nested data in parallel, chain dependent fetches within each item's promise so a slow item doesn't block the rest.
11
+
12
+ **Incorrect (a single slow item blocks all nested fetches):**
13
+
14
+ ```tsx
15
+ const chats = await Promise.all(
16
+ chatIds.map(id => getChat(id))
17
+ )
18
+
19
+ const chatAuthors = await Promise.all(
20
+ chats.map(chat => getUser(chat.author))
21
+ )
22
+ ```
23
+
24
+ If one `getChat(id)` out of 100 is extremely slow, the authors of the other 99 chats can't start loading even though their data is ready.
25
+
26
+ **Correct (each item chains its own nested fetch):**
27
+
28
+ ```tsx
29
+ const chatAuthors = await Promise.all(
30
+ chatIds.map(id => getChat(id).then(chat => getUser(chat.author)))
31
+ )
32
+ ```
33
+
34
+ Each item independently chains `getChat` → `getUser`, so a slow chat doesn't block author fetches for the others.
@@ -0,0 +1,38 @@
1
+ ---
2
+ title: Minimize Serialization at RSC Boundaries
3
+ impact: HIGH
4
+ impactDescription: reduces data transfer size
5
+ tags: server, rsc, serialization, props
6
+ ---
7
+
8
+ ## Minimize Serialization at RSC Boundaries
9
+
10
+ The React Server/Client boundary serializes all object properties into strings and embeds them in the HTML response and subsequent RSC requests. This serialized data directly impacts page weight and load time, so **size matters a lot**. Only pass fields that the client actually uses.
11
+
12
+ **Incorrect (serializes all 50 fields):**
13
+
14
+ ```tsx
15
+ async function Page() {
16
+ const user = await fetchUser() // 50 fields
17
+ return <Profile user={user} />
18
+ }
19
+
20
+ 'use client'
21
+ function Profile({ user }: { user: User }) {
22
+ return <div>{user.name}</div> // uses 1 field
23
+ }
24
+ ```
25
+
26
+ **Correct (serializes only 1 field):**
27
+
28
+ ```tsx
29
+ async function Page() {
30
+ const user = await fetchUser()
31
+ return <Profile name={user.name} />
32
+ }
33
+
34
+ 'use client'
35
+ function Profile({ name }: { name: string }) {
36
+ return <div>{name}</div>
37
+ }
38
+ ```
@@ -0,0 +1,76 @@
1
+ ---
2
+ name: create-adaptable-composable
3
+ description: Create a library-grade Vue composable that accepts maybe-reactive inputs (MaybeRef / MaybeRefOrGetter) so callers can pass a plain value, ref, or getter. Normalize inputs with toValue()/toRef() inside reactive effects (watch/watchEffect) to keep behavior predictable and reactive. Use this skill when user asks for creating adaptable or reusable composables.
4
+ license: MIT
5
+ metadata:
6
+ author: github.com/vuejs-ai
7
+ version: "17.0.0"
8
+ compatibility: Requires Vue 3 (or above) or Nuxt 3 (or above) project
9
+ ---
10
+
11
+ # Create Adaptable Composable
12
+
13
+ Adaptable composables are reusable functions that can accept both reactive and non-reactive inputs. This allows developers to use the composable in a variety of contexts without worrying about the reactivity of the inputs.
14
+
15
+ Steps to design an adaptable composable in Vue.js:
16
+ 1. Confirm the composable's purpose and API design and expected inputs/outputs.
17
+ 2. Identify inputs params that should be reactive (MaybeRef / MaybeRefOrGetter).
18
+ 3. Use `toValue()` or `toRef()` to normalize inputs inside reactive effects.
19
+ 4. Implement the core logic of the composable using Vue's reactivity APIs.
20
+
21
+ ## Core Type Concepts
22
+
23
+ ### Type Utilities
24
+
25
+ ```ts
26
+ /**
27
+ * value or writable ref (value/ref/shallowRef/writable computed)
28
+ */
29
+ export type MaybeRef<T = any> = T | Ref<T> | ShallowRef<T> | WritableComputedRef<T>;
30
+
31
+ /**
32
+ * MaybeRef<T> + ComputedRef<T> + () => T
33
+ */
34
+ export type MaybeRefOrGetter<T = any> = MaybeRef<T> | ComputedRef<T> | (() => T);
35
+ ```
36
+
37
+ ### Policy and Rules
38
+
39
+ - Read-only, computed-friendly input: use `MaybeRefOrGetter`
40
+ - Needs to be writable / two-way input: use `MaybeRef`
41
+ - Parameter might be a function value (callback/predicate/comparator): do not use `MaybeRefOrGetter`, or you may accidentally invoke it as a getter.
42
+ - DOM/Element targets: if you want computed/derived targets, use `MaybeRefOrGetter`.
43
+
44
+ When `MaybeRefOrGetter` or `MaybeRef` is used:
45
+ - resolve reactive value using `toRef()` (e.g. watcher source)
46
+ - resolve non-reactive value using `toValue()`
47
+
48
+ ### Examples
49
+
50
+ Adaptable `useDocumentTitle` Composable: read-only title parameter
51
+
52
+ ```ts
53
+ import { watch, toRef } from 'vue'
54
+ import type { MaybeRefOrGetter } from 'vue'
55
+
56
+ export function useDocumentTitle(title: MaybeRefOrGetter<string>) {
57
+ watch(toRef(title), (t) => {
58
+ document.title = t
59
+ }, { immediate: true })
60
+ }
61
+ ```
62
+
63
+ Adaptable `useCounter` Composable: two-way writable count parameter
64
+
65
+ ```ts
66
+ import { watch, toRef } from 'vue'
67
+ import type { MaybeRef } from 'vue'
68
+
69
+ function useCounter(count: MaybeRef<number>) {
70
+ const countRef = toRef(count)
71
+ function add() {
72
+ countRef.value++
73
+ }
74
+ return { add }
75
+ }
76
+ ```
@@ -0,0 +1,154 @@
1
+ ---
2
+ name: vue-best-practices
3
+ description: 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.
4
+ license: MIT
5
+ metadata:
6
+ author: github.com/vuejs-ai
7
+ version: "18.0.0"
8
+ ---
9
+
10
+ # Vue Best Practices Workflow
11
+
12
+ Use this skill as an instruction set. Follow the workflow in order unless the user explicitly asks for a different order.
13
+
14
+ ## Core Principles
15
+ - **Keep state predictable:** one source of truth, derive everything else.
16
+ - **Make data flow explicit:** Props down, Events up for most cases.
17
+ - **Favor small, focused components:** easier to test, reuse, and maintain.
18
+ - **Avoid unnecessary re-renders:** use computed properties and watchers wisely.
19
+ - **Readability counts:** write clear, self-documenting code.
20
+
21
+ ## 1) Confirm architecture before coding (required)
22
+
23
+ - Default stack: Vue 3 + Composition API + `<script setup lang="ts">`.
24
+ - If the project explicitly uses Options API, load `vue-options-api-best-practices` skill if available.
25
+ - If the project explicitly uses JSX, load `vue-jsx-best-practices` skill if available.
26
+
27
+ ### 1.1 Must-read core references (required)
28
+
29
+ - Before implementing any Vue task, make sure to read and apply these core references:
30
+ - `references/reactivity.md`
31
+ - `references/sfc.md`
32
+ - `references/component-data-flow.md`
33
+ - `references/composables.md`
34
+ - Keep these references in active working context for the entire task, not only when a specific issue appears.
35
+
36
+ ### 1.2 Plan component boundaries before coding (required)
37
+
38
+ Create a brief component map before implementation for any non-trivial feature.
39
+
40
+ - Define each component's single responsibility in one sentence.
41
+ - Keep entry/root and route-level view components as composition surfaces by default.
42
+ - Move feature UI and feature logic out of entry/root/view components unless the task is intentionally a tiny single-file demo.
43
+ - Define props/emits contracts for each child component in the map.
44
+ - Prefer a feature folder layout (`components/<feature>/...`, `composables/use<Feature>.ts`) when adding more than one component.
45
+
46
+ ## 2) Apply essential Vue foundations (required)
47
+
48
+ These are essential, must-know foundations. Apply all of them in every Vue task using the core references already loaded in section `1.1`.
49
+
50
+ ### Reactivity
51
+
52
+ - Must-read reference from `1.1`: [reactivity](references/reactivity.md)
53
+ - Keep source state minimal (`ref`/`reactive`), derive everything possible with `computed`.
54
+ - Use watchers for side effects if needed.
55
+ - Avoid recomputing expensive logic in templates.
56
+
57
+ ### SFC structure and template safety
58
+
59
+ - Must-read reference from `1.1`: [sfc](references/sfc.md)
60
+ - Keep SFC sections in this order: `<script>` → `<template>` → `<style>`.
61
+ - Keep SFC responsibilities focused; split large components.
62
+ - Keep templates declarative; move branching/derivation to script.
63
+ - Apply Vue template safety rules (`v-html`, list rendering, conditional rendering choices).
64
+
65
+ ### Keep components focused
66
+
67
+ Split a component when it has **more than one clear responsibility** (e.g. data orchestration + UI, or multiple independent UI sections).
68
+
69
+ - Prefer **smaller components + composables** over one “mega component”
70
+ - Move **UI sections** into child components (props in, events out).
71
+ - Move **state/side effects** into composables (`useXxx()`).
72
+
73
+ Apply objective split triggers. Split the component if **any** condition is true:
74
+
75
+ - It owns both orchestration/state and substantial presentational markup for multiple sections.
76
+ - It has 3+ distinct UI sections (for example: form, filters, list, footer/status).
77
+ - A template block is repeated or could become reusable (item rows, cards, list entries).
78
+
79
+ Entry/root and route view rule:
80
+
81
+ - Keep entry/root and route view components thin: app shell/layout, provider wiring, and feature composition.
82
+ - Do not place full feature implementations in entry/root/view components when those features contain independent parts.
83
+ - For CRUD/list features (todo, table, catalog, inbox), split at least into:
84
+ - feature container component
85
+ - input/form component
86
+ - list (and/or item) component
87
+ - footer/actions or filter/status component
88
+ - Allow a single-file implementation only for very small throwaway demos; if chosen, explicitly justify why splitting is unnecessary.
89
+
90
+ ### Component data flow
91
+
92
+ - Must-read reference from `1.1`: [component-data-flow](references/component-data-flow.md)
93
+ - Use props down, events up as the primary model.
94
+ - Use `v-model` only for true two-way component contracts.
95
+ - Use provide/inject only for deep-tree dependencies or shared context.
96
+ - Keep contracts explicit and typed with `defineProps`, `defineEmits`, and `InjectionKey` as needed.
97
+
98
+ ### Composables
99
+
100
+ - Must-read reference from `1.1`: [composables](references/composables.md)
101
+ - Extract logic into composables when it is reused, stateful, or side-effect heavy.
102
+ - Keep composable APIs small, typed, and predictable.
103
+ - Separate feature logic from presentational components.
104
+
105
+ ## 3) Consider optional features only when requirements call for them
106
+
107
+ ### 3.1 Standard optional features
108
+
109
+ Do not add these by default. Load the matching reference only when the requirement exists.
110
+
111
+ - Slots: parent needs to control child content/layout -> [component-slots](references/component-slots.md)
112
+ - Fallthrough attributes: wrapper/base components must forward attrs/events safely -> [component-fallthrough-attrs](references/component-fallthrough-attrs.md)
113
+ - Built-in component `<KeepAlive>` for stateful view caching -> [component-keep-alive](references/component-keep-alive.md)
114
+ - Built-in component `<Teleport>` for overlays/portals -> [component-teleport](references/component-teleport.md)
115
+ - Built-in component `<Suspense>` for async subtree fallback boundaries -> [component-suspense](references/component-suspense.md)
116
+ - Animation-related features: pick the simplest approach that matches the required motion behavior.
117
+ - Built-in component `<Transition>` for enter/leave effects -> [transition](references/component-transition.md)
118
+ - Built-in component `<TransitionGroup>` for animated list mutations -> [transition-group](references/component-transition-group.md)
119
+ - Class-based animation for non-enter/leave effects -> [animation-class-based-technique](references/animation-class-based-technique.md)
120
+ - State-driven animation for user-input-driven animation -> [animation-state-driven-technique](references/animation-state-driven-technique.md)
121
+
122
+ ### 3.2 Less-common optional features
123
+
124
+ Use these only when there is explicit product or technical need.
125
+
126
+ - Directives: behavior is DOM-specific and not a good composable/component fit -> [directives](references/directives.md)
127
+ - Async components: heavy/rarely-used UI should be lazy loaded -> [component-async](references/component-async.md)
128
+ - Render functions only when templates cannot express the requirement -> [render-functions](references/render-functions.md)
129
+ - Plugins when behavior must be installed app-wide -> [plugins](references/plugins.md)
130
+ - State management patterns: app-wide shared state crosses feature boundaries -> [state-management](references/state-management.md)
131
+
132
+ ## 4) Run performance optimization after behavior is correct
133
+
134
+ Performance work is a post-functionality pass. Do not optimize before core behavior is implemented and verified.
135
+
136
+ - Large list rendering bottlenecks -> [perf-virtualize-large-lists](references/perf-virtualize-large-lists.md)
137
+ - Static subtrees re-rendering unnecessarily -> [perf-v-once-v-memo-directives](references/perf-v-once-v-memo-directives.md)
138
+ - Over-abstraction in hot list paths -> [perf-avoid-component-abstraction-in-lists](references/perf-avoid-component-abstraction-in-lists.md)
139
+ - Expensive updates triggered too often -> [updated-hook-performance](references/updated-hook-performance.md)
140
+
141
+ ## 5) Final self-check before finishing
142
+
143
+ - Core behavior works and matches requirements.
144
+ - All must-read references were read and applied.
145
+ - Reactivity model is minimal and predictable.
146
+ - SFC structure and template rules are followed.
147
+ - Components are focused and well-factored, splitting when needed.
148
+ - Entry/root and route view components remain composition surfaces unless there is an explicit small-demo exception.
149
+ - Component split decisions are explicit and defensible (responsibility boundaries are clear).
150
+ - Data flow contracts are explicit and typed.
151
+ - Composables are used where reuse/complexity justifies them.
152
+ - Moved state/side effects into composables if applicable
153
+ - Optional features are used only when requirements demand them.
154
+ - Performance changes were applied only after functionality was complete.