feat: [4.7] support optional variance annotation (#4831)

typescript-eslint · May 19, 2022 · 7e7b24c · 7e7b24c
1 parent 79fbc77
commit 7e7b24c
Show file tree

Hide file tree

Showing 68 changed files with 2,309 additions and 0 deletions.
diff --git a/...eclaration/fixtures/type-parameters-extends-type-parameters/snapshots/1-TSESTree-AST.shot b/...eclaration/fixtures/type-parameters-extends-type-parameters/snapshots/1-TSESTree-AST.shot
@@ -71,6 +71,7 @@ Program {
         params: Array [
           TSTypeParameter {
             type: "TSTypeParameter",
+            in: false,
             name: Identifier {
               type: "Identifier",
               name: "T",
@@ -81,6 +82,7 @@ Program {
                 end: { column: 11, line: 1 },
               },
             },
+            out: false,
 
             range: [10, 11],
             loc: {

diff --git a/...ation/fixtures/type-parameters-extends-type-parameters/snapshots/5-AST-Alignment-AST.shot b/...ation/fixtures/type-parameters-extends-type-parameters/snapshots/5-AST-Alignment-AST.shot
@@ -75,6 +75,7 @@ exports[`AST Fixtures declaration ClassDeclaration type-parameters-extends-type-
           params: Array [
             TSTypeParameter {
               type: 'TSTypeParameter',
+-             in: false,
 -             name: Identifier {
 -               type: 'Identifier',
 -               name: 'T',
@@ -85,6 +86,7 @@ exports[`AST Fixtures declaration ClassDeclaration type-parameters-extends-type-
 -                 end: { column: 11, line: 1 },
 -               },
 -             },
+-             out: false,
 +             name: 'T',
 
               range: [10, 11],

diff --git a/...c/src/declaration/ClassDeclaration/fixtures/type-parameters/snapshots/1-TSESTree-AST.shot b/...c/src/declaration/ClassDeclaration/fixtures/type-parameters/snapshots/1-TSESTree-AST.shot
@@ -32,6 +32,7 @@ Program {
         params: Array [
           TSTypeParameter {
             type: "TSTypeParameter",
+            in: false,
             name: Identifier {
               type: "Identifier",
               name: "T",
@@ -42,6 +43,7 @@ Program {
                 end: { column: 11, line: 1 },
               },
             },
+            out: false,
 
             range: [10, 11],
             loc: {

diff --git a/.../declaration/ClassDeclaration/fixtures/type-parameters/snapshots/5-AST-Alignment-AST.shot b/.../declaration/ClassDeclaration/fixtures/type-parameters/snapshots/5-AST-Alignment-AST.shot
@@ -36,6 +36,7 @@ exports[`AST Fixtures declaration ClassDeclaration type-parameters AST Alignment
           params: Array [
             TSTypeParameter {
               type: 'TSTypeParameter',
+-             in: false,
 -             name: Identifier {
 -               type: 'Identifier',
 -               name: 'T',
@@ -46,6 +47,7 @@ exports[`AST Fixtures declaration ClassDeclaration type-parameters AST Alignment
 -                 end: { column: 11, line: 1 },
 -               },
 -             },
+-             out: false,
 +             name: 'T',
 
               range: [10, 11],

diff --git a/packages/ast-spec/src/special/TSTypeParameter/spec.ts b/packages/ast-spec/src/special/TSTypeParameter/spec.ts
@@ -8,4 +8,6 @@ export interface TSTypeParameter extends BaseNode {
   name: Identifier;
   constraint?: TypeNode;
   default?: TypeNode;
+  in: boolean;
+  out: boolean;
 }
diff --git a/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in-and-out.src.ts b/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in-and-out.src.ts
@@ -0,0 +1 @@
+type Mapper<in T, out U> = (x: T) => U;
diff --git a/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in-out.src.ts b/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in-out.src.ts
@@ -0,0 +1 @@
+type Processor<in out T> = (x: T) => T;
diff --git a/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in.src.ts b/packages/shared-fixtures/fixtures/typescript/types/optional-variance-in.src.ts
@@ -0,0 +1 @@
+type Consumer<in T> = (x: T) => void;
diff --git a/packages/shared-fixtures/fixtures/typescript/types/optional-variance-out.src.ts b/packages/shared-fixtures/fixtures/typescript/types/optional-variance-out.src.ts
@@ -0,0 +1 @@
+type Provider<out T> = () => T;
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -2342,6 +2342,8 @@ export class Converter {
             ? this.convertType(node.constraint)
             : undefined,
           default: node.default ? this.convertType(node.default) : undefined,
+          in: hasModifier(SyntaxKind.InKeyword, node),
+          out: hasModifier(SyntaxKind.OutKeyword, node),
         });
       }
 

diff --git a/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts b/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts
@@ -496,6 +496,14 @@ tester.addFixturePatternConfig('typescript/types', {
      * Babel doesn't support TS 4.7 new feature yet.
      */
     'conditional-infer-with-constraint',
+    /**
+     * [BABEL ERRORED, BUT TS-ESTREE DID NOT]
+     * Babel doesn't support TS 4.7 new features yet.
+     */
+    'optional-variance-in',
+    'optional-variance-out',
+    'optional-variance-in-out',
+    'optional-variance-in-and-out',
   ],
 });
 

diff --git a/packages/typescript-estree/tests/ast-alignment/utils.ts b/packages/typescript-estree/tests/ast-alignment/utils.ts
@@ -150,6 +150,13 @@ export function preprocessBabylonAST(ast: File): any {
             type: AST_NODE_TYPES.Identifier,
           };
         }
+        // Babel does not support TS 4.7 optional variance yet.
+        if (!node.in) {
+          node.in = false;
+        }
+        if (!node.out) {
+          node.out = false;
+        }
       },
       MethodDefinition(node) {
         /**

diff --git a/packages/typescript-estree/tests/lib/__snapshots__/convert.test.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/convert.test.ts.snap
@@ -475,6 +475,7 @@ Object {
       Object {
         "constraint": undefined,
         "default": undefined,
+        "in": false,
         "loc": Object {
           "end": Object {
             "column": 11,
@@ -503,6 +504,7 @@ Object {
           ],
           "type": "Identifier",
         },
+        "out": false,
         "range": Array [
           10,
           11,

diff --git a/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.test.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.test.ts.snap
@@ -2734,6 +2734,14 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/object-literal-type-with-accessors.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/optional-variance-in.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/optional-variance-in-and-out.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/optional-variance-in-out.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/optional-variance-out.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/parenthesized-type.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/reference.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

diff --git a/.../tests/snapshots/typescript/babylon-convergence/type-parameter-whitespace-loc.src.ts.shot b/.../tests/snapshots/typescript/babylon-convergence/type-parameter-whitespace-loc.src.ts.shot
@@ -74,6 +74,7 @@ Object {
           Object {
             "constraint": undefined,
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 14,
@@ -102,6 +103,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               13,
               14,

diff --git a/...escript-estree/tests/snapshots/typescript/babylon-convergence/type-parameters.src.ts.shot b/...escript-estree/tests/snapshots/typescript/babylon-convergence/type-parameters.src.ts.shot
@@ -106,6 +106,7 @@ Object {
               ],
               "type": "TSObjectKeyword",
             },
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 36,
@@ -134,6 +135,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               11,
               36,

diff --git a/...-estree/tests/snapshots/typescript/basics/arrow-function-with-type-parameters.src.ts.shot b/...-estree/tests/snapshots/typescript/basics/arrow-function-with-type-parameters.src.ts.shot
@@ -219,6 +219,7 @@ Object {
             Object {
               "constraint": undefined,
               "default": undefined,
+              "in": false,
               "loc": Object {
                 "end": Object {
                   "column": 2,
@@ -247,6 +248,7 @@ Object {
                 ],
                 "type": "Identifier",
               },
+              "out": false,
               "range": Array [
                 1,
                 2,

diff --git a/...script-estree/tests/snapshots/typescript/basics/call-signatures-with-generics.src.ts.shot b/...script-estree/tests/snapshots/typescript/basics/call-signatures-with-generics.src.ts.shot
@@ -168,6 +168,7 @@ Object {
                 Object {
                   "constraint": undefined,
                   "default": undefined,
+                  "in": false,
                   "loc": Object {
                     "end": Object {
                       "column": 4,
@@ -196,6 +197,7 @@ Object {
                     ],
                     "type": "Identifier",
                   },
+                  "out": false,
                   "range": Array [
                     16,
                     17,
@@ -329,6 +331,7 @@ Object {
                 Object {
                   "constraint": undefined,
                   "default": undefined,
+                  "in": false,
                   "loc": Object {
                     "end": Object {
                       "column": 7,
@@ -357,6 +360,7 @@ Object {
                     ],
                     "type": "Identifier",
                   },
+                  "out": false,
                   "range": Array [
                     44,
                     45,

diff --git a/.../tests/snapshots/typescript/basics/class-with-constructor-and-type-parameters.src.ts.shot b/.../tests/snapshots/typescript/basics/class-with-constructor-and-type-parameters.src.ts.shot
@@ -98,6 +98,7 @@ Object {
                   Object {
                     "constraint": undefined,
                     "default": undefined,
+                    "in": false,
                     "loc": Object {
                       "end": Object {
                         "column": 15,
@@ -126,6 +127,7 @@ Object {
                       ],
                       "type": "Identifier",
                     },
+                    "out": false,
                     "range": Array [
                       24,
                       25,
@@ -234,6 +236,7 @@ Object {
                   Object {
                     "constraint": undefined,
                     "default": undefined,
+                    "in": false,
                     "loc": Object {
                       "end": Object {
                         "column": 19,
@@ -262,6 +265,7 @@ Object {
                       ],
                       "type": "Identifier",
                     },
+                    "out": false,
                     "range": Array [
                       52,
                       53,

diff --git a/...-estree/tests/snapshots/typescript/basics/class-with-extends-generic-multiple.src.ts.shot b/...-estree/tests/snapshots/typescript/basics/class-with-extends-generic-multiple.src.ts.shot
@@ -214,6 +214,7 @@ Object {
               "typeParameters": undefined,
             },
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 21,
@@ -242,6 +243,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               10,
               21,

diff --git a/...ypescript-estree/tests/snapshots/typescript/basics/class-with-extends-generic.src.ts.shot b/...ypescript-estree/tests/snapshots/typescript/basics/class-with-extends-generic.src.ts.shot
@@ -143,6 +143,7 @@ Object {
           Object {
             "constraint": undefined,
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 11,
@@ -171,6 +172,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               10,
               11,

diff --git a/...pt-estree/tests/snapshots/typescript/basics/class-with-generic-method-default.src.ts.shot b/...pt-estree/tests/snapshots/typescript/basics/class-with-generic-method-default.src.ts.shot
@@ -133,6 +133,7 @@ Object {
                       },
                       "typeParameters": undefined,
                     },
+                    "in": false,
                     "loc": Object {
                       "end": Object {
                         "column": 16,
@@ -161,6 +162,7 @@ Object {
                       ],
                       "type": "Identifier",
                     },
+                    "out": false,
                     "range": Array [
                       21,
                       28,

diff --git a/...typescript-estree/tests/snapshots/typescript/basics/class-with-generic-method.src.ts.shot b/...typescript-estree/tests/snapshots/typescript/basics/class-with-generic-method.src.ts.shot
@@ -98,6 +98,7 @@ Object {
                   Object {
                     "constraint": undefined,
                     "default": undefined,
+                    "in": false,
                     "loc": Object {
                       "end": Object {
                         "column": 10,
@@ -126,6 +127,7 @@ Object {
                       ],
                       "type": "Identifier",
                     },
+                    "out": false,
                     "range": Array [
                       21,
                       22,

diff --git a/packages/typescript-estree/tests/snapshots/typescript/basics/class-with-method.src.ts.shot b/packages/typescript-estree/tests/snapshots/typescript/basics/class-with-method.src.ts.shot
@@ -211,6 +211,7 @@ Object {
                   Object {
                     "constraint": undefined,
                     "default": undefined,
+                    "in": false,
                     "loc": Object {
                       "end": Object {
                         "column": 7,
@@ -239,6 +240,7 @@ Object {
                       ],
                       "type": "Identifier",
                     },
+                    "out": false,
                     "range": Array [
                       36,
                       37,

diff --git a/...ypescript-estree/tests/snapshots/typescript/basics/class-with-mixin-reference.src.ts.shot b/...ypescript-estree/tests/snapshots/typescript/basics/class-with-mixin-reference.src.ts.shot
@@ -235,6 +235,7 @@ Object {
               },
             },
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 35,
@@ -263,6 +264,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               11,
               35,

diff --git a/packages/typescript-estree/tests/snapshots/typescript/basics/class-with-mixin.src.ts.shot b/packages/typescript-estree/tests/snapshots/typescript/basics/class-with-mixin.src.ts.shot
@@ -289,6 +289,7 @@ Object {
               },
             },
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 36,
@@ -317,6 +318,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               11,
               36,
@@ -828,6 +830,7 @@ Object {
           Object {
             "constraint": undefined,
             "default": undefined,
+            "in": false,
             "loc": Object {
               "end": Object {
                 "column": 18,
@@ -856,6 +859,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "out": false,
             "range": Array [
               175,
               176,