Enable ban-ts-comment (#14908)

* lint: enable ban-ts-comment * Add descriptions for every @ts-expect-error comments
babel · Sep 2, 2022 · 05deb60 · 05deb60
1 parent 14ea25f
commit 05deb60
Show file tree

Hide file tree

Showing 44 changed files with 121 additions and 149 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -43,7 +43,12 @@ module.exports = {
         "@typescript-eslint/no-dupe-class-members": "error",
         "no-undef": "off",
         "no-redeclare": "off",
-        "@babel/development-internal/disallow-ts-ignore": "error",
+        "@typescript-eslint/ban-ts-comment": [
+          "error",
+          {
+            "ts-ignore": { descriptionFormat: "^\\(Babel 7 vs Babel 8\\) .+$" },
+          },
+        ],
         "@typescript-eslint/consistent-type-imports": [
           "error",
           { disallowTypeAnnotations: false },

diff --git a/eslint/babel-eslint-plugin-development-internal/src/index.cjs b/eslint/babel-eslint-plugin-development-internal/src/index.cjs
@@ -1,7 +1,6 @@
 const rules = {
   "report-error-message-format": require("./rules/report-error-message-format.cjs"),
   "require-default-import-fallback": require("./rules/require-default-import-fallback.cjs"),
-  "disallow-ts-ignore": require("./rules/disallow-ts-ignore.cjs"),
 };
 
 exports.rules = rules;

diff --git a/eslint/babel-eslint-plugin-development-internal/src/rules/disallow-ts-ignore.cjs b/eslint/babel-eslint-plugin-development-internal/src/rules/disallow-ts-ignore.cjs
diff --git a/packages/babel-core/src/config/files/plugins.ts b/packages/babel-core/src/config/files/plugins.ts
@@ -100,7 +100,7 @@ function* resolveAlternativesHelper(
   const { error, value } = yield standardizedName;
   if (!error) return value;
 
-  // @ts-expect-error
+  // @ts-expect-error code may not index error
   if (error.code !== "MODULE_NOT_FOUND") throw error;
 
   if (standardizedName !== name && !(yield name).error) {

diff --git a/packages/babel-core/src/config/util.ts b/packages/babel-core/src/config/util.ts
@@ -13,9 +13,9 @@ export function mergeOptions(
       const targetObj = target[k] || (target[k] = {});
       mergeDefaultFields(targetObj, parserOpts);
     } else {
-      //@ts-expect-error
+      //@ts-expect-error k must index source
       const val = source[k];
-      //@ts-expect-error
+      //@ts-expect-error assigning source to target
       if (val !== undefined) target[k] = val as any;
     }
   }

diff --git a/packages/babel-core/src/config/validation/options.ts b/packages/babel-core/src/config/validation/options.ts
@@ -456,8 +456,7 @@ function assertOverridesList(
       validateNested(overridesLoc, env);
     }
   }
-  // @ts-expect-error
-  return arr;
+  return arr as OverridesList;
 }
 
 export function checkNoUnwrappedItemOptionPairs(

diff --git a/packages/babel-core/src/errors/rewrite-stack-trace.ts b/packages/babel-core/src/errors/rewrite-stack-trace.ts
@@ -125,8 +125,7 @@ export function endHiddenCallStack<A extends unknown[], R>(
 }
 
 function setupPrepareStackTrace() {
-  // This function is a singleton
-  // @ts-expect-error
+  // @ts-expect-error This function is a singleton
   // eslint-disable-next-line no-func-assign
   setupPrepareStackTrace = () => {};
 

diff --git a/packages/babel-core/src/transformation/file/file.ts b/packages/babel-core/src/transformation/file/file.ts
@@ -210,7 +210,7 @@ export default class File {
     });
 
     nodes.forEach(node => {
-      // @ts-expect-error
+      // @ts-expect-error Fixeme: document _compact node property
       node._compact = true;
     });
 

diff --git a/packages/babel-generator/src/generators/modules.ts b/packages/babel-generator/src/generators/modules.ts
@@ -224,12 +224,12 @@ export function ImportDeclaration(this: Printer, node: t.ImportDeclaration) {
 
   this.printAssertions(node);
   if (!process.env.BABEL_8_BREAKING) {
-    // @ts-expect-error
+    // @ts-ignore(Babel 7 vs Babel 8) Babel 7 supports module attributes
     if (node.attributes?.length) {
       this.space();
       this.word("with");
       this.space();
-      // @ts-expect-error
+      // @ts-ignore(Babel 7 vs Babel 8) Babel 7 supports module attributes
       this.printList(node.attributes, node);
     }
   }

diff --git a/packages/babel-generator/src/printer.ts b/packages/babel-generator/src/printer.ts
@@ -862,7 +862,7 @@ class Printer {
 Object.assign(Printer.prototype, generatorFunctions);
 
 if (!process.env.BABEL_8_BREAKING) {
-  // @ts-ignore(Babel 7 vs Babel 8)
+  // @ts-ignore(Babel 7 vs Babel 8) Babel 7 has Noop print method
   Printer.prototype.Noop = function Noop(this: Printer) {};
 }
 

diff --git a/packages/babel-helper-builder-react-jsx/src/index.ts b/packages/babel-helper-builder-react-jsx/src/index.ts
@@ -96,8 +96,9 @@ You can set \`throwIfNamespace: false\` to bypass this warning.`,
       if (node.name === "this" && isReferenced(node, parent)) {
         return thisExpression();
       } else if (isValidIdentifier(node.name, false)) {
-        // @ts-expect-error todo(flow->ts) avoid type unsafe mutations
+        // @ts-expect-error casting JSXIdentifier to Identifier
         node.type = "Identifier";
+        return node as unknown as t.Identifier;
       } else {
         return stringLiteral(node.name);
       }
@@ -114,7 +115,6 @@ You can set \`throwIfNamespace: false\` to bypass this warning.`,
       return stringLiteral(`${node.namespace.name}:${node.name.name}`);
     }
 
-    // @ts-expect-error
     return node;
   }
 

diff --git a/packages/babel-helper-compilation-targets/src/index.ts b/packages/babel-helper-compilation-targets/src/index.ts
@@ -21,7 +21,7 @@ import type {
   TargetsTuple,
 } from "./types";
 
-export type { Targets, InputTargets };
+export type { Target, Targets, InputTargets };
 
 export { prettifyTargets } from "./pretty";
 export { getInclusionReasons } from "./debug";

diff --git a/packages/babel-helper-create-class-features-plugin/src/features.ts b/packages/babel-helper-create-class-features-plugin/src/features.ts
@@ -49,14 +49,14 @@ export function enableFeature(file: File, feature: number, loose: boolean) {
   if (!hasFeature(file, feature) || canIgnoreLoose(file, feature)) {
     file.set(featuresKey, file.get(featuresKey) | feature);
     if (
-      // @ts-expect-error
+      // @ts-expect-error comparing loose with internal private magic string
       loose ===
       "#__internal__@babel/preset-env__prefer-true-but-false-is-ok-if-it-prevents-an-error"
     ) {
       setLoose(file, feature, true);
       file.set(looseLowPriorityKey, file.get(looseLowPriorityKey) | feature);
     } else if (
-      // @ts-expect-error
+      // @ts-expect-error comparing loose with internal private magic string
       loose ===
       "#__internal__@babel/preset-env__prefer-false-but-true-is-ok-if-it-prevents-an-error"
     ) {

diff --git a/packages/babel-helper-create-class-features-plugin/src/index.ts b/packages/babel-helper-create-class-features-plugin/src/index.ts
@@ -295,9 +295,8 @@ export function createClassFeaturePlugin({
               // class Foo {} export { Foo as default }
               splitExportDeclaration(path);
             } else {
-              // Annyms class declarations can be
+              // @ts-expect-error Anonymous class declarations can be
               // transformed as if they were expressions
-              // @ts-expect-error
               decl.node.type = "ClassExpression";
             }
           }

diff --git a/packages/babel-helper-module-transforms/src/normalize-and-load-metadata.ts b/packages/babel-helper-module-transforms/src/normalize-and-load-metadata.ts
@@ -434,13 +434,12 @@ function getLocalExportMetadata(
 ): Map<string, LocalExportMetadata> {
   const bindingKindLookup = new Map();
 
-  programPath.get("body").forEach(child => {
+  programPath.get("body").forEach((child: NodePath) => {
     let kind: ModuleBindingKind;
     if (child.isImportDeclaration()) {
       kind = "import";
     } else {
       if (child.isExportDefaultDeclaration()) {
-        // @ts-expect-error
         child = child.get("declaration");
       }
       if (child.isExportNamedDeclaration()) {

diff --git a/packages/babel-helper-plugin-utils/src/index.ts b/packages/babel-helper-plugin-utils/src/index.ts
@@ -31,7 +31,7 @@ export function declare<State = {}, Option = {}>(
       clonedApi[name] = apiPolyfills[name](clonedApi);
     }
 
-    // @ts-expect-error
+    // @ts-expect-error options || {} may not be assigned to Options
     return builder(clonedApi ?? api, options || {}, dirname);
   };
 }

diff --git a/packages/babel-parser/src/parser/expression.ts b/packages/babel-parser/src/parser/expression.ts
@@ -129,7 +129,7 @@ export default abstract class ExpressionParser extends LValParser {
       prop.type === "SpreadElement" ||
       this.isObjectMethod(prop) ||
       prop.computed ||
-      // @ts-expect-error
+      // @ts-expect-error prop must be an ObjectProperty
       prop.shorthand
     ) {
       return;
@@ -2123,7 +2123,7 @@ export default abstract class ExpressionParser extends LValParser {
         this.raise(Errors.InvalidRecordProperty, { at: prop });
       }
 
-      // @ts-expect-error
+      // @ts-expect-error shorthand may not index prop
       if (prop.shorthand) {
         this.addExtra(prop, "shorthand", true);
       }
@@ -2644,9 +2644,9 @@ export default abstract class ExpressionParser extends LValParser {
             // This logic is here to align the error location with the ESTree plugin.
             this.raise(Errors.IllegalLanguageModeDirective, {
               at:
-                // @ts-expect-error
+                // @ts-expect-error kind may not index node
                 (node.kind === "method" || node.kind === "constructor") &&
-                // @ts-expect-error
+                // @ts-expect-error key may not index node
                 !!node.key
                   ? // @ts-expect-error node.key has been gaurded
                     node.key.loc.end

diff --git a/packages/babel-parser/src/parser/lval.ts b/packages/babel-parser/src/parser/lval.ts
@@ -664,9 +664,7 @@ export default abstract class LValParser extends NodeUtils {
         ? expression
         : ancestor;
 
-    // Flow has difficulty tracking `key` and `expression`, but only if we use
-    // null-proto objects. If we use normal objects, everything works fine.
-    // @ts-expect-error
+    // @ts-expect-error key may not index expression.
     for (const child of [].concat(expression[key])) {
       if (child) {
         this.checkLVal(child, {

diff --git a/packages/babel-parser/src/parser/node.ts b/packages/babel-parser/src/parser/node.ts
@@ -29,11 +29,10 @@ class Node implements NodeBase {
 const NodePrototype = Node.prototype;
 
 if (!process.env.BABEL_8_BREAKING) {
-  // @ts-expect-error
+  // @ts-expect-error __clone is not defined in Node prototype
   NodePrototype.__clone = function (): Node {
-    // @ts-expect-error
-    const newNode: any = new Node();
-    const keys = Object.keys(this);
+    const newNode = new Node(undefined, this.start, this.loc.start);
+    const keys = Object.keys(this) as (keyof Node)[];
     for (let i = 0, length = keys.length; i < length; i++) {
       const key = keys[i];
       // Do not clone comments that are already attached to the node
@@ -42,9 +41,8 @@ if (!process.env.BABEL_8_BREAKING) {
         key !== "trailingComments" &&
         key !== "innerComments"
       ) {
-        newNode[key] =
-          // @ts-expect-error: key must present in this
-          this[key];
+        // @ts-expect-error cloning this to newNode
+        newNode[key] = this[key];
       }
     }
 
@@ -100,12 +98,12 @@ export type Undone<T extends NodeType> = Omit<T, "type">;
 
 export abstract class NodeUtils extends UtilParser {
   startNode<T extends NodeType>(): Undone<T> {
-    // @ts-expect-error
+    // @ts-expect-error cast Node as Undone<T>
     return new Node(this, this.state.start, this.state.startLoc);
   }
 
   startNodeAt<T extends NodeType>(pos: number, loc: Position): Undone<T> {
-    // @ts-expect-error
+    // @ts-expect-error cast Node as Undone<T>
     return new Node(this, pos, loc);
   }
 

diff --git a/packages/babel-parser/src/parser/statement.ts b/packages/babel-parser/src/parser/statement.ts
@@ -2591,10 +2591,9 @@ export default abstract class StatementParser extends ExpressionParser {
   ) {
     // @ts-expect-error Fixme: node.type must be undefined because they are undone
     if (this.isJSONModuleImport(node) && node.type !== "ExportAllDeclaration") {
-      // @ts-expect-error
+      // @ts-expect-error specifiers may not index node
       const { specifiers } = node;
-      // @ts-expect-error
-      if (node.specifiers != null) {
+      if (specifiers != null) {
         // @ts-expect-error refine specifier types
         const nonDefaultNamedSpecifier = specifiers.find(specifier => {
           let imported;

diff --git a/packages/babel-parser/src/plugin-utils.ts b/packages/babel-parser/src/plugin-utils.ts
@@ -207,8 +207,8 @@ export function validatePlugins(plugins: PluginList) {
     const error = new Error(
       "'asyncDoExpressions' requires 'doExpressions', please add 'doExpressions' to parser plugins.",
     );
-    // @ts-expect-error
-    error.missingPlugins = "doExpressions"; // so @babel/core can provide better error message
+    // @ts-expect-error so @babel/core can provide better error message
+    error.missingPlugins = "doExpressions";
     throw error;
   }
 }

diff --git a/packages/babel-parser/src/plugins/estree.ts b/packages/babel-parser/src/plugins/estree.ts
@@ -202,7 +202,7 @@ export default (superClass: typeof Parser) =>
         true,
       );
       if (method.typeParameters) {
-        // @ts-expect-error
+        // @ts-expect-error mutate AST types
         method.value.typeParameters = method.typeParameters;
         delete method.typeParameters;
       }
@@ -296,7 +296,7 @@ export default (superClass: typeof Parser) =>
       // @ts-expect-error mutate AST types
       funcNode.type = "FunctionExpression";
       delete funcNode.kind;
-      // @ts-expect-error
+      // @ts-expect-error mutate AST types
       node.value = funcNode;
       if (type === "ClassPrivateMethod") {
         node.computed = false;

diff --git a/packages/babel-parser/src/plugins/flow/index.ts b/packages/babel-parser/src/plugins/flow/index.ts
@@ -2886,7 +2886,7 @@ export default (superClass: typeof Parser) =>
       node: Undone<N.Function>,
       allowModifiers?: boolean,
     ): void {
-      // @ts-expect-error
+      // @ts-expect-error kind may not index node
       const kind = node.kind;
       if (kind !== "get" && kind !== "set" && this.match(tt.lt)) {
         node.typeParameters = this.flowParseTypeParameterDeclaration();

diff --git a/packages/babel-parser/src/plugins/placeholders.ts b/packages/babel-parser/src/plugins/placeholders.ts
@@ -197,7 +197,7 @@ export default (superClass: typeof Parser) =>
       }
 
       if (this.match(tt.colon)) {
-        // @ts-expect-error
+        // @ts-expect-error placeholder typings
         const stmt: N.LabeledStatement = node;
         stmt.label = this.finishPlaceholder(expr, "Identifier");
         this.next();