From e15a8d19234b267784f87fc7acd318dc4cfcdeae Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Thu, 27 Aug 2020 20:18:51 +1200 Subject: [PATCH] refactor(no-test-callback): rename rule to `no-done-callback` (#653) BREAKING CHANGE: rename `no-test-callback` to `no-done-callback` --- README.md | 2 +- docs/rules/{no-test-callback.md => no-done-callback.md} | 2 +- src/__tests__/__snapshots__/rules.test.ts.snap | 4 ++-- .../{no-test-callback.test.ts => no-done-callback.test.ts} | 4 ++-- src/rules/{no-test-callback.ts => no-done-callback.ts} | 0 5 files changed, 6 insertions(+), 6 deletions(-) rename docs/rules/{no-test-callback.md => no-done-callback.md} (95%) rename src/rules/__tests__/{no-test-callback.test.ts => no-done-callback.test.ts} (98%) rename src/rules/{no-test-callback.ts => no-done-callback.ts} (100%) diff --git a/README.md b/README.md index d67c42dc6..175d5d4c3 100644 --- a/README.md +++ b/README.md @@ -138,6 +138,7 @@ installations requiring long-term consistency. | [no-conditional-expect](docs/rules/no-conditional-expect.md) | Prevent calling `expect` conditionally | ![recommended][] | | | [no-deprecated-functions](docs/rules/no-deprecated-functions.md) | Disallow use of deprecated functions | ![recommended][] | ![fixable][] | | [no-disabled-tests](docs/rules/no-disabled-tests.md) | Disallow disabled tests | ![recommended][] | | +| [no-done-callback](docs/rules/no-done-callback.md) | Avoid using a callback in asynchronous tests | ![recommended][] | ![suggest][] | | [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | Disallow duplicate setup and teardown hooks | | | | [no-export](docs/rules/no-export.md) | Disallow using `exports` in files containing tests | ![recommended][] | | | [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | ![recommended][] | ![fixable][] | @@ -151,7 +152,6 @@ installations requiring long-term consistency. | [no-mocks-import](docs/rules/no-mocks-import.md) | Disallow manually importing from `__mocks__` | ![recommended][] | | | [no-restricted-matchers](docs/rules/no-restricted-matchers.md) | Disallow specific matchers & modifiers | | | | [no-standalone-expect](docs/rules/no-standalone-expect.md) | Disallow using `expect` outside of `it` or `test` blocks | ![recommended][] | | -| [no-test-callback](docs/rules/no-test-callback.md) | Avoid using a callback in asynchronous tests | ![recommended][] | ![suggest][] | | [no-test-prefixes](docs/rules/no-test-prefixes.md) | Use `.only` and `.skip` over `f` and `x` | ![recommended][] | ![fixable][] | | [no-test-return-statement](docs/rules/no-test-return-statement.md) | Disallow explicitly returning from tests | | | | [prefer-called-with](docs/rules/prefer-called-with.md) | Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()` | | | diff --git a/docs/rules/no-test-callback.md b/docs/rules/no-done-callback.md similarity index 95% rename from docs/rules/no-test-callback.md rename to docs/rules/no-done-callback.md index 68b22eb59..0421296f6 100644 --- a/docs/rules/no-test-callback.md +++ b/docs/rules/no-done-callback.md @@ -1,4 +1,4 @@ -# Avoid using a callback in asynchronous tests (`no-test-callback`) +# Avoid using a callback in asynchronous tests (`no-done-callback`) Jest allows you to pass a callback to test definitions, typically called `done`, that is later invoked to indicate that the asynchronous test is complete. diff --git a/src/__tests__/__snapshots__/rules.test.ts.snap b/src/__tests__/__snapshots__/rules.test.ts.snap index 7b68036c7..887ab1c99 100644 --- a/src/__tests__/__snapshots__/rules.test.ts.snap +++ b/src/__tests__/__snapshots__/rules.test.ts.snap @@ -18,6 +18,7 @@ Object { "jest/no-conditional-expect": "error", "jest/no-deprecated-functions": "error", "jest/no-disabled-tests": "error", + "jest/no-done-callback": "error", "jest/no-duplicate-hooks": "error", "jest/no-expect-resolves": "error", "jest/no-export": "error", @@ -32,7 +33,6 @@ Object { "jest/no-mocks-import": "error", "jest/no-restricted-matchers": "error", "jest/no-standalone-expect": "error", - "jest/no-test-callback": "error", "jest/no-test-prefixes": "error", "jest/no-test-return-statement": "error", "jest/no-truthy-falsy": "error", @@ -69,6 +69,7 @@ Object { "jest/no-conditional-expect": "error", "jest/no-deprecated-functions": "error", "jest/no-disabled-tests": "warn", + "jest/no-done-callback": "error", "jest/no-export": "error", "jest/no-focused-tests": "error", "jest/no-identical-title": "error", @@ -77,7 +78,6 @@ Object { "jest/no-jest-import": "error", "jest/no-mocks-import": "error", "jest/no-standalone-expect": "error", - "jest/no-test-callback": "error", "jest/no-test-prefixes": "error", "jest/no-try-expect": "error", "jest/valid-describe": "error", diff --git a/src/rules/__tests__/no-test-callback.test.ts b/src/rules/__tests__/no-done-callback.test.ts similarity index 98% rename from src/rules/__tests__/no-test-callback.test.ts rename to src/rules/__tests__/no-done-callback.test.ts index 31f144020..f53352eb8 100644 --- a/src/rules/__tests__/no-test-callback.test.ts +++ b/src/rules/__tests__/no-done-callback.test.ts @@ -1,7 +1,7 @@ import { TSESLint } from '@typescript-eslint/experimental-utils'; import dedent from 'dedent'; import resolveFrom from 'resolve-from'; -import rule from '../no-test-callback'; +import rule from '../no-done-callback'; const ruleTester = new TSESLint.RuleTester({ parser: resolveFrom(require.resolve('eslint'), 'espree'), @@ -10,7 +10,7 @@ const ruleTester = new TSESLint.RuleTester({ }, }); -ruleTester.run('no-test-callback', rule, { +ruleTester.run('no-done-callback', rule, { valid: [ 'test("something", () => {})', 'test("something", async () => {})', diff --git a/src/rules/no-test-callback.ts b/src/rules/no-done-callback.ts similarity index 100% rename from src/rules/no-test-callback.ts rename to src/rules/no-done-callback.ts