Skip to content

fix(require-tothrow-message): rename rule to require-to-throw-message #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 27, 2019
Merged

fix(require-tothrow-message): rename rule to require-to-throw-message #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
877d9cc
fix(require-tothrow-message): rename rule to require-to-throw-message
chrisblossom Aug 21, 2019
51282f0
chore(require-to-throw-message): internal variables renamed
chrisblossom Sep 5, 2019
173bba0
chore: use implicit return
chrisblossom Oct 7, 2019
40ac41b
Merge branch 'next' into rename-require-tothrow-message
SimenB Oct 27, 2019
c3cd290
chore: make breaking
SimenB Oct 27, 2019
1010553
chore: reduce diff
SimenB Oct 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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][] | |
Expand Down Expand Up @@ -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
Expand Down
0 docs/rules/require-tothrow-message.md → docs/rules/require-to-throw-message.md
View file
Open in desktop
File renamed without changes.
20 changes: 10 additions & 10 deletions ...__tests__/require-tothrow-message.test.ts → ..._tests__/require-to-throw-message.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'),
Expand All @@ -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');",
Expand Down Expand Up @@ -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,
},
Expand All @@ -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,
},
Expand All @@ -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,
},
Expand Down
6 changes: 3 additions & 3 deletions src/rules/require-tothrow-message.ts → src/rules/require-to-throw-message.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: [],
Expand All @@ -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,
});
}
Expand Down