From 53653c153ffa7412adad77d9fb0488be6728e390 Mon Sep 17 00:00:00 2001 From: Chris Blossom Date: Sun, 27 Oct 2019 14:31:39 -0700 Subject: [PATCH] fix(require-tothrow-message): rename rule to require-to-throw-message (#306) BREAKING CHANGE: Rename `require-tothrow-message` to `require-to-throw-message` closes #296 --- README.md | 4 ++-- ...message.md => require-to-throw-message.md} | 0 ...st.ts => require-to-throw-message.test.ts} | 20 +++++++++---------- ...message.ts => require-to-throw-message.ts} | 6 +++--- 4 files changed, 15 insertions(+), 15 deletions(-) rename docs/rules/{require-tothrow-message.md => require-to-throw-message.md} (100%) rename src/rules/__tests__/{require-tothrow-message.test.ts => require-to-throw-message.test.ts} (88%) rename src/rules/{require-tothrow-message.ts => require-to-throw-message.ts} (81%) diff --git a/README.md b/README.md index b67334a8f..dcd83243e 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ installations requiring long-term consistency. | [prefer-to-have-length][] | Suggest using `toHaveLength()` | ![style][] | ![fixable-green][] | | [prefer-todo][] | Suggest using `test.todo()` | | ![fixable-green][] | | [require-top-level-describe][] | Require a top-level `describe` block | | | -| [require-tothrow-message][] | Require that `toThrow()` and `toThrowError` includes a message | | | +| [require-to-throw-message][] | Require that `toThrow()` and `toThrowError` includes a message | | | | [valid-describe][] | Enforce valid `describe()` callback | ![recommended][] | | | [valid-expect-in-promise][] | Enforce having return statement when testing with promises | ![recommended][] | | | [valid-expect][] | Enforce valid `expect()` usage | ![recommended][] | | @@ -200,7 +200,7 @@ https://github.com/dangreenisrael/eslint-plugin-jest-formatting [prefer-to-have-length]: docs/rules/prefer-to-have-length.md [prefer-todo]: docs/rules/prefer-todo.md [require-top-level-describe]: docs/rules/require-top-level-describe.md -[require-tothrow-message]: docs/rules/require-tothrow-message.md +[require-to-throw-message]: docs/rules/require-to-throw-message.md [valid-describe]: docs/rules/valid-describe.md [valid-expect-in-promise]: docs/rules/valid-expect-in-promise.md [valid-expect]: docs/rules/valid-expect.md diff --git a/docs/rules/require-tothrow-message.md b/docs/rules/require-to-throw-message.md similarity index 100% rename from docs/rules/require-tothrow-message.md rename to docs/rules/require-to-throw-message.md diff --git a/src/rules/__tests__/require-tothrow-message.test.ts b/src/rules/__tests__/require-to-throw-message.test.ts similarity index 88% rename from src/rules/__tests__/require-tothrow-message.test.ts rename to src/rules/__tests__/require-to-throw-message.test.ts index 264e5db1d..7c6e38420 100644 --- a/src/rules/__tests__/require-tothrow-message.test.ts +++ b/src/rules/__tests__/require-to-throw-message.test.ts @@ -1,6 +1,6 @@ import { TSESLint } from '@typescript-eslint/experimental-utils'; import resolveFrom from 'resolve-from'; -import rule from '../require-tothrow-message'; +import rule from '../require-to-throw-message'; const ruleTester = new TSESLint.RuleTester({ parser: resolveFrom(require.resolve('eslint'), 'espree'), @@ -9,7 +9,7 @@ const ruleTester = new TSESLint.RuleTester({ }, }); -ruleTester.run('require-tothrow-message', rule, { +ruleTester.run('require-to-throw-message', rule, { valid: [ // String "expect(() => { throw new Error('a'); }).toThrow('a');", @@ -68,8 +68,8 @@ ruleTester.run('require-tothrow-message', rule, { code: "expect(() => { throw new Error('a'); }).toThrow();", errors: [ { - messageId: 'requireRethrow', - data: { propertyName: 'toThrow' }, + messageId: 'addErrorMessage', + data: { matcherName: 'toThrow' }, column: 41, line: 1, }, @@ -80,8 +80,8 @@ ruleTester.run('require-tothrow-message', rule, { code: "expect(() => { throw new Error('a'); }).toThrowError();", errors: [ { - messageId: 'requireRethrow', - data: { propertyName: 'toThrowError' }, + messageId: 'addErrorMessage', + data: { matcherName: 'toThrowError' }, column: 41, line: 1, }, @@ -97,14 +97,14 @@ ruleTester.run('require-tothrow-message', rule, { })`, errors: [ { - messageId: 'requireRethrow', - data: { propertyName: 'toThrow' }, + messageId: 'addErrorMessage', + data: { matcherName: 'toThrow' }, column: 49, line: 3, }, { - messageId: 'requireRethrow', - data: { propertyName: 'toThrowError' }, + messageId: 'addErrorMessage', + data: { matcherName: 'toThrowError' }, column: 49, line: 4, }, diff --git a/src/rules/require-tothrow-message.ts b/src/rules/require-to-throw-message.ts similarity index 81% rename from src/rules/require-tothrow-message.ts rename to src/rules/require-to-throw-message.ts index 13282e4fc..ef4201e85 100644 --- a/src/rules/require-tothrow-message.ts +++ b/src/rules/require-to-throw-message.ts @@ -14,7 +14,7 @@ export default createRule({ recommended: false, }, messages: { - requireRethrow: 'Add an error message to {{ propertyName }}()', + addErrorMessage: 'Add an error message to {{ propertyName }}()', }, type: 'suggestion', schema: [], @@ -39,8 +39,8 @@ export default createRule({ ) { // Look for `toThrow` calls with no arguments. context.report({ - messageId: 'requireRethrow', // todo: rename to 'addErrorMessage' - data: { propertyName: matcher.name }, // todo: rename to 'matcherName' + messageId: 'addErrorMessage', + data: { matcherName: matcher.name }, node: matcher.node.property, }); }