Skip to content

Initial TODOs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
36 tasks done
codebryo opened this issue Jun 6, 2017 · 19 comments
Closed
36 tasks done

Initial TODOs #4

codebryo opened this issue Jun 6, 2017 · 19 comments

Comments

@codebryo
Copy link
Contributor

codebryo commented Jun 6, 2017

I copied over the TODOs from #1 (comment) so it's not necessary to hunt them down in the long thread.

TODOs

  • Add shallow method
  • Add emit method? In the proposal this is included in trigger, but it's difficult(impossible?) to implement. Not sure if this is needed, as it will be a thin wrapper around vm.$emit. Won't be added in first version,See API for testing emitted events #6
  • Add option to stub components
  • Finalize VueWrapper interface. Should it call methods on all wrappers, or default to first wrapper? Using find and findAll
  • Add context option to support functional components see Passing context to functional components #12
  • Test find and findAll using functional component with context
  • Add flow
  • Add typescript types
  • Handle empty WrapperArray method calls
  • Handle ErrorWrapper method calls
  • Fix some skipped tests copied from avoriaz
  • Link docs to gitbook
  • add deploy script
  • Update docs format to follow Vue docs style
  • Improve docs, especially info on WrapperArray
  • Improve build pipeline. Should dist be included in the source repo?
  • Add CI tool - travis/ circle
  • Add provide option to mount
  • Add way to add global mixins/plugins/components without polluting global Vue. See Stop Vue.use polluting global Vue instance #2
  • Add ability to test emitted events - although this can be acheived with wrapper.vm.$on('event', spy). Won't be added in first version, See API for testing emitted events #6
  • Add a README
  • Link to Documentation in README
  • Add option to pass component as stub, see Stubbing components #11
  • Add release script
  • Stub registered global components when running shallow
  • Throw an error about running in a browser if window is undefined
  • Add git pre commit hooks to check commit message matches guidelines
  • Improve error messages (errors should have format - [vue-test-utils]: error message)
  • Handle options.instance when stubbing global components in shallow
  • Add option to pass array to options.stub
  • Add children option to pass children to functional components
  • Set default branch to dev
  • Remove npm postinstall from master/ release branches
  • Create example projects and link in README
  • Add guides on setting up vue-test-utils
  • Update mount and shallow arguments in documentation
@LinusBorg
Copy link
Member

(added checkboxes to track progress)

@snaptopixel
Copy link

@codebryo @LinusBorg Is anyone working on the typings? I could probably help there if not, just let me know!

@eddyerburgh
Copy link
Member

@snaptopixel No, would be great if you could make a PR 😄

If you do, please follow the new commit convention - https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md

@Austio
Copy link
Contributor

Austio commented Jun 20, 2017

Are we ready to publish a Beta of the library? Someone already has vue-test-utils on npm, should we reach out and see if we could get that package spot or rename this repo to one we can get on npm

@eddyerburgh
Copy link
Member

eddyerburgh commented Jun 20, 2017

@yyx990803 has already been in touch with the author. I'm happy to publish a beta once it becomes available

@codebryo
Copy link
Contributor Author

@eddyerburgh do we have a gitbook for the docs under development already? I would like to get started on that, and add a bunch of examples.

@eddyerburgh
Copy link
Member

There isn't a gitbook that it's hooked up to, but the /docs directory is in the format requried for a gitbook. It even has a book.json. All that needs to be done is add gitbooks itself to the project.

It would be great for you to start working on it 👍

@eddyerburgh
Copy link
Member

@snaptopixel we still need typings, and I haven't got much experience with typescript. Are you still willing to add them?

@eddyerburgh
Copy link
Member

eddyerburgh commented Jul 21, 2017 via email

@jraller
Copy link

jraller commented Jul 21, 2017

@eddyerburgh for the typings do you have something in mind other than http://definitelytyped.org/guides/contributing.html for how you want that done?

@eddyerburgh
Copy link
Member

eddyerburgh commented Jul 21, 2017

@jraller Yes I think vue-test-utils should be available on Typings 👍 . I misunderstood what typings was.

The types are already added, but if there's anything missing please make a PR 😄

@jraller
Copy link

jraller commented Jul 21, 2017

I just found https://github.com/vuejs/vue-test-utils/tree/master/types and am looking at it now. This renders all of my existing comments rather moot.

@Austio
Copy link
Contributor

Austio commented Aug 10, 2017

Hey hey, any word on publishing?

@eddyerburgh
Copy link
Member

eddyerburgh commented Aug 10, 2017 via email

@Austio
Copy link
Contributor

Austio commented Aug 10, 2017

Sweet, thanks for update and enjoy vacation, i can probably clear some room to knock out this week if there is consensus

@eddyerburgh
Copy link
Member

The problem is that there is no consensus. Previously it was decided that find should behave in a certain way, but another issue caused me to rethink the decision - #24

We need more feedback on these two issues - #5, #27

@jwkicklighter
Copy link

Just checking in since it's bit a little over a month, any updates on publishing?

@eddyerburgh
Copy link
Member

Evan's reviewing the code this week and we're planning to publish a beta on npm

@eddyerburgh
Copy link
Member

The todos are complete, and beta is released 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants