Skip to content

feat: add defaultIgnore config option #1138

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 20, 2022
Merged

feat: add defaultIgnore config option #1138

merged 1 commit into from
Jun 20, 2022

Conversation

robin-drexler
Copy link
Contributor

@robin-drexler robin-drexler commented Jun 15, 2022 •
edited by eps1lon
Loading

What:

Adds defaultIgnore config option for byText in a similar vein to what already exists with defaultHidden for byRole.

Why:
Allows to set a default ignore globally for a project.

How:
Adds new config option. Also uses potentially overridden config value in places where the the default const was used before as this seemed to make sense to me.

Is this a change you'd be willing to accept?
If yes, I'd be happy to add docs etc. Thanks! :)

Checklist:

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jun 15, 2022 •
edited
Loading

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 83a9db2:

Sandbox Source
react-testing-library-examples Configuration

@robin-drexler robin-drexler marked this pull request as ready for review June 15, 2022 00:34
@robin-drexler robin-drexler changed the title add defaultIgnore config option add defaultIgnore config option for byText Jun 15, 2022
eps1lon
eps1lon previously approved these changes Jun 15, 2022
View reviewed changes
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Thanks. This was planned as a follow-up but I didn't have time.

Could you make a PR to the docs as well?

@codecov
Copy link

codecov bot commented Jun 15, 2022 •
edited
Loading

Codecov Report

Merging #1138 (83a9db2) into main (11fc773) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main     #1138   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        24    -1     
  Lines          985       985           
  Branches       320       321    +1     
=========================================
  Hits           985       985
Flag Coverage Δ
node-12 100.00% <100.00%> (ø)
node-14 100.00% <100.00%> (ø)
node-16 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/config.ts 100.00% <ø> (ø)
src/pretty-dom.js 100.00% <100.00%> (ø)
src/queries/text.ts 100.00% <100.00%> (ø)
src/suggestions.js 100.00% <100.00%> (ø)

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 11fc773...83a9db2. Read the comment docs.

timdeschryver
timdeschryver previously approved these changes Jun 15, 2022
View reviewed changes
@robin-drexler robin-drexler mentioned this pull request Jun 16, 2022
Merged
@robin-drexler
Copy link
Contributor Author

Thanks. This was planned as a follow-up but I didn't have time.

Could you make a PR to the docs as well?

Opened the PR here: testing-library/testing-library-docs#1088

not sure about how to release and in what order. 😅

Is that something the maintainers will do?

Thanks again!

@robin-drexler robin-drexler dismissed stale reviews from timdeschryver and eps1lon via 83a9db2 June 16, 2022 00:46
@timdeschryver
Copy link
Member

@robin-drexler You don't have to worry about that. Thanks in advance to create both PRs!

Is that something the maintainers will do?

@robin-drexler
Copy link
Contributor Author

@robin-drexler You don't have to worry about that. Thanks in advance to create both PRs!

Is that something the maintainers will do?

Perfect, thanks a lot!
Looking forward to seeing it land. :D

Let me know if I can do anything to support.

@eps1lon
Copy link
Member

eps1lon commented Jun 16, 2022

not sure about how to release and in what order. sweat_smile

I just click two buttons and change the order every so often 😅

@eps1lon eps1lon changed the title add defaultIgnore config option for byText feat(ByText): add defaultIgnore config option Jun 16, 2022
@eps1lon eps1lon changed the title feat(ByText): add defaultIgnore config option feat: add defaultIgnore config option Jun 16, 2022
@eps1lon eps1lon added the enhancement New feature or request label Jun 20, 2022
@eps1lon eps1lon merged commit 4e9484a into testing-library:main Jun 20, 2022
@eps1lon
Copy link
Member

eps1lon commented Jun 20, 2022

@all-contributors add @robin-drexler for code

@allcontributors allcontributors bot mentioned this pull request Jun 20, 2022
Merged
@allcontributors
Copy link
Contributor

@eps1lon

I've put up a pull request to add @robin-drexler! 🎉

@github-actions
Copy link

🎉 This PR is included in version 8.14.0 🎉

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
Reviewers

@timdeschryver timdeschryver timdeschryver left review comments

@eps1lon eps1lon eps1lon approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@robin-drexler @timdeschryver @eps1lon