fix(await-async-query): false positives for await-async-query #208
Conversation
| return ` | ||
| import { render } from '@testing-library/react' | ||
| test("An example test",${isAsync ? ' async ' : ' '}() => { | ||
| ${code} |
There was a problem hiding this comment.
This function allows to get closer to a real test. I'm happy to move it to test-utils and refactor some tests (for example in await-async-utils) if needed 🙂
There was a problem hiding this comment.
This is interesting. I'd prefer to wait until v4 is released to avoid messing up the code and having to resolve lot of conflicts, but it's definitely a nice to have after it! It would need some improvements tho to be able to customize the import etc.
| @@ -1,41 +1,21 @@ | |||
| import { ESLintUtils, TSESTree } from '@typescript-eslint/experimental-utils'; | |||
| import { getDocsUrl } from '../utils'; | |||
| import { getDocsUrl, LIBRARY_MODULES } from '../utils'; | |||
There was a problem hiding this comment.
I think there's an improvement to do on the LIBRARY_MODULES naming. Indeed, it doesn't make sense to make the rule fire on the async queries for @testing-library/cypress. Right now it works because it's not included in the LIBRARY_MODULES constants, however it's still a library module.
Belco90
left a comment
Belco90
left a comment
There was a problem hiding this comment.
Nice work, it's good to have you back collaborating with this plugin!
As you mentioned, v4 will handle better the custom render functions so we can improve it there.
|
🎉 This PR is included in version 3.4.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Closes #122.
Changes
isAwaitedandisPromiseResolvedtonode-utils.tsthat was used in three different rules (await-async-utils,await-async-query,await-fire-event)await-async-queryrule to fire if nothing is imported from one of the testing library modules as declared inLIBRARY_MODULESinutils.ts.await-async-queryto get closer to a real test caseNote that this is a partial improvement to the rule. Indeed, if one is using (and importing) a custom render function in his tests, he won't benefit from the rule as this function would not be imported from a testing library module such as
@testing-library/reactor@testing-library/vue.A fix to that would be to allow the user to input what custom render function he uses, which is one of the breaking changes coming in V4. I think we will be able to further improve this rule after the V4.
What do you think?