Alpha-0 API

[lmiller1990]

I propose the following API for alpha-0. Progress is tracked here: https://github.com/vuejs/vue-test-utils-next/projects/1

Each of these has a ticket on the project board.

Exported methods

• mount

shallowMount is not required for an alpha.

mounting options

• data
• slots (support for scoped slots) mounting options: slots/scoped slots #2
• provide Change provides to provides #27
• props
• globals (contains mixins and plugins options) mounting options: global #28

VueWrapper

This is intentionally a minimal API. The primary way users will interact with their components is DOMWrapper in alpha.

• find/findAll find and findAll #7
• emitted
• html
• vm

DOMWrapper

This is the bulk of the functionality.

• classes
• attributes
• exists
• element
• text
• html
• find/findAll find and findAll #7
• setValue (which is combined setChecked/setSelected etc) DOMWrapper: setValue #29
• trigger

Ecosystem

We will also need to release an alpha-0 for vue-jest. Branch here: https://github.com/vuejs/vue-jest/tree/next. If we don't provide this, people won't be able to test SFCs.

Docs/Other

We should provide some examples on how to do things. We should also make sure it's possible to test things that were previously pain points, or new features:

• transitions
• suspense
• portals

Nice to have

• provide example tests with vuex/vue-router?

[JessicaSachs]

RE: vue-jest we also need to finish the v4 alpha because Vue CLI is an entire major version behind

[lmiller1990]

Only #2 remains

[afontcu]

Also: are we still unable to merge vue-test-utils-next and vue-test-utils-next-docs due to vuepress version mismatch? I'd like to have them combined very much 🤔

[lmiller1990]

We are unable to. You cannot have Vue 2 and Vue 3 installed in the same project or Vuepress will fail to run.

We could have a monorepo using lerna. This is easy to set up, if you like I can do it.

Alternatively, since I expect Vuepress will move to Vue 3 eventually, but until then use Vuepress + Vue 2 in this repo, and just have a bash script that installed Vue 2, builds Vuepress, for when you are working on docs.

[lmiller1990]

Or we can have a docs branch that uses Vue 2. This might be best - thoughts @afontcu ? I'm keen to get some docs done so we can do an alpha.

[afontcu]

Okay, let's keep it split for now, at least until Vuepress releases a Vue 3-based version :)

I believe I'll be able to work on catching docs up during the weekend.

[lmiller1990]

Sure, lmk if I can help with anything. I'm guessing the minimal we need is a

• list of the APIs with example(s)
• list of what is different to beta (I can do this)
• whatever else you think makes sense

[lmiller1990]

we did it

time to prepare for a quiet alpha