Skip to content
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

Export MountingOptions interface #252

Merged
merged 3 commits into from
Nov 22, 2020
Merged

Conversation

afontcu
Copy link
Member

@afontcu afontcu commented Nov 20, 2020

Having MountingOptions available in Vue Testing Library will improve greatly the DX of people using the library.

Copy link
Member

@cexbrayat cexbrayat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 If it's now public, we could even add documentation on each option (they would show up in IDE)

@afontcu
Copy link
Member Author

afontcu commented Nov 21, 2020

👍 If it's now public, we could even add documentation on each option (they would show up in IDE)

Sure, that'd be great!

However, it is not related to making the interface public, right? As far as I know, people using VTU is already "seeing" the outputs of the interface.

@cexbrayat
Copy link
Member

Right, but it's a good rule of thumb that exported types should be documented. I'm fine merging it like this though, it was just nitpicking :)

@afontcu
Copy link
Member Author

afontcu commented Nov 21, 2020

no prob! I'll update this with some documentation :)

@afontcu
Copy link
Member Author

afontcu commented Nov 22, 2020

Done! Decided to move type into types.ts file because it grew a lot.

@cexbrayat
Copy link
Member

@afontcu 👏 thank you for taking the time to do this! LGTM

@afontcu
Copy link
Member Author

afontcu commented Nov 22, 2020

totally worth it! It also helped me identify several missing keys in our docs. Working on it now.

Copy link
Member

@lmiller1990 lmiller1990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true beauty is documenting each type

@lmiller1990 lmiller1990 merged commit 412c83f into master Nov 22, 2020
@lmiller1990 lmiller1990 deleted the export-mounting-options branch November 22, 2020 13:10
@scottbedard
Copy link

@afontcu Thank you for this! This makes building custom mount functions much nicer!

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

Successfully merging this pull request may close these issues.

None yet

6 participants