fix: missing placeholders in violation messages for `no-unnecessary-t…

…ype-constraint` and `no-unsafe-argument` (and enable `eslint-plugin/recommended` rules internally) (#5453) * fix: missing placeholders in violation messages for no-unnecessary-type-constraint and no-unsafe-argument (and enable eslint-plugin/recommended rules internally) * add bug link * add bug links for eslint-plugin/no-unused-message-ids rule * add comment about eslint-plugin/consistent-output
typescript-eslint · Aug 11, 2022 · d023910 · d023910
1 parent b6e5413
commit d023910
Show file tree

Hide file tree

Showing 32 changed files with 71 additions and 181 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -15,6 +15,7 @@ module.exports = {
   },
   extends: [
     'eslint:recommended',
+    'plugin:eslint-plugin/recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:@typescript-eslint/recommended-requiring-type-checking',
   ],
@@ -194,7 +195,7 @@ module.exports = {
         '@typescript-eslint/no-unsafe-call': 'off',
         '@typescript-eslint/no-unsafe-member-access': 'off',
         '@typescript-eslint/no-unsafe-return': 'off',
-        'eslint-plugin/no-identical-tests': 'error',
+        'eslint-plugin/consistent-output': 'off', // Might eventually be removed from `eslint-plugin/recommended`: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/284
         'jest/no-disabled-tests': 'warn',
         'jest/no-focused-tests': 'error',
         'jest/no-alias-methods': 'error',

diff --git a/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts b/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts
@@ -35,7 +35,6 @@ export default createRule({
       description:
         "Enforces rules don't use TS API properties with known bad type definitions",
       recommended: 'error',
-      suggestion: true,
       requiresTypeChecking: true,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/naming-convention.ts b/packages/eslint-plugin/src/rules/naming-convention.ts
@@ -1,3 +1,7 @@
+/* eslint-disable eslint-comments/no-use */
+/* eslint eslint-plugin/no-unused-message-ids:"off" -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/283 */
+/* eslint-enable eslint-comments/no-use */
+
 import { AST_NODE_TYPES, TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { PatternVisitor } from '@typescript-eslint/scope-manager';
 import type { ScriptTarget } from 'typescript';

diff --git a/packages/eslint-plugin/src/rules/no-duplicate-enum-values.ts b/packages/eslint-plugin/src/rules/no-duplicate-enum-values.ts
@@ -9,7 +9,7 @@ export default util.createRule({
       description: 'Disallow duplicate enum member values',
       recommended: 'strict',
     },
-    hasSuggestions: true,
+    hasSuggestions: false,
     messages: {
       duplicateValue: 'Duplicate enum member value {{value}}.',
     },

diff --git a/packages/eslint-plugin/src/rules/no-empty-interface.ts b/packages/eslint-plugin/src/rules/no-empty-interface.ts
@@ -15,10 +15,9 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the declaration of empty interfaces',
       recommended: 'error',
-      suggestion: true,
     },
     fixable: 'code',
-    hasSuggestions: true,
+    hasSuggestions: true, // eslint-disable-line eslint-plugin/require-meta-has-suggestions -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/272
     messages: {
       noEmpty: 'An empty interface is equivalent to `{}`.',
       noEmptyWithSuper:

diff --git a/packages/eslint-plugin/src/rules/no-explicit-any.ts b/packages/eslint-plugin/src/rules/no-explicit-any.ts
@@ -16,10 +16,9 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the `any` type',
       recommended: 'warn',
-      suggestion: true,
     },
     fixable: 'code',
-    hasSuggestions: true,
+    hasSuggestions: true, // eslint-disable-line eslint-plugin/require-meta-has-suggestions -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/281
     messages: {
       unexpectedAny: 'Unexpected any. Specify a different type.',
       suggestUnknown:

diff --git a/packages/eslint-plugin/src/rules/no-floating-promises.ts b/packages/eslint-plugin/src/rules/no-floating-promises.ts
@@ -20,7 +20,6 @@ export default util.createRule<Options, MessageId>({
       description:
         'Require Promise-like statements to be handled appropriately',
       recommended: 'error',
-      suggestion: true,
       requiresTypeChecking: true,
     },
     hasSuggestions: true,

diff --git a/packages/eslint-plugin/src/rules/no-implicit-any-catch.ts b/packages/eslint-plugin/src/rules/no-implicit-any-catch.ts
@@ -19,7 +19,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description: 'Disallow usage of the implicit `any` type in catch clauses',
       recommended: false,
-      suggestion: true,
     },
     fixable: 'code',
     hasSuggestions: true,

diff --git a/packages/eslint-plugin/src/rules/no-meaningless-void-operator.ts b/packages/eslint-plugin/src/rules/no-meaningless-void-operator.ts
@@ -20,7 +20,6 @@ export default util.createRule<
       description:
         'Disallow the `void` operator except when used to discard a value',
       recommended: 'strict',
-      suggestion: true,
       requiresTypeChecking: true,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/no-non-null-asserted-optional-chain.ts b/packages/eslint-plugin/src/rules/no-non-null-asserted-optional-chain.ts
@@ -19,7 +19,6 @@ export default util.createRule({
       description:
         'Disallow non-null assertions after an optional chain expression',
       recommended: 'error',
-      suggestion: true,
     },
     hasSuggestions: true,
     messages: {

diff --git a/packages/eslint-plugin/src/rules/no-non-null-assertion.ts b/packages/eslint-plugin/src/rules/no-non-null-assertion.ts
@@ -11,7 +11,6 @@ export default util.createRule<[], MessageIds>({
       description:
         'Disallow non-null assertions using the `!` postfix operator',
       recommended: 'warn',
-      suggestion: true,
     },
     hasSuggestions: true,
     messages: {

diff --git a/packages/eslint-plugin/src/rules/no-unnecessary-type-constraint.ts b/packages/eslint-plugin/src/rules/no-unnecessary-type-constraint.ts
@@ -31,7 +31,6 @@ export default util.createRule({
     docs: {
       description: 'Disallow unnecessary constraints on generic types',
       recommended: 'error',
-      suggestion: true,
     },
     hasSuggestions: true,
     messages: {
@@ -89,6 +88,9 @@ export default util.createRule({
           suggest: [
             {
               messageId: 'removeUnnecessaryConstraint',
+              data: {
+                constraint,
+              },
               fix(fixer): TSESLint.RuleFix | null {
                 return fixer.replaceTextRange(
                   [node.name.range[1], node.constraint.range[1]],

diff --git a/packages/eslint-plugin/src/rules/no-unsafe-argument.ts b/packages/eslint-plugin/src/rules/no-unsafe-argument.ts
@@ -142,7 +142,7 @@ export default util.createRule<[], MessageIds>({
       unsafeArgument:
         'Unsafe argument of type `{{sender}}` assigned to a parameter of type `{{receiver}}`.',
       unsafeTupleSpread:
-        'Unsafe spread of a tuple type. The {{index}} element is of type `{{sender}}` and is assigned to a parameter of type `{{reciever}}`.',
+        'Unsafe spread of a tuple type. The argument is of type `{{sender}}` and is assigned to a parameter of type `{{receiver}}`.',
       unsafeArraySpread: 'Unsafe spread of an `any` array type.',
       unsafeSpread: 'Unsafe spread of an `any` type.',
     },

diff --git a/packages/eslint-plugin/src/rules/no-unsafe-call.ts b/packages/eslint-plugin/src/rules/no-unsafe-call.ts
@@ -1,3 +1,7 @@
+/* eslint-disable eslint-comments/no-use */
+/* eslint eslint-plugin/no-unused-message-ids:"off" -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/282 */
+/* eslint-enable eslint-comments/no-use */
+
 import { TSESTree } from '@typescript-eslint/utils';
 import * as tsutils from 'tsutils';
 import * as util from '../util';

diff --git a/packages/eslint-plugin/src/rules/no-useless-empty-export.ts b/packages/eslint-plugin/src/rules/no-useless-empty-export.ts
@@ -28,10 +28,9 @@ export default util.createRule({
       description:
         "Disallow empty exports that don't change anything in a module file",
       recommended: false,
-      suggestion: true,
     },
     fixable: 'code',
-    hasSuggestions: true,
+    hasSuggestions: false,
     messages: {
       uselessExport: 'Empty export does nothing and can be removed.',
     },

diff --git a/packages/eslint-plugin/src/rules/non-nullable-type-assertion-style.ts b/packages/eslint-plugin/src/rules/non-nullable-type-assertion-style.ts
@@ -11,7 +11,6 @@ export default util.createRule({
       description: 'Enforce non-null assertions over explicit type casts',
       recommended: 'strict',
       requiresTypeChecking: true,
-      suggestion: true,
     },
     fixable: 'code',
     messages: {

diff --git a/packages/eslint-plugin/src/rules/object-curly-spacing.ts b/packages/eslint-plugin/src/rules/object-curly-spacing.ts
@@ -20,6 +20,7 @@ export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 
 export default createRule<Options, MessageIds>({
   name: 'object-curly-spacing',
+  // eslint-disable-next-line eslint-plugin/prefer-message-ids,eslint-plugin/require-meta-type,eslint-plugin/require-meta-schema,eslint-plugin/require-meta-fixable -- all in base rule - https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/274
   meta: {
     ...baseRule.meta,
     docs: {

diff --git a/packages/eslint-plugin/src/rules/padding-line-between-statements.ts b/packages/eslint-plugin/src/rules/padding-line-between-statements.ts
@@ -592,7 +592,7 @@ export default util.createRule<Options, MessageIds>({
       extendsBaseRule: true,
     },
     fixable: 'whitespace',
-    hasSuggestions: true,
+    hasSuggestions: false,
     schema: {
       definitions: {
         paddingType: {

diff --git a/packages/eslint-plugin/src/rules/prefer-as-const.ts b/packages/eslint-plugin/src/rules/prefer-as-const.ts
@@ -8,7 +8,6 @@ export default util.createRule({
     docs: {
       description: 'Enforce the use of `as const` over literal type',
       recommended: 'error',
-      suggestion: true,
     },
     fixable: 'code',
     hasSuggestions: true,

diff --git a/packages/eslint-plugin/src/rules/prefer-enum-initializers.ts b/packages/eslint-plugin/src/rules/prefer-enum-initializers.ts
@@ -11,7 +11,6 @@ export default util.createRule<[], MessageIds>({
       description:
         'Require each enum member value to be explicitly initialized',
       recommended: false,
-      suggestion: true,
     },
     hasSuggestions: true,
     messages: {

diff --git a/packages/eslint-plugin/src/rules/prefer-nullish-coalescing.ts b/packages/eslint-plugin/src/rules/prefer-nullish-coalescing.ts
@@ -28,7 +28,6 @@ export default util.createRule<Options, MessageIds>({
       description:
         'Enforce using the nullish coalescing operator instead of logical chaining',
       recommended: 'strict',
-      suggestion: true,
       requiresTypeChecking: true,
     },
     hasSuggestions: true,

diff --git a/packages/eslint-plugin/src/rules/prefer-optional-chain.ts b/packages/eslint-plugin/src/rules/prefer-optional-chain.ts
@@ -36,7 +36,6 @@ export default util.createRule({
       description:
         'Enforce using concise optional chain expressions instead of chained logical ands',
       recommended: 'strict',
-      suggestion: true,
     },
     hasSuggestions: true,
     messages: {

diff --git a/packages/eslint-plugin/src/rules/return-await.ts b/packages/eslint-plugin/src/rules/return-await.ts
@@ -25,7 +25,7 @@ export default util.createRule({
       extendsBaseRule: 'no-return-await',
     },
     fixable: 'code',
-    hasSuggestions: true,
+    hasSuggestions: true, // eslint-disable-line eslint-plugin/require-meta-has-suggestions -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/272
     type: 'problem',
     messages: {
       nonPromiseAwait:

diff --git a/packages/eslint-plugin/src/rules/sort-type-union-intersection-members.ts b/packages/eslint-plugin/src/rules/sort-type-union-intersection-members.ts
@@ -110,7 +110,7 @@ export default util.createRule<Options, MessageIds>({
       recommended: false,
     },
     fixable: 'code',
-    hasSuggestions: true,
+    hasSuggestions: true, // eslint-disable-line eslint-plugin/require-meta-has-suggestions -- https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/issues/272
     messages: {
       notSorted: '{{type}} type members must be sorted.',
       notSortedNamed: '{{type}} type {{name}} members must be sorted.',

diff --git a/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts b/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
@@ -18,7 +18,6 @@ export default createRule({
       description:
         'Require switch-case statements to be exhaustive with union type',
       recommended: false,
-      suggestion: true,
       requiresTypeChecking: true,
     },
     hasSuggestions: true,

diff --git a/packages/eslint-plugin/tests/rules/consistent-indexed-object-style.test.ts b/packages/eslint-plugin/tests/rules/consistent-indexed-object-style.test.ts
@@ -194,11 +194,7 @@ interface B extends A {
   [index: number]: unknown;
 }
       `,
-      output: `
-interface B extends A {
-  [index: number]: unknown;
-}
-      `,
+      output: null,
       errors: [{ messageId: 'preferRecord', line: 2, column: 1 }],
     },
     // Readonly interface with generic parameter