From b8600841e371d5d9f36be4e50e53252fd8f62734 Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Sun, 10 Oct 2021 08:35:55 +1300 Subject: [PATCH] feat(lowercase-name): rename to `prefer-lowercase-title` BREAKING CHANGE: renamed `lowercase-name` to `prefer-lowercase-title` --- README.md | 2 +- ...lowercase-name.md => prefer-lowercase-title.md} | 2 +- src/__tests__/__snapshots__/rules.test.ts.snap | 2 +- ...name.test.ts => prefer-lowercase-title.test.ts} | 14 +++++++------- ...lowercase-name.ts => prefer-lowercase-title.ts} | 0 5 files changed, 10 insertions(+), 10 deletions(-) rename docs/rules/{lowercase-name.md => prefer-lowercase-title.md} (97%) rename src/rules/__tests__/{lowercase-name.test.ts => prefer-lowercase-title.test.ts} (96%) rename src/rules/{lowercase-name.ts => prefer-lowercase-title.ts} (100%) diff --git a/README.md b/README.md index 2d4f08784..3cdbdf624 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,6 @@ installations requiring long-term consistency. | ---------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------- | ------------ | | [consistent-test-it](docs/rules/consistent-test-it.md) | Have control over `test` and `it` usages | | ![fixable][] | | [expect-expect](docs/rules/expect-expect.md) | Enforce assertion to be made in a test body | ![recommended][] | | -| [lowercase-name](docs/rules/lowercase-name.md) | Enforce lowercase test names | | ![fixable][] | | [max-nested-describe](docs/rules/max-nested-describe.md) | Enforces a maximum depth to nested describe calls | | | | [no-alias-methods](docs/rules/no-alias-methods.md) | Disallow alias methods | ![style][] | ![fixable][] | | [no-commented-out-tests](docs/rules/no-commented-out-tests.md) | Disallow commented out tests | ![recommended][] | | @@ -181,6 +180,7 @@ installations requiring long-term consistency. | [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md) | Suggest using `expect.assertions()` OR `expect.hasAssertions()` | | ![suggest][] | | [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md) | Prefer `await expect(...).resolves` over `expect(await ...)` syntax | | ![fixable][] | | [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md) | Suggest having hooks before any test cases | | | +| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md) | Enforce lowercase test names | | ![fixable][] | | [prefer-spy-on](docs/rules/prefer-spy-on.md) | Suggest using `jest.spyOn()` | | ![fixable][] | | [prefer-strict-equal](docs/rules/prefer-strict-equal.md) | Suggest using `toStrictEqual()` | | ![suggest][] | | [prefer-to-be](docs/rules/prefer-to-be.md) | Suggest using `toBe()` for primitive literals | ![style][] | ![fixable][] | diff --git a/docs/rules/lowercase-name.md b/docs/rules/prefer-lowercase-title.md similarity index 97% rename from docs/rules/lowercase-name.md rename to docs/rules/prefer-lowercase-title.md index 3666cb6c6..59c4a8686 100644 --- a/docs/rules/lowercase-name.md +++ b/docs/rules/prefer-lowercase-title.md @@ -1,4 +1,4 @@ -# Enforce lowercase test names (`lowercase-name`) +# Enforce lowercase test names (`prefer-lowercase-title`) ## Rule details diff --git a/src/__tests__/__snapshots__/rules.test.ts.snap b/src/__tests__/__snapshots__/rules.test.ts.snap index 35e71182d..66a0e7c39 100644 --- a/src/__tests__/__snapshots__/rules.test.ts.snap +++ b/src/__tests__/__snapshots__/rules.test.ts.snap @@ -12,7 +12,6 @@ Object { "rules": Object { "jest/consistent-test-it": "error", "jest/expect-expect": "error", - "jest/lowercase-name": "error", "jest/max-nested-describe": "error", "jest/no-alias-methods": "error", "jest/no-commented-out-tests": "error", @@ -39,6 +38,7 @@ Object { "jest/prefer-expect-assertions": "error", "jest/prefer-expect-resolves": "error", "jest/prefer-hooks-on-top": "error", + "jest/prefer-lowercase-title": "error", "jest/prefer-spy-on": "error", "jest/prefer-strict-equal": "error", "jest/prefer-to-be": "error", diff --git a/src/rules/__tests__/lowercase-name.test.ts b/src/rules/__tests__/prefer-lowercase-title.test.ts similarity index 96% rename from src/rules/__tests__/lowercase-name.test.ts rename to src/rules/__tests__/prefer-lowercase-title.test.ts index a68d6b75f..811300f29 100644 --- a/src/rules/__tests__/lowercase-name.test.ts +++ b/src/rules/__tests__/prefer-lowercase-title.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 '../lowercase-name'; +import rule from '../prefer-lowercase-title'; import { DescribeAlias, TestCaseName } from '../utils'; const ruleTester = new TSESLint.RuleTester({ @@ -11,7 +11,7 @@ const ruleTester = new TSESLint.RuleTester({ }, }); -ruleTester.run('lowercase-name', rule, { +ruleTester.run('prefer-lowercase-title', rule, { valid: [ 'it.each()', 'it.each()(1)', @@ -247,7 +247,7 @@ ruleTester.run('lowercase-name', rule, { ], }); -ruleTester.run('lowercase-name with ignore=describe', rule, { +ruleTester.run('prefer-lowercase-title with ignore=describe', rule, { valid: [ { code: "describe('Foo', function () {})", @@ -273,7 +273,7 @@ ruleTester.run('lowercase-name with ignore=describe', rule, { invalid: [], }); -ruleTester.run('lowercase-name with ignore=test', rule, { +ruleTester.run('prefer-lowercase-title with ignore=test', rule, { valid: [ { code: "test('Foo', function () {})", @@ -299,7 +299,7 @@ ruleTester.run('lowercase-name with ignore=test', rule, { invalid: [], }); -ruleTester.run('lowercase-name with ignore=it', rule, { +ruleTester.run('prefer-lowercase-title with ignore=it', rule, { valid: [ { code: "it('Foo', function () {})", @@ -325,7 +325,7 @@ ruleTester.run('lowercase-name with ignore=it', rule, { invalid: [], }); -ruleTester.run('lowercase-name with allowedPrefixes', rule, { +ruleTester.run('prefer-lowercase-title with allowedPrefixes', rule, { valid: [ { code: "it('GET /live', function () {})", @@ -343,7 +343,7 @@ ruleTester.run('lowercase-name with allowedPrefixes', rule, { invalid: [], }); -ruleTester.run('lowercase-name with ignoreTopLevelDescribe', rule, { +ruleTester.run('prefer-lowercase-title with ignoreTopLevelDescribe', rule, { valid: [ { code: 'describe("MyClass", () => {});', diff --git a/src/rules/lowercase-name.ts b/src/rules/prefer-lowercase-title.ts similarity index 100% rename from src/rules/lowercase-name.ts rename to src/rules/prefer-lowercase-title.ts