feat(typescript-estree): add support for getter/setter signatures on …

…types (#3427) * chore: update typescript to 4.3-rc Ref #3272 * feat(typescript-estree): add support for getter/setter signatures on types Ref #3272
typescript-eslint · May 22, 2021 · b830b7f · b830b7f
1 parent 4a20ee5
commit b830b7f
Show file tree

Hide file tree

Showing 26 changed files with 1,570 additions and 40 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -87,6 +87,10 @@ module.exports = {
     'no-mixed-operators': 'error',
     'no-console': 'error',
     'no-process-exit': 'error',
+    'no-fallthrough': [
+      'warn',
+      { commentPattern: '.*intentional fallthrough.*' },
+    ],
 
     //
     // eslint-plugin-eslint-comment

diff --git a/packages/ast-spec/src/element/TSMethodSignature/spec.ts b/packages/ast-spec/src/element/TSMethodSignature/spec.ts
@@ -22,6 +22,7 @@ interface TSMethodSignatureBase extends BaseNode {
   accessibility?: Accessibility;
   export?: boolean;
   static?: boolean;
+  kind: 'get' | 'method' | 'set';
 }
 
 export interface TSMethodSignatureComputedName extends TSMethodSignatureBase {

diff --git a/packages/shared-fixtures/fixtures/typescript/types/interface-with-accessors.src.ts b/packages/shared-fixtures/fixtures/typescript/types/interface-with-accessors.src.ts
@@ -0,0 +1,4 @@
+interface Thing {
+  get size(): number;
+  set size(value: number | string | boolean);
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/types/object-literal-type-with-accessors.src.ts b/packages/shared-fixtures/fixtures/typescript/types/object-literal-type-with-accessors.src.ts
@@ -0,0 +1,4 @@
+type Thing = {
+  get size(): number;
+  set size(value: number | string | boolean);
+};
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -593,6 +593,65 @@ export class Converter {
     return result;
   }
 
+  private convertMethodSignature(
+    node:
+      | ts.MethodSignature
+      | ts.GetAccessorDeclaration
+      | ts.SetAccessorDeclaration,
+  ): TSESTree.TSMethodSignature {
+    const result = this.createNode<TSESTree.TSMethodSignature>(node, {
+      type: AST_NODE_TYPES.TSMethodSignature,
+      computed: isComputedProperty(node.name),
+      key: this.convertChild(node.name),
+      params: this.convertParameters(node.parameters),
+      kind: ((): 'get' | 'set' | 'method' => {
+        switch (node.kind) {
+          case SyntaxKind.GetAccessor:
+            return 'get';
+
+          case SyntaxKind.SetAccessor:
+            return 'set';
+
+          case SyntaxKind.MethodSignature:
+            return 'method';
+        }
+      })(),
+    });
+
+    if (isOptional(node)) {
+      result.optional = true;
+    }
+
+    if (node.type) {
+      result.returnType = this.convertTypeAnnotation(node.type, node);
+    }
+
+    if (hasModifier(SyntaxKind.ReadonlyKeyword, node)) {
+      result.readonly = true;
+    }
+
+    if (node.typeParameters) {
+      result.typeParameters = this.convertTSTypeParametersToTypeParametersDeclaration(
+        node.typeParameters,
+      );
+    }
+
+    const accessibility = getTSNodeAccessibility(node);
+    if (accessibility) {
+      result.accessibility = accessibility;
+    }
+
+    if (hasModifier(SyntaxKind.ExportKeyword, node)) {
+      result.export = true;
+    }
+
+    if (hasModifier(SyntaxKind.StaticKeyword, node)) {
+      result.static = true;
+    }
+
+    return result;
+  }
+
   /**
    * Applies the given TS modifiers to the given result object.
    * @param result
@@ -1069,7 +1128,15 @@ export class Converter {
       }
 
       case SyntaxKind.GetAccessor:
-      case SyntaxKind.SetAccessor:
+      case SyntaxKind.SetAccessor: {
+        if (
+          node.parent.kind === SyntaxKind.InterfaceDeclaration ||
+          node.parent.kind === SyntaxKind.TypeLiteral
+        ) {
+          return this.convertMethodSignature(node);
+        }
+      }
+      // otherwise, it is a non-type accessor - intentional fallthrough
       case SyntaxKind.MethodDeclaration: {
         const method = this.createNode<
           TSESTree.TSEmptyBodyFunctionExpression | TSESTree.FunctionExpression
@@ -2340,44 +2407,7 @@ export class Converter {
       }
 
       case SyntaxKind.MethodSignature: {
-        const result = this.createNode<TSESTree.TSMethodSignature>(node, {
-          type: AST_NODE_TYPES.TSMethodSignature,
-          computed: isComputedProperty(node.name),
-          key: this.convertChild(node.name),
-          params: this.convertParameters(node.parameters),
-        });
-
-        if (isOptional(node)) {
-          result.optional = true;
-        }
-
-        if (node.type) {
-          result.returnType = this.convertTypeAnnotation(node.type, node);
-        }
-
-        if (hasModifier(SyntaxKind.ReadonlyKeyword, node)) {
-          result.readonly = true;
-        }
-
-        if (node.typeParameters) {
-          result.typeParameters = this.convertTSTypeParametersToTypeParametersDeclaration(
-            node.typeParameters,
-          );
-        }
-
-        const accessibility = getTSNodeAccessibility(node);
-        if (accessibility) {
-          result.accessibility = accessibility;
-        }
-
-        if (hasModifier(SyntaxKind.ExportKeyword, node)) {
-          result.export = true;
-        }
-
-        if (hasModifier(SyntaxKind.StaticKeyword, node)) {
-          result.static = true;
-        }
-        return result;
+        return this.convertMethodSignature(node);
       }
 
       case SyntaxKind.PropertySignature: {

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
@@ -180,7 +180,10 @@ export interface EstreeToTsNodeTypes {
   [AST_NODE_TYPES.TSIntersectionType]: ts.IntersectionTypeNode;
   [AST_NODE_TYPES.TSLiteralType]: ts.LiteralTypeNode;
   [AST_NODE_TYPES.TSMappedType]: ts.MappedTypeNode;
-  [AST_NODE_TYPES.TSMethodSignature]: ts.MethodSignature;
+  [AST_NODE_TYPES.TSMethodSignature]:
+    | ts.MethodSignature
+    | ts.GetAccessorDeclaration
+    | ts.SetAccessorDeclaration;
   [AST_NODE_TYPES.TSModuleBlock]: ts.ModuleBlock;
   [AST_NODE_TYPES.TSModuleDeclaration]: ts.ModuleDeclaration;
   [AST_NODE_TYPES.TSNamedTupleMember]: ts.NamedTupleMember;

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
@@ -2639,6 +2639,8 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/indexed.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/interface-with-accessors.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/intersection-type.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/literal-number.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
@@ -2661,6 +2663,8 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/types/nested-types.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+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/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/.../typescript-estree/tests/snapshots/typescript/basics/export-default-interface.src.ts.shot b/.../typescript-estree/tests/snapshots/typescript/basics/export-default-interface.src.ts.shot
@@ -27,6 +27,7 @@ Object {
                 ],
                 "type": "Identifier",
               },
+              "kind": "method",
               "loc": Object {
                 "end": Object {
                   "column": 18,

diff --git a/...pt-estree/tests/snapshots/typescript/basics/interface-with-all-property-types.src.ts.shot b/...pt-estree/tests/snapshots/typescript/basics/interface-with-all-property-types.src.ts.shot
@@ -431,6 +431,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 16,
@@ -502,6 +503,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 24,
@@ -629,6 +631,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 26,
@@ -756,6 +759,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 26,

diff --git a/...ages/typescript-estree/tests/snapshots/typescript/basics/interface-with-jsdoc.src.ts.shot b/...ages/typescript-estree/tests/snapshots/typescript/basics/interface-with-jsdoc.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 13,

diff --git a/...ges/typescript-estree/tests/snapshots/typescript/basics/interface-with-method.src.ts.shot b/...ges/typescript-estree/tests/snapshots/typescript/basics/interface-with-method.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 23,
@@ -150,6 +151,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 18,

diff --git a/...t-estree/tests/snapshots/typescript/basics/interface-with-optional-properties.src.ts.shot b/...t-estree/tests/snapshots/typescript/basics/interface-with-optional-properties.src.ts.shot
@@ -143,6 +143,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 34,

diff --git a/...pescript-estree/tests/snapshots/typescript/basics/type-assertion-in-interface.src.ts.shot b/...pescript-estree/tests/snapshots/typescript/basics/type-assertion-in-interface.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 36,

diff --git a/...tree/tests/snapshots/typescript/basics/type-assertion-with-guard-in-interface.src.ts.shot b/...tree/tests/snapshots/typescript/basics/type-assertion-with-guard-in-interface.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 46,

diff --git a/...s/typescript-estree/tests/snapshots/typescript/basics/type-guard-in-interface.src.ts.shot b/...s/typescript-estree/tests/snapshots/typescript/basics/type-guard-in-interface.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 38,

diff --git a/...es/typescript-estree/tests/snapshots/typescript/basics/typed-method-signature.src.ts.shot b/...es/typescript-estree/tests/snapshots/typescript/basics/typed-method-signature.src.ts.shot
@@ -69,6 +69,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 23,
@@ -193,6 +194,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 18,

diff --git a/packages/typescript-estree/tests/snapshots/typescript/basics/typed-this.src.ts.shot b/packages/typescript-estree/tests/snapshots/typescript/basics/typed-this.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 65,

diff --git a/.../snapshots/typescript/errorRecovery/empty-type-parameters-in-method-signature.src.ts.shot b/.../snapshots/typescript/errorRecovery/empty-type-parameters-in-method-signature.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 11,

diff --git a/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-export.src.ts.shot b/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-export.src.ts.shot
@@ -27,6 +27,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 32,

diff --git a/...ript-estree/tests/snapshots/typescript/errorRecovery/interface-method-private.src.ts.shot b/...ript-estree/tests/snapshots/typescript/errorRecovery/interface-method-private.src.ts.shot
@@ -27,6 +27,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 33,

diff --git a/...pt-estree/tests/snapshots/typescript/errorRecovery/interface-method-protected.src.ts.shot b/...pt-estree/tests/snapshots/typescript/errorRecovery/interface-method-protected.src.ts.shot
@@ -27,6 +27,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 33,

diff --git a/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-public.src.ts.shot b/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-public.src.ts.shot
@@ -27,6 +27,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 32,

diff --git a/...ipt-estree/tests/snapshots/typescript/errorRecovery/interface-method-readonly.src.ts.shot b/...ipt-estree/tests/snapshots/typescript/errorRecovery/interface-method-readonly.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 32,

diff --git a/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-static.src.ts.shot b/...cript-estree/tests/snapshots/typescript/errorRecovery/interface-method-static.src.ts.shot
@@ -26,6 +26,7 @@ Object {
               ],
               "type": "Identifier",
             },
+            "kind": "method",
             "loc": Object {
               "end": Object {
                 "column": 30,