agentleFS
skilld-devskilld-dev/vue-ecosystem-skills/skills/vue-test-utils-skilld/SKILL.md

vue-test-utils-skilld

Skill184 starsChanged 37 days agoMITView on GitHub

ALWAYS use when writing, debugging, or reviewing code that imports "@vue/test-utils" or mentions vue test-utils, VTU, mount, shallowMount, findComponent, wrapper queries, or migrating from Vue Test Utils v1. Provides the current API surface, mounting options, wrapper methods, and testing recipes for @vue/test-utils 2.5.1 on Vue 3.

  • Installs packages

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 1 is distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Test-runner agnostic (Vitest, Jest, others).

    line 11
  2. Very specific:

    Use get() / getComponent() when the element must exist.

    line 49
  3. Very specific:

    Use flushPromises() for promises Vue does not track (mocked HTTP clients, setTimeout).

    line 52
  4. Very specific:

    Prefer mount with targeted global.stubs over shallowMount.

    line 94
  5. Very specific:

    If you do stub broadly, set config.global.renderStubDefaultSlot = true so default slot content of stubs still renders …

    line 95
  6. Very specific:

    Test composables by mounting a minimal host component and reading state from wrapper.vm.

    line 99
  7. Very specific:

    Use RouterLinkStub when testing around <router-link> without installing a router: global.stubs: { 'router-link': RouterLinkStub }.

    line 102

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

@vue/test-utils 2.5.1 (Vue 3)

Prepared source: input/source, version 2.5.1 (package.json:3). Requires Vue 3.x and @vue/compiler-dom 3.x as peers; @vue/server-renderer 3.x is an optional peer needed only for renderToString (package.json:73-81). Test-runner agnostic (Vitest, Jest, others). Needs a browser-like DOM environment (jsdom or happy-dom).

Install: npm install @vue/test-utils --save-dev

Quick start

import { mount } from '@vue/test-utils'
import Counter from './Counter.vue'

test('increments', async () => {
  const wrapper = mount(Counter, { props: { start: 1 } })
  await wrapper.find('button').trigger('click')
  expect(wrapper.text()).toContain('2')
})

Public API surface

Exports from dist/src/index.d.ts:13:

ExportKindUse
mountfunctionMount a component, returns VueWrapper (dist/src/mount.d.ts:17)
shallowMountfunctionSame as mount with all child components stubbed (dist/src/mount.d.ts:22)
renderToStringfunctionSSR-render a component to a string, Promise<string> (dist/src/renderToString.d.ts:4)
flushPromisesfunctionAwait pending non-Vue promises (mocked API calls, timers) (dist/src/utils/flushPromises.d.ts:1)
enableAutoUnmount(hook)functionUnmount all wrappers via a test hook (dist/src/utils/autoUnmount.d.ts:4)
disableAutoUnmountfunctionStop auto unmounting (dist/src/utils/autoUnmount.d.ts:3)
VueWrapperclassWrapper around a mounted component instance (dist/src/vueWrapper.d.ts:5)
DOMWrapperclassWrapper around a DOM element; new DOMWrapper(document.body) (dist/src/domWrapper.d.ts:4)
RouterLinkStubcomponentStub for <router-link> (dist/src/components/RouterLinkStub.d.ts:1)
configobjectShared default mount options and wrapper plugins (dist/src/config.d.ts:32)
createWrapperErrorfunctionInternal; produces the error wrapper returned by find misses

Core rules

  • await every method that returns a promise: trigger, setValue, setProps, setData, renderToString, flushPromises. Without await, assertions run before the DOM updates.
  • Use get() / getComponent() when the element must exist; they throw on miss. Use find() / findComponent() only when absence is a valid outcome; they return an error wrapper whose exists() is false.
  • find() accepts CSS selectors only. To locate a child component use findComponent(Component), findComponent({ name: 'Foo' }), findComponent({ ref: 'foo' }), or a CSS selector.
  • Register enableAutoUnmount(afterEach) once in test setup to prevent state leaks between tests.
  • Use flushPromises() for promises Vue does not track (mocked HTTP clients, setTimeout).
  • wrapper.vm only reliably exposes what the component exposes: options-API state, defineExpose() bindings (since 2.5.0, PR #2927), or setup() return values.
import { enableAutoUnmount } from '@vue/test-utils'
import { afterEach } from 'vitest'

enableAutoUnmount(afterEach)

Version notes: 2.4.10 -> 2.5.1

Earlier v2 milestones still relevant

Migrating from v1 (Vue 2)

Full table: migration reference, official guide https://test-utils.vuejs.org/migration/

  • propsData -> props; createLocalVue removed -> global.plugins / global.mixins
  • mocks, stubs, provide, directives moved under global
  • destroy() -> unmount(); findAll().at(i) -> findAll()[i] (returns an array)
  • createWrapper() removed -> new DOMWrapper(el)
  • setChecked / setSelected removed -> merged into setValue
  • find() no longer finds components by name; use findComponent
  • shallowMount no longer renders default slot content of stubs; restore with config.global.renderStubDefaultSlot = true
  • Removed: is, isEmpty, isVueInstance, name, setMethods, contains, scopedSlots (merged into slots)

Best practices

  • Prefer mount with targeted global.stubs over shallowMount. Shallow tests assert structure, not behavior, and stubbed children hide real interactions. https://test-utils.vuejs.org/guide/advanced/stubs-shallow-mount
  • If you do stub broadly, set config.global.renderStubDefaultSlot = true so default slot content of stubs still renders (dist/src/types.d.ts:125-131).
  • Stub directives with the vName key: global.stubs: { vTooltip: true } or pass a replacement directive object.
  • <transition> and <transition-group> are stubbed by default (dist/src/types.d.ts:120-124); custom transition stubs are supported.
  • Pass inject values through global.provide, matching production injection. For typed injection keys, wrap the key: provide: { [injectionKey as symbol]: value }.
  • Test composables by mounting a minimal host component and reading state from wrapper.vm.
  • Wrap components with async setup() in a <Suspense> host before mounting.
  • For <Teleport>, either stub it (global.stubs: { teleport: true }) or create the target element in beforeEach and query it with document.querySelector. https://test-utils.vuejs.org/guide/advanced/teleport
  • Use RouterLinkStub when testing around <router-link> without installing a router: global.stubs: { 'router-link': RouterLinkStub }.

References

  • Mounting options and config: every mount / shallowMount / renderToString option, global.*, and the config object.
  • Wrapper API: every VueWrapper / DOMWrapper method with signatures.
  • Migration v1 -> v2: full option and method mapping plus 2.5.x changes.
  • Testing recipes: forms, v-model, emitted events, router, Vuex/Pinia, Suspense, Teleport, SSR.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.