Skip to content

Commit 70a59d5

Browse files
authored
Merge pull request #291 from vuejs/afontcu-patch-1
docs: Update README
2 parents 0887d43 + 12f1e64 commit 70a59d5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ The next iteration of Vue Test Utils. It targets Vue 3.
77
- yarn: `yarn add @vue/test-utils@next --dev`
88
- npm: `npm install @vue/test-utils@next --save-dev`
99

10-
## Coming from Vue 2 + Vue Test Utils beta?
10+
## Coming from Vue 2 + Vue Test Utils?
1111

12-
We are working on some documentation to help people migrate. At this point you will have better luck trying this out with a brand new Vue 3 app, as opposed to upgrading an existing Vue 2 app. Feedback and bug reports are welcome!
12+
We are working on [some documentation to help people migrate](https://vue-test-utils.vuejs.org/v2/guide/migration.html).
13+
14+
At this point you will have better luck trying this out with a brand new Vue 3 app, as opposed to upgrading an existing Vue 2 app. Feedback and bug reports are welcome!
1315

1416
## Working with `.vue` files
1517

@@ -19,29 +21,27 @@ If you don't want to configure things, you can download a repository with Vue 3,
1921

2022
## Docs
2123

22-
Docs are located in [this repo](https://github.com/vuejs/vue-test-utils-next-docs). Read them [here](https://vuejs.github.io/vue-test-utils-next-docs/guide/introduction.html). They are in a separate repository because running Vuepress alongside a repo with Vue 3 causes conflicts - Vuepress expects to be running against Vue 2. This seems like the most simple solution for now.
24+
Docs are located in [this repo](https://github.com/vuejs/vue-test-utils-next-docs). Read them [here](https://vue-test-utils.vuejs.org/v2/). They are in a separate repository because running Vuepress alongside a repo with Vue 3 causes conflicts - Vuepress expects to be running against Vue 2. This seems like the most simple solution for now.
2325

2426
## Development
2527

2628
It's a pretty small codebase at the moment. Get started by running `yarn install`. You can run the tests with `yarn test`. That's it!
2729

28-
There is a lot of work to do. See issues for some basic TODOs, or the table at the bottom of this page.
30+
There is still some work left to do. See issues for some basic TODOs, or the table at the bottom of this page.
2931

3032
## What works?
3133

32-
See the [docs](https://vuejs.github.io/vue-test-utils-next-docs/guide/introduction.html). Most basic DOM interactions work. Advanced features like `shallowMount` and `stubs` are a work in progress.
34+
See the [docs](https://vuejs.github.io/vue-test-utils-next-docs/guide/introduction.html).
3335

3436
## Contributing
3537

36-
This is still very much alpha - if you want to add a feature, have a hack or ping someone in Discord to chat, or check out the issues and project board.
37-
38-
## Where is shallowMount
38+
This is still quite alpha, but we plan on moving to RC sooner than later. If you want to add a feature, have a hack or ping someone in Discord to chat, or check out the issues and project board.
3939

40-
It's coming soon. We are working on it. Stay tuned!
40+
There's also some [work left to do in docs](https://github.com/vuejs/vue-test-utils-next-docs/issues).
4141

4242
## Comparsion with Vue Test Utils beta (targeting Vue 2)
4343

44-
This is table for those coming from VTU beta, comparing the two APIs. A lot of things are still a work in progress.
44+
This is table for those coming from VTU 1, comparing the two APIs. Some things are still a work in progress.
4545

4646
- ✅ - implemented
4747
- ❌ - not yet implemented
@@ -90,13 +90,13 @@ props | ✅
9090
setData | ✅ |
9191
destroy | ✅ | renamed to `unmount` to match Vue 3 lifecycle hook name.
9292
props | ✅
93+
isVisible | ✅
9394
contains | ⚰️| use `find`
9495
emittedByOrder | ⚰️ | use `emitted`
9596
setSelected | ⚰️ | now part of `setValue`
9697
setChecked | ⚰️| now part of `setValue`
9798
is | ⚰️
9899
isEmpty | ⚰️ | use matchers such as [this](https://github.com/testing-library/jest-dom#tobeempty)
99-
isVisible | ⚰️ | use matchers such as [this](https://github.com/testing-library/jest-dom#tobevisible)
100100
isVueInstance | ⚰️
101101
name | ⚰️ |
102102
setMethods | ⚰️ |

0 commit comments

Comments
 (0)