Skip to content

Commit ec0a21b

Browse files
authored
fix: mark rules that suggest fixes with hasSuggestion for ESLint v8 (#898)
1 parent 34b23e6 commit ec0a21b

6 files changed

+10
-1
lines changed

src/index.ts

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
1313
export interface RuleMetaDataDocs {
1414
suggestion?: boolean;
1515
}
16+
17+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
18+
export interface RuleMetaData<TMessageIds extends string> {
19+
hasSuggestion?: boolean;
20+
}
1621
}
1722

1823
// copied from https://github.com/babel/babel/blob/d8da63c929f2d28c401571e2a43166678c555bc4/packages/babel-helpers/src/helpers.js#L602-L606

src/rules/no-done-callback.ts

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ export default createRule({
4747
},
4848
schema: [],
4949
type: 'suggestion',
50+
hasSuggestion: true,
5051
},
5152
defaultOptions: [],
5253
create(context) {

src/rules/no-focused-tests.ts

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export default createRule({
4949
},
5050
schema: [],
5151
type: 'suggestion',
52+
hasSuggestion: true,
5253
},
5354
defaultOptions: [],
5455
create: context => ({

src/rules/prefer-expect-assertions.ts

+1
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ export default createRule<[RuleOptions], MessageIds>({
8484
suggestRemovingExtraArguments: 'Remove extra arguments',
8585
},
8686
type: 'suggestion',
87+
hasSuggestion: true,
8788
schema: [
8889
{
8990
type: 'object',

src/rules/prefer-strict-equal.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export default createRule({
2121
},
2222
type: 'suggestion',
2323
schema: [],
24+
hasSuggestion: true,
2425
},
2526
defaultOptions: [],
2627
create(context) {

tools/regenerate-docs.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ const details: RuleDetails[] = Object.keys(config.configs.all.rules)
114114
description: rule.meta.docs.description,
115115
fixable: rule.meta.fixable
116116
? 'fixable'
117-
: rule.meta.docs.suggestion
117+
: rule.meta.hasSuggestion
118118
? 'suggest'
119119
: false,
120120
requiresTypeChecking: rule.meta.docs.requiresTypeChecking ?? false,

0 commit comments

Comments
 (0)