Skip to content

Commit 7e6a91b

Browse files
committed
chore: add suggestion property to relevant rules
1 parent 765c319 commit 7e6a91b

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

src/rules/no-test-callback.ts

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export default createRule({
88
category: 'Best Practices',
99
description: 'Avoid using a callback in asynchronous tests',
1010
recommended: false,
11+
suggestion: true,
1112
},
1213
messages: {
1314
illegalTestCallback: 'Illegal usage of test callback',

src/rules/prefer-expect-assertions.ts

+1
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ export default createRule<[], MessageIds>({
7272
description:
7373
'Suggest using `expect.assertions()` OR `expect.hasAssertions()`',
7474
recommended: false,
75+
suggestion: true,
7576
},
7677
messages: {
7778
hasAssertionsTakesNoArguments:

src/rules/prefer-strict-equal.ts

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export default createRule({
1313
category: 'Best Practices',
1414
description: 'Suggest using toStrictEqual()',
1515
recommended: false,
16+
suggestion: true,
1617
},
1718
messages: {
1819
useToStrictEqual: 'Use `toStrictEqual()` instead',

src/rules/utils.ts

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ import {
77
} from '@typescript-eslint/experimental-utils';
88
import { version } from '../../package.json';
99

10+
// can be removed once we've on v3: https://github.com/typescript-eslint/typescript-eslint/issues/2060
11+
declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
12+
export interface RuleMetaDataDocs {
13+
suggestion?: boolean;
14+
}
15+
}
16+
1017
const REPO_URL = 'https://github.com/jest-community/eslint-plugin-jest';
1118

1219
export const createRule = ESLintUtils.RuleCreator(name => {

0 commit comments

Comments
 (0)