Move rules settings to ESLint shared config: part 2 - check imports #239

Belco90 · 2020-10-21T20:05:49Z

Relates to #198

Second part which includes:

shared config to be able to set module where Testing Library utils can be imported from
mechanism to check if Testing Library is considered as imported depending on shared config
aggressive reporting by default

So the plugin is gonna assume that Testing Library is imported:

if no "testing-library/module" set, then it's always considered as imported
else, then it's considered as imported if "testing-library" import or custom module set within "testing-library/module" setting found

Why? To follow the philosophy discussed here so by default the plugin is really aggressive to avoid missing code that should be reported. Then, if the plugin is reporting things out of the scope for the user, they can config that scope properly through shared settings.

First thing that can be configured is the module from where Testing Library is considered as imported. So if the user has its own utils reexported from @testing-library/framework in test-utils module, they can set that up so the plugin will consider just @testing-library/framework and test-utils as modules where TL utils can be imported from.

This mechanism is implemented globally through detectTestingLibraryUtils so rules don't need to take care of this manually since the rule creator will prevent reporting when necessary.

Next step: shared config and mechanism for test file name patterns. You'll find more comments throughout this PR.

Belco90 · 2020-10-21T20:07:19Z

lib/detect-testing-library-utils.ts

-    context: Readonly<TSESLint.RuleContext<TMessageIds, TOptions>>,
+    context: Readonly<
+      TSESLint.RuleContext<TMessageIds, TOptions> & {
+        settings: TestingLibrarySettings;


I can't think of a better way of typing the settings!

Belco90 · 2020-10-21T20:09:22Z

lib/detect-testing-library-utils.ts

    optionsWithDefault: Readonly<TOptions>
-  ): TRuleListener => {
-    let isImportingTestingLibrary = false;
+  ): TSESLint.RuleListener => {


I've replaced returned type from TRuleListener to TSESLint.RuleListener since detectTestingLibraryUtils modifies the received rules listener to add or remove some so it can end being a different set of rule listener.

lib/detect-testing-library-utils.ts

Belco90 · 2020-10-21T20:18:18Z

lib/detect-testing-library-utils.ts

-      (enhancedRuleInstructions as TSESLint.RuleListener)[instruction] = (
-        node
-      ) => {
+    allKeys.forEach((instruction) => {


Now I iterate through all keys to be able to prevent original rule instructions.

Belco90 · 2020-10-21T20:19:01Z

lib/detect-testing-library-utils.ts

        if (instruction in detectionInstructions) {
          detectionInstructions[instruction](node);
        }

-        if (ruleInstructions[instruction]) {
+        if (helpers.canReportErrors() && ruleInstructions[instruction]) {


Here is where the plugin prevents original rule instructions to be executed if conditions are not met!

I'm a bit lost in understanding what's the difference between the method canReportErrors and getIsTestingLibraryImported - given the first one just calls the second

in addition to that, if I understand correctly, we would just execute the rules if TL is imported, otherwise, nothing gets executed - is that correct?

I'm anticipating next PR with canReportErrors so it warps all necessary checks to know if rules should report errors or not. That's just knowing if Testing Library is imported from now, but in the next PR I'll add the shared option to customize the file names pattern which should be checked by regexp, so the user can set to just report from this plugin on files named *.test.js. This is interesting when you have different kind of tests files (.test.js for Testing Library and .spec.js for Cypress) or just to reduce the scope of the plugin. So in the next PR canReportErrors will check more things and will be in charge of wrap all necessary checks in the future if others needed.

in addition to that, if I understand correctly, we would just execute the rules if TL is imported, otherwise, nothing gets executed - is that correct?

Yes, but by default TL is always considered as imported due to the "aggressive reporting" mode.

Belco90 · 2020-10-21T20:19:33Z

lib/rules/no-node-access.ts

    function showErrorForNodeAccess(node: TSESTree.MemberExpression) {
      isIdentifier(node.property) &&
        ALL_RETURNING_NODES.includes(node.property.name) &&
-        helpers.getIsImportingTestingLibrary() &&


This is not necessary anymore! ✨

Belco90 · 2020-10-21T20:20:49Z

tests/create-testing-library-rule.test.ts

@@ -0,0 +1,93 @@
+import { createRuleTester } from './lib/test-utils';


I added this test file to check both createTestingLibraryRule + detectTestingLibraryUtils together, covering as much edge cases as possible.

Belco90 · 2020-10-21T20:21:38Z

tests/fake-rule.ts

@@ -0,0 +1,42 @@
+/**


Fake rule trying to report stuff asap to be able to run the previous test file.

Belco90 · 2020-10-21T20:22:58Z

tests/lib/rules/no-node-access.test.ts

@@ -51,22 +51,38 @@ ruleTester.run(RULE_NAME, rule, {
        within(signinModal).getByPlaceholderText('Username');
      `,
    },
-    {
+    /*{


I'll reenable this test in the PR part 3 since there is where I'm gonna include the test file name pattern to report or not rules, so this will be solved then. First of many bugs I'll find during this refactor 😅

Belco90 · 2020-10-21T20:23:32Z

tests/lib/rules/no-node-access.test.ts

+      code: `
+      // case: without importing TL (aggressive reporting)
+      const closestButton = document.getElementById('submit-btn')
+      expect(closestButton).toBeInTheDocument();
+      `,


This was a valid case before but it isn't anymore. I'll find more like this in other rules.

gndelia · 2020-10-24T19:12:25Z

lib/detect-testing-library-utils.ts

+        return isImportingTestingLibraryModule || isImportingCustomModule;
+      },
+      canReportErrors() {
+        return this.getIsTestingLibraryImported();


it's been a long time since I've seen a this 😄

tests/fake-rule.ts

gndelia

Looking great 🚀

Belco90 · 2020-10-25T19:18:16Z

Thanks for your review, merging now! Can't wait to have the rest of the shared config, it's gonna make rules implementation much easier.

My idea is to create the PR for the option to customize the test files name pattern next week, reenabling the commented test out in this PR and updating the login for canReportErrors. Then I'll update couple of rules to use the new rule creator.

After that I'll add the last shared config for defining custom render methods, which will be the most complex one.

github-actions · 2021-03-28T18:18:15Z

🎉 This PR is included in version 4.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

* feat: recommend prefer-screen-queries (#169) BREAKING CHANGE: `prefer-screen-queries` rule is automatically enabled if recommended, angular, react or vue config enabled. If you have any of those enabled, you could get new ESLint errors related to this rule after upgrading this plugin. * feat: recommend no-wait-for-empty-callback (#168) BREAKING CHANGE: `no-wait-for-empty-callback` rule is automatically enabled if recommended, angular, react or vue config enabled. If you have any of those enabled, you could get new ESLint errors related to this rule after upgrading this plugin. * feat(no-container): setup new rule on index * refactor(no-container): set rules * test(no-container): define scenarios * refactor(no-debug): extract auxiliary functions to node-utils, to be used by no-container * refactor(no-container): add conditional for containerIndex | clean up method declaration * docs(no-container): add new and update README * refactor(no-container): allow custom render functions * test(no-container): add custom render function * docs(no-container): update further reading topics * docs(no-container): update | add description about testing library frameworks | add link to container docs | remove recommended badge * test(no-container): add scenarios * refactor(no-container): adjust to new scenarios | update error message * docs(no-container): add incorrect use cases * refactor(no-container): remove wrong use case scenario * refactor(no-container): add scenario | destructure method from container * refactor(no-container): rename function and change its scope * refactor(no-container): remove condition * refactor(no-container): update error message and incorrect use case * feat(no-promise-in-fire-event): add new no-promise-in-fire-event rule (#180) * feat(no-promise-in-fire-event): add new no-promise-in-fire-event rule * test: 100% code coverage * docs: add rule to readme * chore: review changes * chore: add rule to recommended config * refactor: rename recommended config to dom (#184) BREAKING CHANGE: `recommended` config preset has been renamed to `dom`, so make sure to update it in your ESLint config file if you were using `recommended` preset. * feat: add rule no-multiple-assertions-wait-for (#189) * feat: add initial files for no-multiple-expect-wait-for rule * fix: add expect fields in test * feat: add no-multiple-assertion-wait-for logic * feat: add findClosestCalleName in node-utils * feat: add check for expect and rename file * docs: add no-multiple-assertions-wait-for rule doc * docs: add link for no-multiple-assertions-wait-for doc * docs: insert function example in no-multiple-assertions-wait-for * refactor: remove find closest call node from node-utils * fix: check expect based in total * docs: better english in no-multiple-assertions-wait-for rule details Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com> * fix: use correct rule name in no-multiple-assertions-wait-for Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com> * docs: improve docs for no-multiple-assertions-wait-for * fix: typo in no-multiple-assertions-wait-for * fix: better english in no-multiple-assertions-wait-for Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com> * feat: add no-node-access rule (#190) * refactor(utils): add properties and methods that returns another Node * test(no-node-access): add first scenarios * feat(no-node-access): add rule with few test cases * test(no-node-access): add scenarios * refactor(no-node-access): simplify conditions * refactor(no-node-access): add scenario when no variable is declared * refactor(no-node-access): remove conditional * refactor(utils): add DOM properties * refactor(no-node-access): add scenario for accessing document directly * docs(no-node-access): add readme * refactor(utils): export const containing all properties and methods that return a Node * docs(no-node-access): fix file location * docs(readme): add no-node-access * refactor(no-node-access): change highlight location * docs(no-node-access): fix typo * refactor(utils): add missing property that returns a Node * refactor(no-node-access): simplify checks triggering error for all methods with names matching the forbidden ones * test(no-node-access): add more scenarios with destructuring * docs(no-node-access): update examples * refactor(no-node-access): narrow error cases * refactor(no-node-access): check imports to validate whether is importing a testing-library package | update examples and testing scenarios * refactor(no-node-access): rename variable * feat: add prefer-user-event rule (#192) * feat: add render-result-naming-convention rule (#200) * feat: rule skeleton * test: first round * feat: rule implementation round 1 * refactor: move hasTestingLibraryImportModule * test: fix invalid lines * feat: check imported module * feat: check imported render renamed * feat: check custom render * test: add more valid tests for custom render functions * test: update tests for render wrapper functions * docs: add rule docs * test: increase coverage up to 100% * fix: add rule meta description * docs: update rule details to mention screen object * refactor: return as soon as conditions are not met * feat: check wildcard imports * refactor: rename default import * docs: include render result link * feat: add no-side-effects-wait-for rule (#196) * test: add scenarios for no-side-effects-wait-for * feat: add no-side-effects-wait-for rule * feat: add no-side-effects-wait-for in index * test: add more valid scenarios in no-side-effects-wait-for * docs: include no-side-effects-wait-for * fix: typo in no-side-effects-wait-for doc Co-authored-by: Gonzalo D'Elia <gonzalo.n.delia@gmail.com> * fix: remove extra code in examples * refactor: use some instead filter in no-side-effects-wait-for * feat: check if no-side-effects-wait-for is called inside tests * refactor: use util for import check at no-side-effects-wait-for * test: valid scenario for no TL wait for import at no-side-effects * refactor: usage of correct user event methods Co-authored-by: Gonzalo D'Elia <gonzalo.n.delia@gmail.com> * chore: lint and format on pre-commit and ci (#216) * chore: lint and format on pre-commit and ci * chore: changing stage name in travis ci conf * chore: merge master into v4 (#233) * feat(prefer-explicit-assert): add 'assertion' config option (#220) Closes #218 * docs: add skovy as a contributor (#221) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * feat: new no-wait-for-snapshot rule (#223) Closes: #214 * docs: add Gpx as a contributor [skip ci] (#224) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs(no-wait-for-snapshot): fix link to rule doc (#225) * docs: add jdanil as a contributor [skip ci] (#226) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Update .travis.yml * feat: support ESLint 7.x (#139) Closes #138 * docs: add MichaelDeBoey as a contributor [skip ci] (#231) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * chore: update dependencies + run prettier on codebase (#232) * chore: update dependencies * chore: run Prettier on full codebase Co-authored-by: Spencer Miskoviak <5247455+skovy@users.noreply.github.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Giorgio Polvara <polvara@gmail.com> Co-authored-by: Josh David <joshua.david@uqconnect.edu.au> Co-authored-by: Mario Beltrán Alarcón <belco90@gmail.com> * chore: update dependencies + run prettier on codebase (#234) BREAKING CHANGE: Minimum node version required is v10.22.1 BREAKING CHANGE: Minimum ESLint version required is 7.5.0. Support for ESLint between v5 and v7.4 has been dropped * style: apply prettier after merge * refactor(no-node-access): use new testing library rule maker (#237) * build: add npmrc file Adding .npmrc file to indicate we don't want to generate package-lock properly. * refactor: first approach for testing library detection * refactor: move testing library detection to high-order function * refactor: include create-testing-library-rule * refactor(no-node-access): use create-testing-library-rule * test: decrease coverage threshold for utils detection * test: decrease coverage threshold for utils detection branches * style: add missing return type on function * style: format with prettier properly Apparently the regexp for formatting the files within npm command must be passed with double quotes. More details here: https://dev.to/gruckion/comment/b665 * docs: copied types clarification * refactor: improve logic to detect if testing librar imported (#239) * refactor: check testing library imports automatically * feat: add new shared setting for testing library module * test: increase coverage for create testing library rule * refactor: extract common enhanced rule create types * docs: add jsdoc to detection helpers * docs: update old comments related to ImportDeclaration * test: check rule listener are combined properly * feat: new setting for reported filename pattern (#244) * feat: new setting for customizing file name pattern to report * test: add custom rule tester for testing library * refactor: use common rule tester config * refactor(no-dom-import): use createTestingLibraryRule (#247) * feat: new setting for customizing file name pattern to report * test: add custom rule tester for testing library * refactor: use common rule tester config * refactor(no-dom-import): use createTestingLibraryRule * feat(detection-helpers): check imports with require * test(no-dom-import): include test cases for custom module setting * test(no-dom-import): include test cases for custom module setting * chore: fix merge * refactor(no-dom-import): extract detection helpers for import nodes * test: increase coverage * refactor: rename setting for filename pattern * docs(consistent-data-testid): add clarification about rule creation (#248) * feat: new setting for customizing file name pattern to report * test: add custom rule tester for testing library * refactor: use common rule tester config * refactor(no-dom-import): use createTestingLibraryRule * feat(detection-helpers): check imports with require * test(no-dom-import): include test cases for custom module setting * test(no-dom-import): include test cases for custom module setting * chore: fix merge * refactor(no-dom-import): extract detection helpers for import nodes * test: increase coverage * refactor: rename setting for filename pattern * refactor: add new detection option to skip reporting checks * refactor(consistent-data-testid): use createTestingLibraryRule * revert: refactor consistent-data-testid * revert: detection options * docs(consistent-data-testid): add clarification about rule creation * refactor(no-manual-cleanup): use custom rule creator (#249) * refactor(no-manual-cleanup): use custom rule creator * refactor: extract detection utils for import module name * refactor(no-manual-cleanup): use detection helpers for imported modules * refactor(no-manual-cleanup): small improvements * test(no-manual-cleanup): include more variants * feat(no-manual-cleanup): report custom module * refactor: rename type for import module node * refactor: use node utils to know node type * refactor: remove unused imports * refactor: remove outdated comment line * refactor(prefer-user-event): use new custom rule creator (#251) * feat: add new settings for prefer-user-event pt1 * feat: part2 of refactoring user event. improved docs * test: improved coverage for prefer-user-event. applied feedback * refactor(prefer-presence-queries): use custom rule creator (#252) * test(prefer-presence-queries): improve existing invalid tests * refactor(prefer-presence-queries): use custom rule creator * feat(prefer-presence-queries): use aggressive query reporting * refactor(prefer-presence-queries): rename message ids * test: add fake rule tests for queries * refactor(extract helpers for detecting presence/absence assets): add fake rule tests for queries * refactor(prefer-presence-queries): use presence/absence helpers * refactor: simplify negated matcher condition * style: format files after rebase * refactor: detection helpers tweaks (#254) * refactor(extract helpers for detecting presence/absence assets): add fake rule tests for queries * refactor(prefer-presence-queries): use presence/absence helpers * refactor: rename boolean detection helpers * refactor: create helpers as separated functions * refactor(ast-utils): migrate custom node-utils to ASTUtils (#256) Closes #253 * refactor(ast-utils): remove isIdentifier * refactor(ast-utils): migrate isAwaitExpression * refactor(ast-utils): use optional chaining for consistency * chore: decrease node-utils coverage threshold * refactor(prefer-wait-for): use new custom rule creator (#255) * refactor: prefer-wait-for with the new settings * refactor: generalized util method * refactor: applied feedback from pr * test: improve coverage * refactor: use custom rule creator for promise-queries rules (#260) * refactor(no-await-sync-query): use custom rule creator * refactor(no-await-sync-query): improve error message * test(no-await-sync-query): check error location in invalid cases * refactor(no-await-sync-query): catch sync queries with detection helper * test(no-await-sync-query): use more realistic scenarios * test(no-await-sync-query): add more cases for custom queries and settings * refactor(await-async-query): use custom rule creator * refactor(await-async-query): improve error message * feat: new detection helpers for findBy queries * refactor(await-async-query): detection helpers + aggressive reporting * test(await-async-query): add cases for custom queries * test(await-async-query): add more cases for custom queries * test(await-async-query): check errors locations * test(await-async-query): mix built-in and custom queries * test(await-async-query): non-matching query case * feat(await-async-query): report query wrappers * refactor(await-async-query): extract ast utils for functions * test(await-async-query): cases for arrow functions * refactor(await-async-query): extract ast util for promise handled * test(await-async-query): increase coverage * refactor(await-async-query): rename isPromiseResolved to hasChainedThen * docs(await-async-query): update rule description and examples * docs(await-async-query): minor improvements * refactor: minor type fix * docs(await-async-query): more fixes * docs(await-async-query): wrong return type * refactor(await-async-query): check regex more efficiently * refactor(await-async-utils): use custom rule creator (#263) * refactor: extract utils for checking promise all methods * test(await-async-query): add cases for promise all and allSettled * docs(await-async-query): add cases for promise all and allSettled * refactor(await-async-utils): create rule with custom creator * refactor(await-async-utils): replace async utils regexp by method * refactor(await-async-utils): replace manual import checks by helper * refactor(await-async-utils): replace manual promise checks by util * refactor(await-async-utils): merge identifier and member expression nodes checks * test(await-async-query): check column on invalid cases * test(await-async-query): promise.allSettled cases * refactor(await-async-query): extract util to get innermost returning function name * feat(await-async-utils): report unhandled functions wrapping async utils * docs: minor improvements * test(await-async-utils): increase coverage * refactor: repurpose getInnermostReturningFunctionName to getInnermostReturningFunction * refactor(await-fire-event): use custom rule creator (#265) * refactor(await-async-utils): create rule with custom creator * docs(await-fire-event): update description * refactor(await-fire-event): create rule with custom creator * refactor(await-fire-event): replace manual promise checks by util * refactor: simplify isNodeComingFromTestingLibrary * fix: call findClosestCallExpressionNode recursively keeping args * refactor(prefer-user-event): extract fire event helpers * refactor(await-async-utils): remove unnecessary as expression * refactor(await-fire-event): reuse fire event detection helpers * feat(await-fire-event): detect functions wrapping fire event methods * fix(await-fire-event): detect more cases * test(await-fire-event): increase coverage * docs(await-fire-event): update rule details and examples * test(await-async-utils): remove outdated comment * docs(await-fire-event): update async note * style(await-fire-event): format rule doc * refactor(await-fire-event): remove unnecessary check * refactor(no-promise-in-fire-event): use custom rule creator (#266) * refactor(await-async-utils): create rule with custom creator * test(await-async-utils): remove outdated comment * docs(no-promise-in-fire-event): improve description and examples * docs(no-promise-in-fire-event): improve invalid errors checks * refactor(no-promise-in-fire-event): use custom rule creator and helpers * feat(no-promise-in-fire-event): detect promise in variable references * docs(no-promise-in-fire-event): update examples * test(no-promise-in-fire-event): increase coverage up to 100% * refactor(no-wait-for-snapshot) migrate to v4 (#271) * refactor: migrate no-wait-for-snapshot to v4 * refactor: apply pr suggestions * refactor(prefer-find-by) migrate to v4 (#270) * refactor: migrate prefer-find-by to v4 * refactor: applied pr suggestions * refactor(prefer-explicit-assert): use new utils and remove custom query option (#274) * refactor(prefer-explicit-assert): use new utils and remove custom query option * test: add custom query method * fix(no-await-sync-query): avoid reporting queries if not within callee (#278) Fixes #276 * refactor: remove duplicated param type * refactor: rename helpers for determining query variants * refactor(render-result-naming-convention): migrate to v4 (#280) * docs: add comments to main parts to be modified * refactor(render-result-naming-convention): first approach for new helper First implementation of isRenderUtil helper, and use it within this rule. * refactor(aggressive-render): update criteria to consider valid renders Before, it was checking if the name of the method started by "render". Now, it checks if the name of the method contains render. * feat(aggressive-render): keep aggressive module reporting in mind Depending on aggressive module reporting, isRenderUtil needs to check if node comes from valid Testing Library module or not. * test(render-result-naming-convention): move valid to invalid tests * docs(aggressive-reporting): improve jsdocs * test(create-testing-library-rule): cases for render * refactor: second round of tweaks (#281) * refactor(shared-settings): rename utils-module Rename testing-library/module to testing-library/utils-module * refactor(detection-helpers): improve fn type definitions * test(filename-pattern): simplify settings patterns * fix: check member expression properly within isRenderUtil helper * test: improve create-testing-library-rule test cases * refactor: check if coming from Testing Library within isAsyncUtil * refactor: extract common method for determining if node is TL util * refactor: improve TL util node detection from identifier * refactor: rename getIdentifierNode to clarify its behavior * fix: improve check for determining if node coming from TL * test: add async util test cases to fake rule * docs: format jsdoc * refactor(render-result-naming-convention): refine checks to decide if coming from Testing Library (#282) * feat(render-result-naming-convention): detect render calls from wrappers * fix: check imported node properly when specifiers are renamed ImportNamespaceSpecifier had to be checked properly in order to detect rename imports properly like: import { a as b } from 'foo' * refactor: split checks for import matching node name in different methods * test(render-result-naming-convention): add extra invalid case for wrapped function * fix(render-result-naming-convention): cover more renamed imports * ci: update pipeline with v4 changes (#289) * ci: migrate to GitHub Actions (#286) * ci: schedule github actions updates * ci: add github actions release workflow * ci: remove config related to travis * ci: split workflows * ci: use action for installing dependencies * ci: remove lint max warnings * ci: improve scripts * ci: remove format check * ci: install dependencies with npm * ci: revert - install dependencies with npm * ci: install dependencies manually on test step * ci: set ci env var on install step * ci: install peer deps in legacy mode * ci: revert manual deps install * ci: remove node 15 * ci: update badge in README.md Closes #275 * ci: github actions improvements (#288) * chore: fix scripts related to testing * ci: bump checkout action to v2 * ci: merge workflows files into single one * ci: add a step for canceling previous runs * ci: remove workflow run conditions * ci: rename workflow * ci: update github actions with v4 CI changes * chore: bump dependencies to last minor * chore: setting test environment to jest-environment-jsdom v25 I had to downgrade jsdom because of some errors jsdom v16 was causing when running tests in node v10. Apparently, jsdom v16 is compatible with node v10, so I'm not sure why is causing an issue. This can be removed when dropping support for node v10. * refactor(prefer-screen-queries): migrate to v4 (#285) * refactor(prefer-screen-queries): use new rule creator * refactor(prefer-screen-queries): detect render methods with helper * refactor(prefer-screen-queries): detect queries with helper * fix(prefer-screen-queries): detect queries coming from proper render * chore: update dependencies (#290) * refactor(no-wait-for-empty-callback): migrate to v4 (#284) * refactor(no-wait-for-empty-callback): use new rule creator and helpers * test(no-wait-for-empty-callback): improve invalid asserts * test(no-wait-for-empty-callback): increase rule coverage * refactor: improve valid names definition (PR suggestions) * refactor(refactor no-debug): migrate to v4 (#293) * refactor(no-debug): use new rule creator * test(no-debug): improve current invalid error assertions * docs(no-debug): fix typo * refactor(no-debug): report debug call expressions with detection helpers * refactor(no-debug): report debug from renders with detection helpers * refactor(no-debug): remove unnecessary checks * refactor(no-container): migrate to v4 (#295) * docs(no-container): remove custom render reference * test(no-container): improve errors asserts * refactor(no-container): use new rule creator * refactor(no-container): extract isRenderVariableDeclarator helper * refactor(no-container): improve node reported location * refactor(no-container): detect nodes coming from render wrapper * refactor(no-debug): detect nodes coming from render wrapper * refactor: remove mechanism to match files to be reported (#297) * refactor(no-render-in-setup): migrate to v4 (#299) * docs: update rule description - remove references "renderFunctions" rule option - improve examples * test: improve errors location asserts * refactor: use new rule creator * docs: update error message and description * refactor(no-debug): remove option schema leftover * refactor: remove custom render option in favor of helper * refactor: improve error reported location * feat: detect wrapper functions around render * refactor: improve utils types * refactor: remove unused node util * test: improve test cases * refacto(no-wait-for-side-effects): migrate to v4 (#300) * test: improve errors location asserts * refactor: use new rule creator * refactor: improve error reported location * refactor: use new helpers for detection * test: add more cases * feat: detect properly if fireEvent and userEvent should be reported * test: add cases for increasing coverage up to 100% * refactor: rename rule for consistency * docs: remove duplicated no-wait-for-snapshot row * fix: get identifier node simpler * refactor(no-wait-for-multiple-assertions): migrate to v4 (#301) * test: improve errors location asserts * refactor: use new rule creator * refactor: improve error reported location * refactor: use new helpers for detection * test: add more cases * feat: detect properly if fireEvent and userEvent should be reported * test: add cases for increasing coverage up to 100% * refactor: rename rule for consistency * docs: remove duplicated no-wait-for-snapshot row * refactor: rename rule * test: improve errors location asserts * refactor: use new rule creator * refactor: use new helpers for detection * refactor: improve error reported location * test: add more cases * refactor(no-await-sync-events): migrate to v4 (#302) * docs: update rule description * test: improve current cases * refactor: use new rule creator * feat: avoid reporting type and keyboard with 0 delay * refactor: use new helpers for detection * test: split fire and user events cases * test: improve errors location asserts * feat: detect user-event import properly * test: add cases for increasing coverage up to 100% * test: assert error message data * refactor: cleanup after migrating all rules to v4 (#303) * docs: update rule description * test: improve current cases * refactor: use new rule creator * feat: avoid reporting type and keyboard with 0 delay * refactor: use new helpers for detection * test: split fire and user events cases * test: improve errors location asserts * feat: detect user-event import properly * test: add cases for increasing coverage up to 100% * test: assert error message data * test: set final threshold for node-utils * chore: extract semantic release config to its own file * docs: including testing-library prefix in all rules * docs: including testing-library rule prefix in README * fix(await-async-utils): reference correct node name * fix(prefer-find-by): simplify error message * fix(no-await-sync-query): avoid false positive from parent func * test(no-await-sync-query): increase code coverage up to 100% * feat(no-wait-for-multiple-assertions): report assertions * test(no-wait-for-multiple-assertions): increase code coverage up to 100% * fix(no-wait-for-side-effects): report on each side effect node * test(no-await-sync-query): include extra case for disappearance * fix: guard against null deepest identifier node * fix: guard against null property identifier node * ci: decrease coverage threshold * fix: enable TS strict mode * fix: remove closing comment leftover * refactor: declare test cases typings as expected * fix: remove wrong boolean check for detection * fix(prefer-user-event): format list of userEvent methods correctly (#311) * fix(prefer-user-event): format list of userEvent methods correctly * test(prefer-user-event): check error data in all invalid cases Closes #310 * fix: second round of bugfixes for v4 (#314) * fix: handle require without assignment properly * fix: handle another require without assignment properly * fix: update rule levels on presets - remove prefer-user-event from presets - report no-debug as error on presets * docs: indicate prefer-user-event is not enabled in any preset Closes #313 * docs: add guide for migrating to v4 (#312) * docs: first steps for migrating to v4 guide * docs: extract Aggressive Reporting Query info to its own section * docs: explain Aggressive Reporting motivation and mechanism * docs: describe each aggressive reporting mechanism * docs: shared settings * docs: update info related to Shareable Configs updated * docs: fix typo * docs: fix more typos * docs: replace tho by though * docs: fix wrong new lines entered * ci: remove duplicated max-warnings param * docs: update README for v4 (#317) * docs: update README for v4 * docs: move detailed settings to migratuin guide * docs: format md files with prettier * chore: update dependencies (#319) * fix: third round of bug fixes (#320) * fix(prefer-screen-queries): improve error message * chore: update package keywords Closes #318 * docs: update contributing guidelines to v4 (#321) * docs: update contributing guidelines to v4 * docs: contributing guidelines PR suggestion Co-authored-by: Michaël De Boey <info@michaeldeboey.be> * docs: more contributing guidelines PR suggestions Co-authored-by: Michaël De Boey <info@michaeldeboey.be> Co-authored-by: Michaël De Boey <info@michaeldeboey.be> * ci: remove unnecessary quote marks for node versions Co-authored-by: Michaël De Boey <info@michaeldeboey.be> * Revert "ci: remove unnecessary quote marks for node versions" This reverts commit b150663 * chore: revert node 10.22.1 as minimum version Minimum node version required for using the plugin is still 10.12 but it was up to 10.22.1 because of a dev dependency. This won't affect usages of the plugin so I'm reverting it. More details here: #234 * ci: include 12.0 in node versions matrix * ci: wrap matrix values within quotes Co-authored-by: Nick McCurdy <nick@nickmccurdy.com> Co-authored-by: Mateus Felix <mateus.felix@c6bank.com> Co-authored-by: Mateus Felix <mateus.cfoliveira@gmail.com> Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com> Co-authored-by: Gonzalo D'Elia <gonzalo.n.delia@gmail.com> Co-authored-by: Renato Augusto Gama dos Santos <renato_0603@hotmail.com> Co-authored-by: Michaël De Boey <info@michaeldeboey.be> Co-authored-by: Spencer Miskoviak <5247455+skovy@users.noreply.github.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Giorgio Polvara <polvara@gmail.com> Co-authored-by: Josh David <joshua.david@uqconnect.edu.au> Co-authored-by: Thomas Lombart <thomas.lombart@hey.com>

github-actions · 2021-04-11T18:18:24Z

🎉 This PR is included in version 4.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Belco90 added 2 commits October 20, 2020 18:54

refactor: check testing library imports automatically

d2844a1

feat: add new shared setting for testing library module

824150d

Belco90 added this to the v4 milestone Oct 21, 2020

Belco90 requested review from gndelia, thomaslombart and timdeschryver October 21, 2020 20:05

Belco90 self-assigned this Oct 21, 2020

Belco90 commented Oct 21, 2020

View reviewed changes

lib/detect-testing-library-utils.ts Show resolved Hide resolved

Belco90 commented Oct 21, 2020

View reviewed changes

lib/detect-testing-library-utils.ts Outdated Show resolved Hide resolved

Belco90 commented Oct 21, 2020

View reviewed changes

lib/detect-testing-library-utils.ts Outdated Show resolved Hide resolved

Belco90 commented Oct 21, 2020

View reviewed changes

tests/fake-rule.ts

@@ -0,0 +1,42 @@

/**

Copy link

Member Author

Belco90 Oct 21, 2020

Choose a reason for hiding this comment

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

Fake rule trying to report stuff asap to be able to run the previous test file.

Belco90 commented Oct 21, 2020

View reviewed changes

Belco90 mentioned this pull request Oct 21, 2020

[await-async-query] Support custom queries and wrappers #222

Closed

test: increase coverage for create testing library rule

4b16c7b

gndelia reviewed Oct 24, 2020

View reviewed changes

tests/fake-rule.ts Outdated Show resolved Hide resolved

Belco90 added 4 commits October 25, 2020 12:11

refactor: extract common enhanced rule create types

4f8e43f

docs: add jsdoc to detection helpers

e9d7bc3

docs: update old comments related to ImportDeclaration

476b7f6

test: check rule listener are combined properly

400d343

Belco90 requested a review from gndelia October 25, 2020 11:50

gndelia approved these changes Oct 25, 2020

View reviewed changes

Belco90 merged commit 63c9d7b into v4 Oct 25, 2020

Belco90 deleted the issue/198__check-imports branch October 25, 2020 19:21

Belco90 linked an issue Oct 26, 2020 that may be closed by this pull request

Move rules settings to ESLint shared config #198

Closed

29 tasks

Belco90 removed a link to an issue Oct 28, 2020

Move rules settings to ESLint shared config #198

Closed

29 tasks

Belco90 linked an issue Oct 28, 2020 that may be closed by this pull request

Move rules settings to ESLint shared config #198

Closed

29 tasks

Belco90 removed a link to an issue Dec 4, 2020

Move rules settings to ESLint shared config #198

Closed

29 tasks

Belco90 mentioned this pull request Dec 4, 2020

Move rules settings to ESLint shared config #198

Closed

29 tasks

github-actions bot added the released on @beta label Mar 28, 2021

github-actions bot added the released label Apr 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move rules settings to ESLint shared config: part 2 - check imports #239

Move rules settings to ESLint shared config: part 2 - check imports #239

Belco90 commented Oct 21, 2020

Belco90 Oct 21, 2020

Belco90 Oct 21, 2020 •

edited

Loading

Belco90 Oct 21, 2020

Belco90 Oct 21, 2020

gndelia Oct 24, 2020 •

edited

Loading

gndelia Oct 24, 2020

Belco90 Oct 24, 2020

Belco90 Oct 21, 2020

Belco90 Oct 21, 2020

Belco90 Oct 21, 2020

Belco90 Oct 21, 2020 •

edited

Loading

Belco90 Oct 21, 2020

gndelia Oct 24, 2020

gndelia left a comment

Belco90 commented Oct 25, 2020

github-actions bot commented Mar 28, 2021

github-actions bot commented Apr 11, 2021

		@@ -0,0 +1,93 @@
		import { createRuleTester } from './lib/test-utils';

Move rules settings to ESLint shared config: part 2 - check imports #239

Move rules settings to ESLint shared config: part 2 - check imports #239

Conversation

Belco90 commented Oct 21, 2020

Choose a reason for hiding this comment

Belco90 Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gndelia Oct 24, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Belco90 Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gndelia left a comment

Choose a reason for hiding this comment

Belco90 commented Oct 25, 2020

github-actions bot commented Mar 28, 2021

github-actions bot commented Apr 11, 2021

Belco90 Oct 21, 2020 •

edited

Loading

gndelia Oct 24, 2020 •

edited

Loading

Belco90 Oct 21, 2020 •

edited

Loading