feat(prefer-in-document): add support for assigments #107
Conversation
Codecov Report
@@ Coverage Diff @@
## master #107 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 12 12
Lines 218 238 +20
Branches 27 32 +5
=========================================
+ Hits 218 238 +20
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
I ran this code on one of our codebases to validate, and it crashed. This case seems to be reproducing it:
invalidCase(
`const compressingFeedback = await screen.findByText(/Compressing video/);
expect(compressingFeedback).toBeDefined();`,
`const compressingFeedback = await screen.findByText(/Compressing video/);
expect(compressingFeedback).toBeInTheDocument();`
)I guess the await changes to structure slightly? Here's the full error:
TypeError: Cannot read property 'property' of undefined
Occurred while linting /Users/anton/code/milkywire/enterprise/components/page-specific/impacter-tools/create/CreatePosts.spec.tsx:213
at getQueryNodeFromAssignment (/Users/anton/code/github.com/testing-library/eslint-plugin-jest-dom/dist/rules/prefer-in-document.js:90:31)
at MemberExpression[object.callee.name=expect][property.name=/(toHaveLength|toBeDefined|toBeNull)/][object.arguments.0.type=Identifier] (/Users/anton/code/github.com/testing-library/eslint-plugin-jest-dom/dist/rules/prefer-in-document.js:139:25)
at /Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/safe-emitter.js:45:58
at Array.forEach (<anonymous>)
at Object.emit (/Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/safe-emitter.js:45:38)
at NodeEventGenerator.applySelector (/Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/node-event-generator.js:254:26)
at NodeEventGenerator.applySelectors (/Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/node-event-generator.js:283:22)
at NodeEventGenerator.enterNode (/Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/node-event-generator.js:297:14)
at CodePathAnalyzer.enterNode (/Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/code-path-analysis/code-path-analyzer.js:711:23)
at /Users/anton/code/milkywire/enterprise/node_modules/eslint/lib/linter/linter.js:952:32
…y/eslint-plugin-jest-dom into feature/in-document-fixes
There was a problem hiding this comment.
Looking good! I played around with the latest changes and managed to find another test case that currently crashes:
invalidCase(
`let button;
it("foo", async () => {
button = await screen.findByText('click me');
expect(button).toBeDefined();
});`,
`let button;
it("foo", async () => {
button = await screen.findByText('click me');
expect(button).toBeInTheDocument();
});`
)I do think this "pattern" is fairly common, but it's not really feasible for this rule to support everything of course. I just felt that this case was pretty similar to what you already had there.
| expect(foo).toHaveLength(1); | ||
|
|
||
| const bar = screen.queryByText("bar"); | ||
| expect(bar).toHaveLength(0); |
There was a problem hiding this comment.
Perhaps we could include some async examples here now that it's properly supported?
docs/rules/prefer-in-document.md
Outdated
| expect(foo).toHaveLength(3); | ||
|
|
||
| const bar = screen.queryByText("bar"); | ||
| expect(bar).not.toBeInTheDocument(); |
There was a problem hiding this comment.
Perhaps include some async examples here also, just to be clear.
|
This isn't a code review, but FWIW this fixes the errors in linting testing-library/dom-testing-library#834. Nice work! |
|
🎉 This PR is included in version 3.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
We're getting various runtime failures in dom-testing-library after upgrading and linting with |
|
oy. got any examples? |
|
Do you want me to just publish a branch so you can see the CI build? |
|
that would be excellent, thanks @nickmccurdy |
|
@nickmccurdy looks liek those are coming from usages of |
What: add support for variable assignments with prefer in document
Why: fixes bugs and adds more use cases. fixes: #104
How: checking variable declarations & assignments.
Checklist: