@pythoughts/vue-skills-mcp 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.
- package/README.md +63 -0
- package/index.mjs +139 -0
- package/package.json +34 -0
- package/skills/create-adaptable-composable/SKILL.md +76 -0
- package/skills/vue-best-practices/SKILL.md +154 -0
- package/skills/vue-best-practices/references/animation-class-based-technique.md +254 -0
- package/skills/vue-best-practices/references/animation-state-driven-technique.md +291 -0
- package/skills/vue-best-practices/references/component-async.md +97 -0
- package/skills/vue-best-practices/references/component-data-flow.md +350 -0
- package/skills/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
- package/skills/vue-best-practices/references/component-keep-alive.md +137 -0
- package/skills/vue-best-practices/references/component-slots.md +216 -0
- package/skills/vue-best-practices/references/component-suspense.md +228 -0
- package/skills/vue-best-practices/references/component-teleport.md +108 -0
- package/skills/vue-best-practices/references/component-transition-group.md +128 -0
- package/skills/vue-best-practices/references/component-transition.md +125 -0
- package/skills/vue-best-practices/references/composables.md +290 -0
- package/skills/vue-best-practices/references/directives.md +162 -0
- package/skills/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/skills/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
- package/skills/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
- package/skills/vue-best-practices/references/plugins.md +166 -0
- package/skills/vue-best-practices/references/reactivity.md +346 -0
- package/skills/vue-best-practices/references/render-functions.md +201 -0
- package/skills/vue-best-practices/references/sfc.md +310 -0
- package/skills/vue-best-practices/references/state-management.md +135 -0
- package/skills/vue-best-practices/references/updated-hook-performance.md +187 -0
- package/skills/vue-debug-guides/SKILL.md +205 -0
- package/skills/vue-debug-guides/reference/animation-key-for-rerender.md +160 -0
- package/skills/vue-debug-guides/reference/animation-transitiongroup-performance.md +241 -0
- package/skills/vue-debug-guides/reference/async-component-error-handling.md +115 -0
- package/skills/vue-debug-guides/reference/async-component-keepalive-ref-issue.md +112 -0
- package/skills/vue-debug-guides/reference/async-component-suspense-control.md +84 -0
- package/skills/vue-debug-guides/reference/async-component-vue-router.md +109 -0
- package/skills/vue-debug-guides/reference/attrs-event-listener-merging.md +205 -0
- package/skills/vue-debug-guides/reference/checkbox-true-false-value-form-submission.md +118 -0
- package/skills/vue-debug-guides/reference/cleanup-side-effects.md +172 -0
- package/skills/vue-debug-guides/reference/click-events-on-components.md +180 -0
- package/skills/vue-debug-guides/reference/component-naming-conflicts.md +159 -0
- package/skills/vue-debug-guides/reference/component-ref-requires-defineexpose.md +176 -0
- package/skills/vue-debug-guides/reference/composable-avoid-hidden-side-effects.md +208 -0
- package/skills/vue-debug-guides/reference/composable-call-location-restrictions.md +141 -0
- package/skills/vue-debug-guides/reference/composable-naming-return-pattern.md +139 -0
- package/skills/vue-debug-guides/reference/composable-tovalue-inside-watcheffect.md +182 -0
- package/skills/vue-debug-guides/reference/composition-api-not-functional-programming.md +120 -0
- package/skills/vue-debug-guides/reference/composition-api-script-setup-async-context.md +203 -0
- package/skills/vue-debug-guides/reference/composition-api-vs-react-hooks-differences.md +156 -0
- package/skills/vue-debug-guides/reference/computed-array-mutation.md +148 -0
- package/skills/vue-debug-guides/reference/computed-conditional-dependencies.md +147 -0
- package/skills/vue-debug-guides/reference/computed-no-parameters.md +159 -0
- package/skills/vue-debug-guides/reference/computed-no-side-effects.md +107 -0
- package/skills/vue-debug-guides/reference/computed-return-value-readonly.md +160 -0
- package/skills/vue-debug-guides/reference/configure-app-before-mount.md +89 -0
- package/skills/vue-debug-guides/reference/declare-emits-for-documentation.md +212 -0
- package/skills/vue-debug-guides/reference/define-expose-before-await.md +192 -0
- package/skills/vue-debug-guides/reference/define-model-default-value-sync.md +139 -0
- package/skills/vue-debug-guides/reference/defineEmits-must-be-top-level.md +164 -0
- package/skills/vue-debug-guides/reference/defineEmits-no-runtime-and-type-mixed.md +170 -0
- package/skills/vue-debug-guides/reference/definemodel-object-mutation-no-emit.md +148 -0
- package/skills/vue-debug-guides/reference/dom-update-timing-nexttick.md +90 -0
- package/skills/vue-debug-guides/reference/dynamic-argument-constraints.md +146 -0
- package/skills/vue-debug-guides/reference/dynamic-component-registration-vite.md +147 -0
- package/skills/vue-debug-guides/reference/event-modifier-order-matters.md +101 -0
- package/skills/vue-debug-guides/reference/exact-modifier-for-precise-shortcuts.md +155 -0
- package/skills/vue-debug-guides/reference/fallthrough-attrs-overwrite-vue3.md +159 -0
- package/skills/vue-debug-guides/reference/in-dom-template-parsing-caveats.md +149 -0
- package/skills/vue-debug-guides/reference/inheritattrs-false-for-wrapper-components.md +230 -0
- package/skills/vue-debug-guides/reference/keepalive-router-nested-double-mount.md +222 -0
- package/skills/vue-debug-guides/reference/keepalive-transition-memory-leak.md +144 -0
- package/skills/vue-debug-guides/reference/keyup-modifier-timing.md +137 -0
- package/skills/vue-debug-guides/reference/lifecycle-dom-access-timing.md +216 -0
- package/skills/vue-debug-guides/reference/lifecycle-hooks-synchronous-registration.md +156 -0
- package/skills/vue-debug-guides/reference/lifecycle-ssr-awareness.md +184 -0
- package/skills/vue-debug-guides/reference/local-components-not-in-descendants.md +151 -0
- package/skills/vue-debug-guides/reference/mount-return-value.md +88 -0
- package/skills/vue-debug-guides/reference/multi-root-component-class-attrs.md +93 -0
- package/skills/vue-debug-guides/reference/native-event-collision-with-emits.md +162 -0
- package/skills/vue-debug-guides/reference/no-passive-with-prevent.md +141 -0
- package/skills/vue-debug-guides/reference/no-v-if-with-v-for.md +136 -0
- package/skills/vue-debug-guides/reference/perf-computed-object-stability.md +157 -0
- package/skills/vue-debug-guides/reference/perf-props-stability-update-optimization.md +140 -0
- package/skills/vue-debug-guides/reference/plugin-global-properties-sparingly.md +109 -0
- package/skills/vue-debug-guides/reference/plugin-install-before-mount.md +124 -0
- package/skills/vue-debug-guides/reference/plugin-prefer-provide-inject-over-global-properties.md +120 -0
- package/skills/vue-debug-guides/reference/plugin-typescript-type-augmentation.md +157 -0
- package/skills/vue-debug-guides/reference/prop-defineprops-scope-limitation.md +161 -0
- package/skills/vue-debug-guides/reference/provide-inject-debugging-challenges.md +203 -0
- package/skills/vue-debug-guides/reference/provide-inject-default-value-factory.md +244 -0
- package/skills/vue-debug-guides/reference/provide-inject-reactivity-not-automatic.md +226 -0
- package/skills/vue-debug-guides/reference/provide-inject-synchronous-setup.md +235 -0
- package/skills/vue-debug-guides/reference/reactive-destructuring.md +89 -0
- package/skills/vue-debug-guides/reference/reactivity-debugging-hooks.md +132 -0
- package/skills/vue-debug-guides/reference/reactivity-markraw-for-non-reactive.md +149 -0
- package/skills/vue-debug-guides/reference/reactivity-proxy-identity-hazard.md +96 -0
- package/skills/vue-debug-guides/reference/reactivity-same-tick-batching.md +166 -0
- package/skills/vue-debug-guides/reference/ref-value-access.md +61 -0
- package/skills/vue-debug-guides/reference/refs-in-collections-need-value.md +81 -0
- package/skills/vue-debug-guides/reference/render-function-avoid-internal-vnode-properties.md +151 -0
- package/skills/vue-debug-guides/reference/render-function-vnodes-must-be-unique.md +133 -0
- package/skills/vue-debug-guides/reference/rendering-render-function-h-import-vue3.md +148 -0
- package/skills/vue-debug-guides/reference/rendering-render-function-return-from-setup.md +148 -0
- package/skills/vue-debug-guides/reference/rendering-render-function-slots-as-functions.md +168 -0
- package/skills/vue-debug-guides/reference/rendering-resolve-component-for-string-names.md +231 -0
- package/skills/vue-debug-guides/reference/select-initial-value-ios-bug.md +91 -0
- package/skills/vue-debug-guides/reference/self-referencing-component-name.md +157 -0
- package/skills/vue-debug-guides/reference/sfc-named-exports-forbidden.md +184 -0
- package/skills/vue-debug-guides/reference/sfc-scoped-css-child-component-styling.md +156 -0
- package/skills/vue-debug-guides/reference/sfc-scoped-css-dynamic-content.md +193 -0
- package/skills/vue-debug-guides/reference/sfc-scoped-css-slot-content.md +242 -0
- package/skills/vue-debug-guides/reference/sfc-script-setup-reactivity.md +195 -0
- package/skills/vue-debug-guides/reference/slot-forwarding-to-child-components.md +143 -0
- package/skills/vue-debug-guides/reference/slot-implicit-default-content.md +155 -0
- package/skills/vue-debug-guides/reference/slot-name-reserved-prop.md +109 -0
- package/skills/vue-debug-guides/reference/slot-named-scoped-explicit-default.md +95 -0
- package/skills/vue-debug-guides/reference/slot-render-scope-parent-only.md +135 -0
- package/skills/vue-debug-guides/reference/slot-v-slot-on-components-or-templates-only.md +122 -0
- package/skills/vue-debug-guides/reference/ssr-hydration-mismatch-causes.md +280 -0
- package/skills/vue-debug-guides/reference/ssr-platform-specific-apis.md +256 -0
- package/skills/vue-debug-guides/reference/state-ssr-cross-request-pollution.md +276 -0
- package/skills/vue-debug-guides/reference/suspense-no-builtin-error-handling.md +127 -0
- package/skills/vue-debug-guides/reference/suspense-ssr-hydration-issues.md +159 -0
- package/skills/vue-debug-guides/reference/tailwind-dynamic-class-generation.md +144 -0
- package/skills/vue-debug-guides/reference/teleport-scoped-styles-limitation.md +191 -0
- package/skills/vue-debug-guides/reference/teleport-ssr-hydration.md +152 -0
- package/skills/vue-debug-guides/reference/teleport-target-must-exist.md +113 -0
- package/skills/vue-debug-guides/reference/template-expressions-restrictions.md +114 -0
- package/skills/vue-debug-guides/reference/template-functions-no-side-effects.md +187 -0
- package/skills/vue-debug-guides/reference/template-ref-null-with-v-if.md +123 -0
- package/skills/vue-debug-guides/reference/template-ref-unwrapping-top-level.md +104 -0
- package/skills/vue-debug-guides/reference/template-ref-v-for-order.md +172 -0
- package/skills/vue-debug-guides/reference/textarea-no-interpolation.md +72 -0
- package/skills/vue-debug-guides/reference/transition-group-flip-inline-elements.md +152 -0
- package/skills/vue-debug-guides/reference/transition-group-move-animation-position-absolute.md +130 -0
- package/skills/vue-debug-guides/reference/transition-group-no-default-wrapper-vue3.md +152 -0
- package/skills/vue-debug-guides/reference/transition-js-hooks-done-callback.md +251 -0
- package/skills/vue-debug-guides/reference/transition-nested-duration.md +182 -0
- package/skills/vue-debug-guides/reference/transition-reusable-scoped-style.md +245 -0
- package/skills/vue-debug-guides/reference/transition-router-view-appear.md +193 -0
- package/skills/vue-debug-guides/reference/transition-type-when-mixed.md +172 -0
- package/skills/vue-debug-guides/reference/transition-unmount-hook-timing.md +149 -0
- package/skills/vue-debug-guides/reference/ts-defineprops-boolean-default-false.md +225 -0
- package/skills/vue-debug-guides/reference/ts-defineprops-imported-types-limitations.md +281 -0
- package/skills/vue-debug-guides/reference/ts-event-handler-explicit-typing.md +213 -0
- package/skills/vue-debug-guides/reference/ts-reactive-no-generic-argument.md +196 -0
- package/skills/vue-debug-guides/reference/ts-shallowref-for-dynamic-components.md +218 -0
- package/skills/vue-debug-guides/reference/ts-template-ref-null-handling.md +249 -0
- package/skills/vue-debug-guides/reference/ts-template-type-casting.md +214 -0
- package/skills/vue-debug-guides/reference/ts-withdefaults-mutable-factory-function.md +171 -0
- package/skills/vue-debug-guides/reference/undeclared-emits-double-firing.md +195 -0
- package/skills/vue-debug-guides/reference/use-template-ref-vue35.md +158 -0
- package/skills/vue-debug-guides/reference/v-else-must-follow-v-if.md +136 -0
- package/skills/vue-debug-guides/reference/v-for-component-props.md +95 -0
- package/skills/vue-debug-guides/reference/v-for-computed-reverse-sort.md +86 -0
- package/skills/vue-debug-guides/reference/v-for-key-attribute.md +90 -0
- package/skills/vue-debug-guides/reference/v-for-range-starts-at-one.md +66 -0
- package/skills/vue-debug-guides/reference/v-if-null-check-order.md +171 -0
- package/skills/vue-debug-guides/reference/v-model-ignores-html-attributes.md +83 -0
- package/skills/vue-debug-guides/reference/v-model-ime-composition.md +83 -0
- package/skills/vue-debug-guides/reference/v-model-number-modifier-behavior.md +124 -0
- package/skills/vue-debug-guides/reference/v-show-template-limitation.md +124 -0
- package/skills/vue-debug-guides/reference/watch-async-cleanup.md +180 -0
- package/skills/vue-debug-guides/reference/watch-async-creation-memory-leak.md +176 -0
- package/skills/vue-debug-guides/reference/watch-deep-same-object-reference.md +165 -0
- package/skills/vue-debug-guides/reference/watch-flush-timing.md +189 -0
- package/skills/vue-debug-guides/reference/watch-reactive-property-getter.md +108 -0
- package/skills/vue-debug-guides/reference/watcheffect-async-dependency-tracking.md +173 -0
- package/skills/vue-debug-guides/reference/watcheffect-flush-post-for-refs.md +176 -0
- package/skills/vue-jsx-best-practices/SKILL.md +12 -0
- package/skills/vue-jsx-best-practices/reference/render-function-jsx-vue-vs-react.md +141 -0
- package/skills/vue-options-api-best-practices/SKILL.md +23 -0
- package/skills/vue-options-api-best-practices/reference/no-arrow-functions-in-lifecycle-hooks.md +95 -0
- package/skills/vue-options-api-best-practices/reference/no-arrow-functions-in-methods.md +68 -0
- package/skills/vue-options-api-best-practices/reference/stateful-methods-lifecycle.md +61 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-arrow-functions-validators.md +141 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-computed-return-types.md +192 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-proptype-complex-types.md +212 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-provide-inject-limitations.md +135 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-type-event-handlers.md +202 -0
- package/skills/vue-options-api-best-practices/reference/ts-options-api-use-definecomponent.md +172 -0
- package/skills/vue-options-api-best-practices/reference/ts-strict-mode-options-api.md +197 -0
- package/skills/vue-pinia-best-practices/SKILL.md +21 -0
- package/skills/vue-pinia-best-practices/reference/pinia-no-active-pinia-error.md +248 -0
- package/skills/vue-pinia-best-practices/reference/pinia-setup-store-return-all-state.md +227 -0
- package/skills/vue-pinia-best-practices/reference/pinia-store-destructuring-breaks-reactivity.md +193 -0
- package/skills/vue-pinia-best-practices/reference/state-url-for-ephemeral-filters.md +238 -0
- package/skills/vue-pinia-best-practices/reference/state-use-pinia-for-large-apps.md +262 -0
- package/skills/vue-pinia-best-practices/reference/store-method-binding-parentheses.md +191 -0
- package/skills/vue-router-best-practices/SKILL.md +23 -0
- package/skills/vue-router-best-practices/reference/router-beforeenter-no-param-trigger.md +167 -0
- package/skills/vue-router-best-practices/reference/router-beforerouteenter-no-this.md +176 -0
- package/skills/vue-router-best-practices/reference/router-guard-async-await-pattern.md +227 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-infinite-loop.md +187 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-next-deprecated.md +150 -0
- package/skills/vue-router-best-practices/reference/router-param-change-no-lifecycle.md +181 -0
- package/skills/vue-router-best-practices/reference/router-simple-routing-cleanup.md +209 -0
- package/skills/vue-router-best-practices/reference/router-use-vue-router-for-production.md +183 -0
- package/skills/vue-testing-best-practices/SKILL.md +29 -0
- package/skills/vue-testing-best-practices/reference/async-component-testing.md +163 -0
- package/skills/vue-testing-best-practices/reference/teleport-testing-complexity.md +158 -0
- package/skills/vue-testing-best-practices/reference/testing-async-await-flushpromises.md +175 -0
- package/skills/vue-testing-best-practices/reference/testing-browser-vs-node-runners.md +208 -0
- package/skills/vue-testing-best-practices/reference/testing-component-blackbox-approach.md +144 -0
- package/skills/vue-testing-best-practices/reference/testing-composables-helper-wrapper.md +238 -0
- package/skills/vue-testing-best-practices/reference/testing-e2e-playwright-recommended.md +242 -0
- package/skills/vue-testing-best-practices/reference/testing-no-snapshot-only.md +197 -0
- package/skills/vue-testing-best-practices/reference/testing-pinia-store-setup.md +228 -0
- package/skills/vue-testing-best-practices/reference/testing-suspense-async-components.md +229 -0
- package/skills/vue-testing-best-practices/reference/testing-vitest-recommended-for-vue.md +204 -0
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Avoid Mutating Methods on Arrays in Computed Properties
|
|
3
|
+
impact: HIGH
|
|
4
|
+
impactDescription: Array mutating methods in computed modify source data causing unexpected behavior
|
|
5
|
+
type: capability
|
|
6
|
+
tags: [vue3, computed, arrays, mutation, sort, reverse]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Avoid Mutating Methods on Arrays in Computed Properties
|
|
10
|
+
|
|
11
|
+
**Impact: HIGH** - JavaScript array methods like `reverse()`, `sort()`, `splice()`, `push()`, `pop()`, `shift()`, and `unshift()` mutate the original array. Using them directly on reactive arrays inside computed properties will modify your source data, causing unexpected side effects and bugs.
|
|
12
|
+
|
|
13
|
+
## Task Checklist
|
|
14
|
+
|
|
15
|
+
- [ ] Always create a copy of arrays before using mutating methods
|
|
16
|
+
- [ ] Use spread operator `[...array]` or `slice()` to copy arrays
|
|
17
|
+
- [ ] Prefer non-mutating alternatives when available
|
|
18
|
+
- [ ] Be aware which array methods mutate vs return new arrays
|
|
19
|
+
|
|
20
|
+
**Incorrect:**
|
|
21
|
+
```vue
|
|
22
|
+
<script setup>
|
|
23
|
+
import { ref, computed } from 'vue'
|
|
24
|
+
|
|
25
|
+
const items = ref([3, 1, 4, 1, 5, 9, 2, 6])
|
|
26
|
+
const users = ref([
|
|
27
|
+
{ name: 'Alice', age: 30 },
|
|
28
|
+
{ name: 'Bob', age: 25 }
|
|
29
|
+
])
|
|
30
|
+
|
|
31
|
+
// BAD: sort() mutates the original array!
|
|
32
|
+
const sortedItems = computed(() => {
|
|
33
|
+
return items.value.sort((a, b) => a - b)
|
|
34
|
+
})
|
|
35
|
+
|
|
36
|
+
// BAD: reverse() mutates the original array!
|
|
37
|
+
const reversedItems = computed(() => {
|
|
38
|
+
return items.value.reverse()
|
|
39
|
+
})
|
|
40
|
+
|
|
41
|
+
// BAD: Both arrays now point to the same mutated data
|
|
42
|
+
// items.value and sortedItems.value are the SAME array
|
|
43
|
+
// items.value and reversedItems.value are the SAME array
|
|
44
|
+
|
|
45
|
+
// BAD: Chained mutations
|
|
46
|
+
const sortedUsers = computed(() => {
|
|
47
|
+
return users.value.sort((a, b) => a.age - b.age)
|
|
48
|
+
})
|
|
49
|
+
</script>
|
|
50
|
+
|
|
51
|
+
<template>
|
|
52
|
+
<!-- Original array is corrupted! -->
|
|
53
|
+
<div>Original: {{ items }}</div>
|
|
54
|
+
<div>Sorted: {{ sortedItems }}</div>
|
|
55
|
+
</template>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Correct:**
|
|
59
|
+
```vue
|
|
60
|
+
<script setup>
|
|
61
|
+
import { ref, computed } from 'vue'
|
|
62
|
+
|
|
63
|
+
const items = ref([3, 1, 4, 1, 5, 9, 2, 6])
|
|
64
|
+
const users = ref([
|
|
65
|
+
{ name: 'Alice', age: 30 },
|
|
66
|
+
{ name: 'Bob', age: 25 }
|
|
67
|
+
])
|
|
68
|
+
|
|
69
|
+
// GOOD: Spread operator creates a copy first
|
|
70
|
+
const sortedItems = computed(() => {
|
|
71
|
+
return [...items.value].sort((a, b) => a - b)
|
|
72
|
+
})
|
|
73
|
+
|
|
74
|
+
// GOOD: slice() also creates a copy
|
|
75
|
+
const reversedItems = computed(() => {
|
|
76
|
+
return items.value.slice().reverse()
|
|
77
|
+
})
|
|
78
|
+
|
|
79
|
+
// GOOD: Copy before sorting objects
|
|
80
|
+
const sortedUsers = computed(() => {
|
|
81
|
+
return [...users.value].sort((a, b) => a.age - b.age)
|
|
82
|
+
})
|
|
83
|
+
|
|
84
|
+
// GOOD: Use toSorted() (ES2023) - non-mutating
|
|
85
|
+
const sortedItemsModern = computed(() => {
|
|
86
|
+
return items.value.toSorted((a, b) => a - b)
|
|
87
|
+
})
|
|
88
|
+
|
|
89
|
+
// GOOD: Use toReversed() (ES2023) - non-mutating
|
|
90
|
+
const reversedItemsModern = computed(() => {
|
|
91
|
+
return items.value.toReversed()
|
|
92
|
+
})
|
|
93
|
+
</script>
|
|
94
|
+
|
|
95
|
+
<template>
|
|
96
|
+
<!-- Original array stays intact -->
|
|
97
|
+
<div>Original: {{ items }}</div>
|
|
98
|
+
<div>Sorted: {{ sortedItems }}</div>
|
|
99
|
+
<div>Reversed: {{ reversedItems }}</div>
|
|
100
|
+
</template>
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Mutating vs Non-Mutating Array Methods
|
|
104
|
+
|
|
105
|
+
| Mutating (Avoid in Computed) | Non-Mutating (Safe) |
|
|
106
|
+
|------------------------------|---------------------|
|
|
107
|
+
| `sort()` | `toSorted()` (ES2023) |
|
|
108
|
+
| `reverse()` | `toReversed()` (ES2023) |
|
|
109
|
+
| `splice()` | `toSpliced()` (ES2023) |
|
|
110
|
+
| `push()` | `concat()` |
|
|
111
|
+
| `pop()` | `slice(0, -1)` |
|
|
112
|
+
| `shift()` | `slice(1)` |
|
|
113
|
+
| `unshift()` | `[item, ...array]` |
|
|
114
|
+
| `fill()` | `map()` with new values |
|
|
115
|
+
|
|
116
|
+
## ES2023 Non-Mutating Alternatives
|
|
117
|
+
|
|
118
|
+
Modern JavaScript (ES2023) provides non-mutating versions of common array methods:
|
|
119
|
+
|
|
120
|
+
```javascript
|
|
121
|
+
// These return NEW arrays, safe for computed properties
|
|
122
|
+
const sorted = array.toSorted((a, b) => a - b)
|
|
123
|
+
const reversed = array.toReversed()
|
|
124
|
+
const spliced = array.toSpliced(1, 2, 'new')
|
|
125
|
+
const withReplaced = array.with(0, 'newFirst')
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Deep Copy for Nested Arrays
|
|
129
|
+
|
|
130
|
+
For arrays of objects where you might mutate nested properties:
|
|
131
|
+
|
|
132
|
+
```javascript
|
|
133
|
+
const items = ref([{ name: 'A', values: [1, 2, 3] }])
|
|
134
|
+
|
|
135
|
+
// Shallow copy - nested arrays still shared
|
|
136
|
+
const copied = computed(() => [...items.value])
|
|
137
|
+
|
|
138
|
+
// Deep copy if you need to mutate nested structures
|
|
139
|
+
const deepCopied = computed(() => {
|
|
140
|
+
return JSON.parse(JSON.stringify(items.value))
|
|
141
|
+
// Or use structuredClone():
|
|
142
|
+
// return structuredClone(items.value)
|
|
143
|
+
})
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Reference
|
|
147
|
+
- [Vue.js Computed Properties - Avoid Mutating Computed Value](https://vuejs.org/guide/essentials/computed.html#avoid-mutating-computed-value)
|
|
148
|
+
- [MDN Array Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Ensure All Dependencies Are Accessed in Computed Properties
|
|
3
|
+
impact: HIGH
|
|
4
|
+
impactDescription: Conditional logic can prevent dependency tracking causing stale computed values
|
|
5
|
+
type: capability
|
|
6
|
+
tags: [vue3, computed, reactivity, dependency-tracking, gotcha]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Ensure All Dependencies Are Accessed in Computed Properties
|
|
10
|
+
|
|
11
|
+
**Impact: HIGH** - Vue tracks computed property dependencies by monitoring which reactive properties are accessed during execution. If conditional logic prevents a property from being accessed on the first run, Vue won't track it as a dependency, causing the computed property to not update when that property changes.
|
|
12
|
+
|
|
13
|
+
This is a subtle but common source of bugs, especially with short-circuit evaluation (`&&`, `||`) and early returns.
|
|
14
|
+
|
|
15
|
+
## Task Checklist
|
|
16
|
+
|
|
17
|
+
- [ ] Access all reactive dependencies before any conditional logic
|
|
18
|
+
- [ ] Be cautious with short-circuit operators (`&&`, `||`) that may skip property access
|
|
19
|
+
- [ ] Store all dependencies in variables at the start of the computed getter
|
|
20
|
+
- [ ] Test computed properties with different initial states
|
|
21
|
+
|
|
22
|
+
**Incorrect:**
|
|
23
|
+
```vue
|
|
24
|
+
<script setup>
|
|
25
|
+
import { ref, computed } from 'vue'
|
|
26
|
+
|
|
27
|
+
const isEnabled = ref(false)
|
|
28
|
+
const data = ref('important data')
|
|
29
|
+
|
|
30
|
+
// BAD: If isEnabled is false initially, data.value is never accessed
|
|
31
|
+
// Vue won't track 'data' as a dependency!
|
|
32
|
+
const result = computed(() => {
|
|
33
|
+
if (!isEnabled.value) {
|
|
34
|
+
return 'disabled'
|
|
35
|
+
}
|
|
36
|
+
return data.value // This dependency may not be tracked
|
|
37
|
+
})
|
|
38
|
+
|
|
39
|
+
// BAD: Short-circuit prevents second access
|
|
40
|
+
const password = ref('')
|
|
41
|
+
const confirmPassword = ref('')
|
|
42
|
+
|
|
43
|
+
const isValid = computed(() => {
|
|
44
|
+
// If password is empty, confirmPassword is never accessed
|
|
45
|
+
return password.value && password.value === confirmPassword.value
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
// BAD: Early return prevents dependency access
|
|
49
|
+
const user = ref(null)
|
|
50
|
+
const permissions = ref(['read', 'write'])
|
|
51
|
+
|
|
52
|
+
const canEdit = computed(() => {
|
|
53
|
+
if (!user.value) {
|
|
54
|
+
return false // permissions.value never accessed when user is null
|
|
55
|
+
}
|
|
56
|
+
return permissions.value.includes('write')
|
|
57
|
+
})
|
|
58
|
+
</script>
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Correct:**
|
|
62
|
+
```vue
|
|
63
|
+
<script setup>
|
|
64
|
+
import { ref, computed } from 'vue'
|
|
65
|
+
|
|
66
|
+
const isEnabled = ref(false)
|
|
67
|
+
const data = ref('important data')
|
|
68
|
+
|
|
69
|
+
// GOOD: Access all dependencies first
|
|
70
|
+
const result = computed(() => {
|
|
71
|
+
const enabled = isEnabled.value
|
|
72
|
+
const currentData = data.value // Always accessed
|
|
73
|
+
|
|
74
|
+
if (!enabled) {
|
|
75
|
+
return 'disabled'
|
|
76
|
+
}
|
|
77
|
+
return currentData
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
// GOOD: Access both values before comparison
|
|
81
|
+
const password = ref('')
|
|
82
|
+
const confirmPassword = ref('')
|
|
83
|
+
|
|
84
|
+
const isValid = computed(() => {
|
|
85
|
+
const pwd = password.value
|
|
86
|
+
const confirm = confirmPassword.value // Always accessed
|
|
87
|
+
|
|
88
|
+
return pwd && pwd === confirm
|
|
89
|
+
})
|
|
90
|
+
|
|
91
|
+
// GOOD: Access all reactive sources upfront
|
|
92
|
+
const user = ref(null)
|
|
93
|
+
const permissions = ref(['read', 'write'])
|
|
94
|
+
|
|
95
|
+
const canEdit = computed(() => {
|
|
96
|
+
const currentUser = user.value
|
|
97
|
+
const currentPermissions = permissions.value // Always accessed
|
|
98
|
+
|
|
99
|
+
if (!currentUser) {
|
|
100
|
+
return false
|
|
101
|
+
}
|
|
102
|
+
return currentPermissions.includes('write')
|
|
103
|
+
})
|
|
104
|
+
</script>
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## The Dependency Tracking Mechanism
|
|
108
|
+
|
|
109
|
+
Vue's reactivity system works by tracking which reactive properties are accessed when a computed property runs:
|
|
110
|
+
|
|
111
|
+
```javascript
|
|
112
|
+
// How Vue tracks dependencies (simplified):
|
|
113
|
+
// 1. Start tracking
|
|
114
|
+
// 2. Run the getter function
|
|
115
|
+
// 3. Record every .value or reactive property access
|
|
116
|
+
// 4. Stop tracking
|
|
117
|
+
|
|
118
|
+
const computed = computed(() => {
|
|
119
|
+
// Vue starts tracking here
|
|
120
|
+
if (conditionA.value) { // conditionA is tracked
|
|
121
|
+
return valueB.value // valueB is ONLY tracked if conditionA is true
|
|
122
|
+
}
|
|
123
|
+
return 'default' // If conditionA is false, valueB is NOT tracked!
|
|
124
|
+
})
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Pattern: Destructure All Dependencies First
|
|
128
|
+
|
|
129
|
+
```javascript
|
|
130
|
+
// GOOD PATTERN: Destructure/access everything at the top
|
|
131
|
+
const result = computed(() => {
|
|
132
|
+
// Access all potential dependencies
|
|
133
|
+
const { user, settings, items } = toRefs(store)
|
|
134
|
+
const userVal = user.value
|
|
135
|
+
const settingsVal = settings.value
|
|
136
|
+
const itemsVal = items.value
|
|
137
|
+
|
|
138
|
+
// Now use conditional logic safely
|
|
139
|
+
if (!userVal) return []
|
|
140
|
+
if (!settingsVal.enabled) return []
|
|
141
|
+
return itemsVal.filter(i => i.active)
|
|
142
|
+
})
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Reference
|
|
146
|
+
- [Vue.js Reactivity in Depth](https://vuejs.org/guide/extras/reactivity-in-depth.html)
|
|
147
|
+
- [GitHub Discussion: Dependency collection gotcha with conditionals](https://github.com/vuejs/Discussion/issues/15)
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Computed Properties Cannot Accept Parameters
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: Attempting to pass arguments to computed properties fails or defeats caching
|
|
5
|
+
type: capability
|
|
6
|
+
tags: [vue3, computed, methods, parameters, common-mistake]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Computed Properties Cannot Accept Parameters
|
|
10
|
+
|
|
11
|
+
**Impact: MEDIUM** - Computed properties are designed to derive values from reactive state without parameters. Attempting to pass arguments defeats the caching mechanism or causes errors. Use methods or computed properties that return functions instead.
|
|
12
|
+
|
|
13
|
+
## Task Checklist
|
|
14
|
+
|
|
15
|
+
- [ ] Use methods when you need to pass parameters
|
|
16
|
+
- [ ] Consider if the parameter can be reactive state instead
|
|
17
|
+
- [ ] If you must parameterize, understand that returning a function loses caching benefits
|
|
18
|
+
- [ ] Prefer method calls in templates for parameterized operations
|
|
19
|
+
|
|
20
|
+
**Incorrect:**
|
|
21
|
+
```vue
|
|
22
|
+
<template>
|
|
23
|
+
<!-- BAD: Computed properties don't accept parameters like this -->
|
|
24
|
+
<p>{{ filteredItems('active') }}</p>
|
|
25
|
+
<p>{{ formattedPrice(100, 'USD') }}</p>
|
|
26
|
+
</template>
|
|
27
|
+
|
|
28
|
+
<script setup>
|
|
29
|
+
import { ref, computed } from 'vue'
|
|
30
|
+
|
|
31
|
+
const items = ref([/* ... */])
|
|
32
|
+
|
|
33
|
+
// BAD: This won't work as expected
|
|
34
|
+
// Computed is called once, not per parameter
|
|
35
|
+
const filteredItems = computed((status) => { // status will be undefined or previous value
|
|
36
|
+
return items.value.filter(i => i.status === status)
|
|
37
|
+
})
|
|
38
|
+
</script>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
```vue
|
|
42
|
+
<script>
|
|
43
|
+
export default {
|
|
44
|
+
data() {
|
|
45
|
+
return { items: [/* ... */] }
|
|
46
|
+
},
|
|
47
|
+
computed: {
|
|
48
|
+
// BAD: Computed doesn't receive arguments
|
|
49
|
+
filteredItems(status) { // 'status' is actually 'this' or undefined
|
|
50
|
+
return this.items.filter(i => i.status === status)
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
</script>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**Correct:**
|
|
58
|
+
```vue
|
|
59
|
+
<template>
|
|
60
|
+
<!-- GOOD: Use method for parameterized operations -->
|
|
61
|
+
<p>{{ getFilteredItems('active') }}</p>
|
|
62
|
+
<p>{{ formatPrice(100, 'USD') }}</p>
|
|
63
|
+
|
|
64
|
+
<!-- GOOD: Or use computed with reactive filter state -->
|
|
65
|
+
<select v-model="statusFilter">
|
|
66
|
+
<option value="active">Active</option>
|
|
67
|
+
<option value="inactive">Inactive</option>
|
|
68
|
+
</select>
|
|
69
|
+
<p>{{ filteredItems }}</p>
|
|
70
|
+
</template>
|
|
71
|
+
|
|
72
|
+
<script setup>
|
|
73
|
+
import { ref, computed } from 'vue'
|
|
74
|
+
|
|
75
|
+
const items = ref([/* ... */])
|
|
76
|
+
const statusFilter = ref('active')
|
|
77
|
+
|
|
78
|
+
// GOOD: Method for parameterized operations
|
|
79
|
+
function getFilteredItems(status) {
|
|
80
|
+
return items.value.filter(i => i.status === status)
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
function formatPrice(amount, currency) {
|
|
84
|
+
return new Intl.NumberFormat('en-US', {
|
|
85
|
+
style: 'currency',
|
|
86
|
+
currency
|
|
87
|
+
}).format(amount)
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// GOOD: Computed with reactive parameter
|
|
91
|
+
const filteredItems = computed(() => {
|
|
92
|
+
return items.value.filter(i => i.status === statusFilter.value)
|
|
93
|
+
})
|
|
94
|
+
</script>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Workaround: Computed Returning a Function
|
|
98
|
+
|
|
99
|
+
If you need something computed-like with parameters, you can return a function. **However, this defeats the caching benefit:**
|
|
100
|
+
|
|
101
|
+
```vue
|
|
102
|
+
<template>
|
|
103
|
+
<p>{{ getItemsByStatus('active') }}</p>
|
|
104
|
+
</template>
|
|
105
|
+
|
|
106
|
+
<script setup>
|
|
107
|
+
import { ref, computed } from 'vue'
|
|
108
|
+
|
|
109
|
+
const items = ref([/* ... */])
|
|
110
|
+
|
|
111
|
+
// This works but provides NO caching benefit
|
|
112
|
+
// The inner function runs every time it's called
|
|
113
|
+
const getItemsByStatus = computed(() => {
|
|
114
|
+
return (status) => items.value.filter(i => i.status === status)
|
|
115
|
+
})
|
|
116
|
+
|
|
117
|
+
// This is essentially equivalent to just using a method
|
|
118
|
+
// Only useful if you need to compose with other computed properties
|
|
119
|
+
</script>
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## When to Use Each Approach
|
|
123
|
+
|
|
124
|
+
| Scenario | Approach | Caching |
|
|
125
|
+
|----------|----------|---------|
|
|
126
|
+
| Fixed filter based on reactive state | Computed | Yes |
|
|
127
|
+
| Dynamic filter passed as argument | Method | No |
|
|
128
|
+
| Filter options from user selection | Computed + reactive param | Yes |
|
|
129
|
+
| Formatting with variable parameters | Method | No |
|
|
130
|
+
| Composed derivation with argument | Computed returning function | Partial |
|
|
131
|
+
|
|
132
|
+
## Make Parameters Reactive
|
|
133
|
+
|
|
134
|
+
The best pattern is often to make the "parameter" a reactive value:
|
|
135
|
+
|
|
136
|
+
```vue
|
|
137
|
+
<script setup>
|
|
138
|
+
import { ref, computed } from 'vue'
|
|
139
|
+
|
|
140
|
+
const items = ref([/* ... */])
|
|
141
|
+
|
|
142
|
+
// Instead of passing 'status' as a parameter:
|
|
143
|
+
const currentStatus = ref('active')
|
|
144
|
+
|
|
145
|
+
// Make a computed that uses the reactive status
|
|
146
|
+
const filteredItems = computed(() => {
|
|
147
|
+
return items.value.filter(i => i.status === currentStatus.value)
|
|
148
|
+
})
|
|
149
|
+
|
|
150
|
+
// Change the filter by updating the ref
|
|
151
|
+
function filterByStatus(status) {
|
|
152
|
+
currentStatus.value = status
|
|
153
|
+
}
|
|
154
|
+
</script>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Reference
|
|
158
|
+
- [Vue.js Computed Properties](https://vuejs.org/guide/essentials/computed.html)
|
|
159
|
+
- [Vue.js Methods](https://vuejs.org/guide/essentials/reactivity-fundamentals.html#declaring-methods)
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Computed Property Getters Must Be Side-Effect Free
|
|
3
|
+
impact: HIGH
|
|
4
|
+
impactDescription: Side effects in computed getters break reactivity and cause unpredictable behavior
|
|
5
|
+
type: efficiency
|
|
6
|
+
tags: [vue3, computed, reactivity, side-effects, best-practices]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Computed Property Getters Must Be Side-Effect Free
|
|
10
|
+
|
|
11
|
+
**Impact: HIGH** - Computed getter functions should only perform pure computation. Side effects in computed getters break Vue's reactivity model and cause bugs that are difficult to trace.
|
|
12
|
+
|
|
13
|
+
Computed properties are designed to declaratively describe how to derive a value from other reactive state. They are not meant to perform actions or modify state.
|
|
14
|
+
|
|
15
|
+
## Task Checklist
|
|
16
|
+
|
|
17
|
+
- [ ] Never mutate other reactive state inside a computed getter
|
|
18
|
+
- [ ] Never make async requests or API calls inside a computed getter
|
|
19
|
+
- [ ] Never perform DOM mutations inside a computed getter
|
|
20
|
+
- [ ] Use watchers for reacting to state changes with side effects
|
|
21
|
+
- [ ] Use event handlers for user-triggered actions
|
|
22
|
+
|
|
23
|
+
**Incorrect:**
|
|
24
|
+
```vue
|
|
25
|
+
<script setup>
|
|
26
|
+
import { ref, computed } from 'vue'
|
|
27
|
+
|
|
28
|
+
const items = ref([])
|
|
29
|
+
const count = ref(0)
|
|
30
|
+
const lastFetch = ref(null)
|
|
31
|
+
|
|
32
|
+
// BAD: Mutates other state
|
|
33
|
+
const doubledCount = computed(() => {
|
|
34
|
+
count.value++ // Side effect - modifying state!
|
|
35
|
+
return count.value * 2
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
// BAD: Makes async request
|
|
39
|
+
const userData = computed(async () => {
|
|
40
|
+
const response = await fetch('/api/user') // Side effect - API call!
|
|
41
|
+
return response.json()
|
|
42
|
+
})
|
|
43
|
+
|
|
44
|
+
// BAD: Modifies DOM
|
|
45
|
+
const highlightedItems = computed(() => {
|
|
46
|
+
document.title = `${items.value.length} items` // Side effect - DOM mutation!
|
|
47
|
+
return items.value.filter(i => i.highlighted)
|
|
48
|
+
})
|
|
49
|
+
|
|
50
|
+
// BAD: Writes to external state
|
|
51
|
+
const processedData = computed(() => {
|
|
52
|
+
lastFetch.value = new Date() // Side effect - modifying state!
|
|
53
|
+
return items.value.map(i => i.name)
|
|
54
|
+
})
|
|
55
|
+
</script>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Correct:**
|
|
59
|
+
```vue
|
|
60
|
+
<script setup>
|
|
61
|
+
import { ref, computed, watch, onMounted } from 'vue'
|
|
62
|
+
|
|
63
|
+
const items = ref([])
|
|
64
|
+
const count = ref(0)
|
|
65
|
+
const userData = ref(null)
|
|
66
|
+
|
|
67
|
+
// GOOD: Pure computation only
|
|
68
|
+
const doubledCount = computed(() => {
|
|
69
|
+
return count.value * 2
|
|
70
|
+
})
|
|
71
|
+
|
|
72
|
+
// GOOD: Use lifecycle hook for initial fetch
|
|
73
|
+
onMounted(async () => {
|
|
74
|
+
const response = await fetch('/api/user')
|
|
75
|
+
userData.value = await response.json()
|
|
76
|
+
})
|
|
77
|
+
|
|
78
|
+
// GOOD: Pure filtering
|
|
79
|
+
const highlightedItems = computed(() => {
|
|
80
|
+
return items.value.filter(i => i.highlighted)
|
|
81
|
+
})
|
|
82
|
+
|
|
83
|
+
// GOOD: Use watcher for side effects
|
|
84
|
+
watch(items, (newItems) => {
|
|
85
|
+
document.title = `${newItems.length} items`
|
|
86
|
+
}, { immediate: true })
|
|
87
|
+
|
|
88
|
+
// Increment count through event handler, not computed
|
|
89
|
+
function increment() {
|
|
90
|
+
count.value++
|
|
91
|
+
}
|
|
92
|
+
</script>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## What Counts as a Side Effect
|
|
96
|
+
|
|
97
|
+
| Side Effect Type | Example | Alternative |
|
|
98
|
+
|-----------------|---------|-------------|
|
|
99
|
+
| State mutation | `otherRef.value = x` | Use watcher |
|
|
100
|
+
| API calls | `fetch()`, `axios()` | Use watcher or lifecycle hook |
|
|
101
|
+
| DOM manipulation | `document.title = x` | Use watcher |
|
|
102
|
+
| Console logging | `console.log()` | Remove or use watcher |
|
|
103
|
+
| Storage access | `localStorage.setItem()` | Use watcher |
|
|
104
|
+
| Timer setup | `setTimeout()` | Use lifecycle hook |
|
|
105
|
+
|
|
106
|
+
## Reference
|
|
107
|
+
- [Vue.js Computed Properties - Getters Should Be Side-Effect Free](https://vuejs.org/guide/essentials/computed.html#getters-should-be-side-effect-free)
|