feat: remove TSParenthesizedType (#3340)

fixes #3136 Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
typescript-eslint · Oct 11, 2021 · c8ee432 · c8ee432
1 parent 3034181
commit c8ee432
Show file tree

Hide file tree

Showing 24 changed files with 169 additions and 299 deletions.
diff --git a/packages/ast-spec/src/ast-node-types.ts b/packages/ast-spec/src/ast-node-types.ts
@@ -135,7 +135,6 @@ export enum AST_NODE_TYPES {
   TSObjectKeyword = 'TSObjectKeyword',
   TSOptionalType = 'TSOptionalType',
   TSParameterProperty = 'TSParameterProperty',
-  TSParenthesizedType = 'TSParenthesizedType',
   TSPrivateKeyword = 'TSPrivateKeyword',
   TSPropertySignature = 'TSPropertySignature',
   TSProtectedKeyword = 'TSProtectedKeyword',

diff --git a/packages/ast-spec/src/type/TSParenthesizedType/spec.ts b/packages/ast-spec/src/type/TSParenthesizedType/spec.ts
diff --git a/packages/ast-spec/src/type/spec.ts b/packages/ast-spec/src/type/spec.ts
@@ -17,7 +17,6 @@ export * from './TSNullKeyword/spec';
 export * from './TSNumberKeyword/spec';
 export * from './TSObjectKeyword/spec';
 export * from './TSOptionalType/spec';
-export * from './TSParenthesizedType/spec';
 export * from './TSQualifiedName/spec';
 export * from './TSRestType/spec';
 export * from './TSStringKeyword/spec';

diff --git a/packages/ast-spec/src/unions/Node.ts b/packages/ast-spec/src/unions/Node.ts
@@ -142,7 +142,6 @@ import type { TSNullKeyword } from '../type/TSNullKeyword/spec';
 import type { TSNumberKeyword } from '../type/TSNumberKeyword/spec';
 import type { TSObjectKeyword } from '../type/TSObjectKeyword/spec';
 import type { TSOptionalType } from '../type/TSOptionalType/spec';
-import type { TSParenthesizedType } from '../type/TSParenthesizedType/spec';
 import type { TSQualifiedName } from '../type/TSQualifiedName/spec';
 import type { TSRestType } from '../type/TSRestType/spec';
 import type { TSStringKeyword } from '../type/TSStringKeyword/spec';
@@ -293,7 +292,6 @@ export type Node =
   | TSObjectKeyword
   | TSOptionalType
   | TSParameterProperty
-  | TSParenthesizedType
   | TSPrivateKeyword
   | TSPropertySignature
   | TSProtectedKeyword

diff --git a/packages/ast-spec/src/unions/TypeNode.ts b/packages/ast-spec/src/unions/TypeNode.ts
@@ -18,7 +18,6 @@ import type { TSNullKeyword } from '../type/TSNullKeyword/spec';
 import type { TSNumberKeyword } from '../type/TSNumberKeyword/spec';
 import type { TSObjectKeyword } from '../type/TSObjectKeyword/spec';
 import type { TSOptionalType } from '../type/TSOptionalType/spec';
-import type { TSParenthesizedType } from '../type/TSParenthesizedType/spec';
 import type { TSRestType } from '../type/TSRestType/spec';
 import type { TSStringKeyword } from '../type/TSStringKeyword/spec';
 import type { TSSymbolKeyword } from '../type/TSSymbolKeyword/spec';
@@ -56,7 +55,6 @@ export type TypeNode =
   | TSNumberKeyword
   | TSObjectKeyword
   | TSOptionalType
-  | TSParenthesizedType
   | TSRestType
   | TSStringKeyword
   | TSSymbolKeyword

diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -132,13 +132,8 @@ export default util.createRule<Options, MessageIds>({
      * @param node the node to be evaluated.
      */
     function getMessageType(node: TSESTree.Node): string {
-      if (node) {
-        if (node.type === AST_NODE_TYPES.TSParenthesizedType) {
-          return getMessageType(node.typeAnnotation);
-        }
-        if (isSimpleType(node)) {
-          return sourceCode.getText(node);
-        }
+      if (node && isSimpleType(node)) {
+        return sourceCode.getText(node);
       }
       return 'T';
     }
@@ -172,11 +167,7 @@ export default util.createRule<Options, MessageIds>({
             type: getMessageType(node.elementType),
           },
           fix(fixer) {
-            const typeNode =
-              node.elementType.type === AST_NODE_TYPES.TSParenthesizedType
-                ? node.elementType.typeAnnotation
-                : node.elementType;
-
+            const typeNode = node.elementType;
             const arrayType = isReadonly ? 'ReadonlyArray' : 'Array';
 
             return [
@@ -244,9 +235,12 @@ export default util.createRule<Options, MessageIds>({
         }
 
         const type = typeParams[0];
-        const typeParens = typeNeedsParentheses(type);
+        const typeParens =
+          !util.isParenthesized(type, sourceCode) && typeNeedsParentheses(type);
         const parentParens =
-          readonlyPrefix && node.parent?.type === AST_NODE_TYPES.TSArrayType;
+          readonlyPrefix &&
+          node.parent?.type === AST_NODE_TYPES.TSArrayType &&
+          !util.isParenthesized(node.parent.elementType, sourceCode);
 
         const start = `${parentParens ? '(' : ''}${readonlyPrefix}${
           typeParens ? '(' : ''

diff --git a/packages/eslint-plugin/src/rules/indent-new-do-not-use/index.ts b/packages/eslint-plugin/src/rules/indent-new-do-not-use/index.ts
@@ -161,7 +161,6 @@ const KNOWN_NODES = new Set([
   AST_NODE_TYPES.TSModuleDeclaration,
   AST_NODE_TYPES.TSNonNullExpression,
   AST_NODE_TYPES.TSParameterProperty,
-  AST_NODE_TYPES.TSParenthesizedType,
   'TSPlusToken',
   AST_NODE_TYPES.TSPropertySignature,
   AST_NODE_TYPES.TSQualifiedName,

diff --git a/packages/eslint-plugin/src/rules/indent.ts b/packages/eslint-plugin/src/rules/indent.ts
@@ -67,7 +67,6 @@ const KNOWN_NODES = new Set([
   AST_NODE_TYPES.TSModuleDeclaration,
   AST_NODE_TYPES.TSNonNullExpression,
   AST_NODE_TYPES.TSParameterProperty,
-  AST_NODE_TYPES.TSParenthesizedType,
   'TSPlusToken',
   AST_NODE_TYPES.TSPropertySignature,
   AST_NODE_TYPES.TSQualifiedName,

diff --git a/packages/eslint-plugin/src/rules/no-extra-parens.ts b/packages/eslint-plugin/src/rules/no-extra-parens.ts
@@ -84,9 +84,7 @@ export default util.createRule<Options, MessageIds>({
       if (
         node.arguments.length === 1 &&
         node.typeParameters?.params.some(
-          param =>
-            param.type === AST_NODE_TYPES.TSParenthesizedType ||
-            param.type === AST_NODE_TYPES.TSImportType,
+          param => param.type === AST_NODE_TYPES.TSImportType,
         )
       ) {
         return rule({

diff --git a/packages/eslint-plugin/src/rules/no-type-alias.ts b/packages/eslint-plugin/src/rules/no-type-alias.ts
@@ -311,9 +311,6 @@ export default util.createRule<Options, MessageIds>({
           return acc;
         }, []);
       }
-      if (node.type === AST_NODE_TYPES.TSParenthesizedType) {
-        return getTypes(node.typeAnnotation, compositionType);
-      }
       return [{ node, compositionType }];
     }
 

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
@@ -23,9 +23,6 @@ enum Group {
 
 function getGroup(node: TSESTree.TypeNode): Group {
   switch (node.type) {
-    case AST_NODE_TYPES.TSParenthesizedType:
-      return getGroup(node.typeAnnotation);
-
     case AST_NODE_TYPES.TSConditionalType:
       return Group.conditional;
 
@@ -91,6 +88,10 @@ function getGroup(node: TSESTree.TypeNode): Group {
   }
 }
 
+function requiresParentheses(node: TSESTree.TypeNode): boolean {
+  return node.type === AST_NODE_TYPES.TSFunctionType;
+}
+
 export type Options = [
   {
     checkIntersections?: boolean;
@@ -212,7 +213,7 @@ export default util.createRule<Options, MessageIds>({
 
           const fix: TSESLint.ReportFixFunction = fixer => {
             const sorted = expectedOrder
-              .map(t => t.text)
+              .map(t => (requiresParentheses(t.node) ? `(${t.text})` : t.text))
               .join(
                 node.type === AST_NODE_TYPES.TSIntersectionType ? ' & ' : ' | ',
               );

diff --git a/packages/eslint-plugin/tests/rules/indent/indent.test.ts b/packages/eslint-plugin/tests/rules/indent/indent.test.ts
@@ -451,29 +451,6 @@ class Foo {
             `,
     ],
   },
-  {
-    node: AST_NODE_TYPES.TSParenthesizedType,
-    code: [
-      `
-const x: Array<(
-    | {
-        __typename: "Foo",
-    }
-    | {
-        __typename: "Baz",
-    }
-    | (
-        | {
-            __typename: "Baz",
-        }
-        | {
-            __typename: "Buzz",
-        }
-    )
-)>;
-            `,
-    ],
-  },
   // TSPlusToken - tested in TSMappedType
   {
     node: AST_NODE_TYPES.TSPropertySignature,

diff --git a/packages/eslint-plugin/tests/rules/no-extra-parens.test.ts b/packages/eslint-plugin/tests/rules/no-extra-parens.test.ts
@@ -28,7 +28,7 @@ for (a in b, c);
 for (a in b);
 a<import('')>(1);
 new a<import('')>(1);
-a<(A)>(1);
+a<A>(1);
       `,
     }),
     ...batchedSingleLineTests({

diff --git a/packages/eslint-plugin/tests/rules/sort-type-union-intersection-members.test.ts b/packages/eslint-plugin/tests/rules/sort-type-union-intersection-members.test.ts
@@ -127,7 +127,7 @@ const invalid = (
     },
     {
       code: noFormat`type T = (B) ${operator} (A);`,
-      output: noFormat`type T = (A) ${operator} (B);`,
+      output: noFormat`type T = A ${operator} B;`,
       errors: [
         {
           messageId: 'notSortedNamed',

diff --git a/packages/experimental-utils/src/ts-eslint/Rule.ts b/packages/experimental-utils/src/ts-eslint/Rule.ts
@@ -399,7 +399,6 @@ interface RuleListener {
   TSObjectKeyword?: RuleFunction<TSESTree.TSObjectKeyword>;
   TSOptionalType?: RuleFunction<TSESTree.TSOptionalType>;
   TSParameterProperty?: RuleFunction<TSESTree.TSParameterProperty>;
-  TSParenthesizedType?: RuleFunction<TSESTree.TSParenthesizedType>;
   TSPrivateKeyword?: RuleFunction<TSESTree.TSPrivateKeyword>;
   TSPropertySignature?: RuleFunction<TSESTree.TSPropertySignature>;
   TSProtectedKeyword?: RuleFunction<TSESTree.TSProtectedKeyword>;

diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -2698,10 +2698,7 @@ export class Converter {
 
       // TypeScript specific types
       case SyntaxKind.ParenthesizedType: {
-        return this.createNode<TSESTree.TSParenthesizedType>(node, {
-          type: AST_NODE_TYPES.TSParenthesizedType,
-          typeAnnotation: this.convertType(node.type),
-        });
+        return this.convertType(node.type);
       }
       case SyntaxKind.UnionType: {
         return this.createNode<TSESTree.TSUnionType>(node, {

diff --git a/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts b/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts
@@ -192,7 +192,6 @@ export interface EstreeToTsNodeTypes {
   [AST_NODE_TYPES.TSNonNullExpression]: ts.NonNullExpression;
   [AST_NODE_TYPES.TSOptionalType]: ts.OptionalTypeNode;
   [AST_NODE_TYPES.TSParameterProperty]: ts.ParameterDeclaration;
-  [AST_NODE_TYPES.TSParenthesizedType]: ts.ParenthesizedTypeNode;
   [AST_NODE_TYPES.TSPropertySignature]: ts.PropertySignature;
   [AST_NODE_TYPES.TSQualifiedName]: ts.QualifiedName;
   [AST_NODE_TYPES.TSRestType]:

diff --git a/packages/typescript-estree/tests/ast-alignment/utils.ts b/packages/typescript-estree/tests/ast-alignment/utils.ts
@@ -250,6 +250,16 @@ export function preprocessBabylonAST(ast: BabelTypes.File): any {
           }
         }
       },
+      /**
+       * Remove TSParenthesizedType from babel AST. Babel 8 will stop generating the TSParenthesizedType.
+       * Once we use babel 8, this can be removed.
+       * @see https://github.com/babel/babel/pull/12608
+       */
+      TSParenthesizedType(node: any) {
+        const { typeAnnotation } = node;
+        Object.keys(node).forEach(key => delete node[key]);
+        Object.assign(node, typeAnnotation);
+      },
     },
   );
 }

diff --git a/...s/typescript-estree/tests/snapshots/typescript/types/conditional-infer-nested.src.ts.shot b/...s/typescript-estree/tests/snapshots/typescript/types/conditional-infer-nested.src.ts.shot
@@ -78,38 +78,33 @@ Object {
           "elementType": Object {
             "loc": Object {
               "end": Object {
-                "column": 21,
+                "column": 20,
                 "line": 2,
               },
               "start": Object {
-                "column": 12,
+                "column": 13,
                 "line": 2,
               },
             },
             "range": Array [
-              31,
-              40,
+              32,
+              39,
             ],
-            "type": "TSParenthesizedType",
-            "typeAnnotation": Object {
+            "type": "TSInferType",
+            "typeParameter": Object {
+              "constraint": undefined,
+              "default": undefined,
               "loc": Object {
                 "end": Object {
                   "column": 20,
                   "line": 2,
                 },
                 "start": Object {
-                  "column": 13,
+                  "column": 19,
                   "line": 2,
                 },
               },
-              "range": Array [
-                32,
-                39,
-              ],
-              "type": "TSInferType",
-              "typeParameter": Object {
-                "constraint": undefined,
-                "default": undefined,
+              "name": Object {
                 "loc": Object {
                   "end": Object {
                     "column": 20,
@@ -120,30 +115,18 @@ Object {
                     "line": 2,
                   },
                 },
-                "name": Object {
-                  "loc": Object {
-                    "end": Object {
-                      "column": 20,
-                      "line": 2,
-                    },
-                    "start": Object {
-                      "column": 19,
-                      "line": 2,
-                    },
-                  },
-                  "name": "U",
-                  "range": Array [
-                    38,
-                    39,
-                  ],
-                  "type": "Identifier",
-                },
+                "name": "U",
                 "range": Array [
                   38,
                   39,
                 ],
-                "type": "TSTypeParameter",
+                "type": "Identifier",
               },
+              "range": Array [
+                38,
+                39,
+              ],
+              "type": "TSTypeParameter",
             },
           },
           "loc": Object {