Skip to content

Commit 6049ba6

Browse files
committed
docs: readme
1 parent 69c8a00 commit 6049ba6

File tree

1 file changed

+2
-15
lines changed

1 file changed

+2
-15
lines changed

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
# vue-test-utils-next
1+
## Vue Test Utils Next Docs
22

3-
The next iteration of Vue Test Utils. Based of the work in [vue-testing-framework](https://github.com/lmiller1990/vue-testing-framework).
3+
Docs for VTU Next. Find the source code [here](https://github.com/vuejs/vue-test-utils-next/).
44

5-
## Development
6-
7-
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!
8-
9-
Lots to do. Most of the ideas and roadmap is in Notion. See issues [here](https://github.com/vuejs/vue-test-utils-next/issues) for some basic TODOs.
10-
11-
## Working with `.vue` files
12-
13-
There is [`vue-jest`](https://github.com/vuejs/vue-jest) for loading `.vue` files into Jest for Vue 2. I'm not sure how much work it would be to migrate it to use `@vue/sfc-compiler`. To get going quickly, I hacked together a simple Jest transformer using `@vue/sfc-compiler`, find it [here](https://github.com/lmiller1990/vue-jest-transformer). It's probably bad, but it's enough to let us use `.vue` files in Jest in this project. I am finding render functions more ideal, since you can inline them in the tests and get IDE completion, but both are fine.
14-
15-
## Contributing
16-
17-
This is still very much pre-beta - if you want to add a feature, have a hack or ping someone in Discord to chat, or check out the issues.

0 commit comments

Comments
 (0)