Skip to content

Add missing config fields to type #724

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

Merged
merged 3 commits into from
Jul 30, 2020

Conversation

thepelkus-too
Copy link
Contributor

What:

Adding fields to the Config type to support the options that are documented.

Why:

Without adding these fields to the types, using them in projects which support types will cause errors or require exceptions to type enforcement. Example provided in issue #721

How:

Adding fields to existing Config type.

Checklist:

  • [N/A] Documentation added to the
    docs site
  • [N/A] Tests
  • Typescript definitions updated
  • Ready to be merged

I'll caveat this with saying that I'm not sure exactly how the type tests work. Would it make sense to add a function there that attempts to set each of the fields (or all of the fields at once) on the configuration to verify that there aren't type errors there?

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 29, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 07e702c:

Sandbox Source
kentcdodds/react-testing-library-examples Configuration

@codecov
Copy link

codecov bot commented Jul 29, 2020

Codecov Report

Merging #724 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #724   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        24           
  Lines          646       646           
  Branches       168       168           
=========================================
  Hits           646       646           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c57f06...07e702c. Read the comment docs.

Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

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

Cool, thanks!

@kentcdodds kentcdodds merged commit 54aebf7 into testing-library:master Jul 30, 2020
@kentcdodds
Copy link
Member

🎉 This PR is included in version 7.21.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

3 participants