feat(typescript-estree): support overrides on class members

Ref #3272
typescript-eslint · May 22, 2021 · cf9e583 · cf9e583
1 parent b830b7f
commit cf9e583
Show file tree

Hide file tree

Showing 113 changed files with 1,764 additions and 4 deletions.
diff --git a/packages/ast-spec/src/base/ClassPropertyBase.ts b/packages/ast-spec/src/base/ClassPropertyBase.ts
@@ -21,6 +21,7 @@ interface ClassPropertyBase extends BaseNode {
   optional?: boolean;
   definite?: boolean;
   typeAnnotation?: TSTypeAnnotation;
+  override?: boolean;
 }
 
 export interface ClassPropertyComputedNameBase extends ClassPropertyBase {

diff --git a/packages/ast-spec/src/base/MethodDefinitionBase.ts b/packages/ast-spec/src/base/MethodDefinitionBase.ts
@@ -21,6 +21,7 @@ interface MethodDefinitionBase extends BaseNode {
   decorators?: Decorator[];
   accessibility?: Accessibility;
   typeParameters?: TSTypeParameterDeclaration;
+  override?: boolean;
 }
 
 export interface MethodDefinitionComputedNameBase extends MethodDefinitionBase {

diff --git a/...ges/shared-fixtures/fixtures/typescript/basics/abstract-class-with-override-method.src.ts b/...ges/shared-fixtures/fixtures/typescript/basics/abstract-class-with-override-method.src.ts
@@ -0,0 +1,3 @@
+abstract class SpecializedComponent extends SomeComponent {
+  abstract override show();
+}
diff --git a/...s/shared-fixtures/fixtures/typescript/basics/abstract-class-with-override-property.src.ts b/...s/shared-fixtures/fixtures/typescript/basics/abstract-class-with-override-property.src.ts
@@ -0,0 +1,3 @@
+abstract class SpecializedComponent extends SomeComponent {
+  abstract override foo = 1;
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/basics/class-with-override-method.src.ts b/packages/shared-fixtures/fixtures/typescript/basics/class-with-override-method.src.ts
@@ -0,0 +1,5 @@
+class SpecializedComponent extends SomeComponent {
+  override show() {
+      // ...
+  }
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/basics/class-with-override-property.src.ts b/packages/shared-fixtures/fixtures/typescript/basics/class-with-override-property.src.ts
@@ -0,0 +1,3 @@
+class SpecializedComponent extends SomeComponent {
+  override foo = 1;
+}
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -1094,6 +1094,7 @@ export class Converter {
           static: hasModifier(SyntaxKind.StaticKeyword, node),
           readonly: hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
           declare: hasModifier(SyntaxKind.DeclareKeyword, node),
+          override: hasModifier(SyntaxKind.OverrideKeyword, node),
         });
 
         if (node.type) {
@@ -1209,6 +1210,7 @@ export class Converter {
             computed: isComputedProperty(node.name),
             static: hasModifier(SyntaxKind.StaticKeyword, node),
             kind: 'method',
+            override: hasModifier(SyntaxKind.OverrideKeyword, node),
           });
 
           if (node.decorators) {
@@ -1295,6 +1297,7 @@ export class Converter {
           computed: false,
           static: isStatic,
           kind: isStatic ? 'method' : 'constructor',
+          override: false,
         });
 
         const accessibility = getTSNodeAccessibility(node);

diff --git a/packages/typescript-estree/tests/ast-alignment/utils.ts b/packages/typescript-estree/tests/ast-alignment/utils.ts
@@ -126,10 +126,6 @@ export function preprocessBabylonAST(ast: BabelTypes.File): any {
           node.params = node.parameters;
           delete node.parameters;
         }
-        if (node.kind) {
-          // TODO - remove this once we support accessor signatures
-          delete node.kind;
-        }
       },
       /**
        * We want this node to be different
@@ -169,6 +165,13 @@ export function preprocessBabylonAST(ast: BabelTypes.File): any {
           node.type = AST_NODE_TYPES.TSAbstractMethodDefinition;
           delete node.abstract;
         }
+        /**
+         * TS 4.3: overrides on class members
+         * Babel doesn't ever emit a false override flag
+         */
+        if (node.override == null) {
+          node.override = false;
+        }
       },
       ClassProperty(node) {
         /**
@@ -187,6 +190,13 @@ export function preprocessBabylonAST(ast: BabelTypes.File): any {
         if (!node.declare) {
           node.declare = false;
         }
+        /**
+         * TS 4.3: overrides on class members
+         * Babel doesn't ever emit a false override flag
+         */
+        if (node.override == null) {
+          node.override = false;
+        }
       },
       TSExpressionWithTypeArguments(node, parent: any) {
         if (parent.type === AST_NODE_TYPES.TSInterfaceDeclaration) {

diff --git a/...ges/typescript-estree/tests/snapshots/comments/export-default-anonymous-class.src.js.shot b/...ges/typescript-estree/tests/snapshots/comments/export-default-anonymous-class.src.js.shot
@@ -38,6 +38,7 @@ Object {
                   "line": 8,
                 },
               },
+              "override": false,
               "range": Array [
                 103,
                 119,

diff --git a/...ypescript-estree/tests/snapshots/javascript/classes/class-accessor-properties.src.js.shot b/...ypescript-estree/tests/snapshots/javascript/classes/class-accessor-properties.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               18,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               19,
               29,

diff --git a/...script-estree/tests/snapshots/javascript/classes/class-computed-static-method.src.js.shot b/...script-estree/tests/snapshots/javascript/classes/class-computed-static-method.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               23,

diff --git a/...script-estree/tests/snapshots/javascript/classes/class-method-named-prototype.src.js.shot b/...script-estree/tests/snapshots/javascript/classes/class-method-named-prototype.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               22,

diff --git a/...ypescript-estree/tests/snapshots/javascript/classes/class-method-named-static.src.js.shot b/...ypescript-estree/tests/snapshots/javascript/classes/class-method-named-static.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               19,

diff --git a/...cript-estree/tests/snapshots/javascript/classes/class-method-named-with-space.src.js.shot b/...cript-estree/tests/snapshots/javascript/classes/class-method-named-with-space.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               24,

diff --git a/...s/typescript-estree/tests/snapshots/javascript/classes/class-one-method-super.src.js.shot b/...s/typescript-estree/tests/snapshots/javascript/classes/class-one-method-super.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               41,

diff --git a/packages/typescript-estree/tests/snapshots/javascript/classes/class-one-method.src.js.shot b/packages/typescript-estree/tests/snapshots/javascript/classes/class-one-method.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               19,

diff --git a/...estree/tests/snapshots/javascript/classes/class-static-method-named-prototype.src.js.shot b/...estree/tests/snapshots/javascript/classes/class-static-method-named-prototype.src.js.shot
@@ -38,6 +38,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               33,

diff --git a/...pt-estree/tests/snapshots/javascript/classes/class-static-method-named-static.src.js.shot b/...pt-estree/tests/snapshots/javascript/classes/class-static-method-named-static.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               26,

diff --git a/...ages/typescript-estree/tests/snapshots/javascript/classes/class-static-method.src.js.shot b/...ages/typescript-estree/tests/snapshots/javascript/classes/class-static-method.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               21,

diff --git a/...sts/snapshots/javascript/classes/class-static-methods-and-accessor-properties.src.js.shot b/...sts/snapshots/javascript/classes/class-static-methods-and-accessor-properties.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               21,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               22,
               38,
@@ -193,6 +195,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               39,
               56,

diff --git a/...t-estree/tests/snapshots/javascript/classes/class-two-computed-static-methods.src.js.shot b/...t-estree/tests/snapshots/javascript/classes/class-two-computed-static-methods.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               22,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               24,
               37,

diff --git a/...ree/tests/snapshots/javascript/classes/class-two-methods-computed-constructor.src.js.shot b/...ree/tests/snapshots/javascript/classes/class-two-methods-computed-constructor.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               26,
@@ -116,6 +117,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               27,
               46,

diff --git a/...s/typescript-estree/tests/snapshots/javascript/classes/class-two-methods-semi.src.js.shot b/...s/typescript-estree/tests/snapshots/javascript/classes/class-two-methods-semi.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               14,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               15,
               20,

diff --git a/...script-estree/tests/snapshots/javascript/classes/class-two-methods-three-semi.src.js.shot b/...script-estree/tests/snapshots/javascript/classes/class-two-methods-three-semi.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               10,
               15,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               16,
               21,

diff --git a/...pescript-estree/tests/snapshots/javascript/classes/class-two-methods-two-semi.src.js.shot b/...pescript-estree/tests/snapshots/javascript/classes/class-two-methods-two-semi.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               14,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               15,
               20,

diff --git a/packages/typescript-estree/tests/snapshots/javascript/classes/class-two-methods.src.js.shot b/packages/typescript-estree/tests/snapshots/javascript/classes/class-two-methods.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               14,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               14,
               19,

diff --git a/...tests/snapshots/javascript/classes/class-two-static-methods-named-constructor.src.js.shot b/...tests/snapshots/javascript/classes/class-two-static-methods-named-constructor.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               31,
@@ -115,6 +116,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               32,
               54,

diff --git a/...t-estree/tests/snapshots/javascript/classes/class-with-constructor-parameters.src.js.shot b/...t-estree/tests/snapshots/javascript/classes/class-with-constructor-parameters.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               32,

diff --git a/...t-estree/tests/snapshots/javascript/classes/class-with-constructor-with-space.src.js.shot b/...t-estree/tests/snapshots/javascript/classes/class-with-constructor-with-space.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               25,

diff --git a/...s/typescript-estree/tests/snapshots/javascript/classes/class-with-constructor.src.js.shot b/...s/typescript-estree/tests/snapshots/javascript/classes/class-with-constructor.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               9,
               24,

diff --git a/...pt-estree/tests/snapshots/javascript/classes/invalid-class-setter-declaration.src.js.shot b/...pt-estree/tests/snapshots/javascript/classes/invalid-class-setter-declaration.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 1,
               },
             },
+            "override": false,
             "range": Array [
               10,
               22,

diff --git a/.../typescript-estree/tests/snapshots/javascript/defaultParams/class-constructor.src.js.shot b/.../typescript-estree/tests/snapshots/javascript/defaultParams/class-constructor.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               44,

diff --git a/packages/typescript-estree/tests/snapshots/javascript/defaultParams/class-method.src.js.shot b/packages/typescript-estree/tests/snapshots/javascript/defaultParams/class-method.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               36,

diff --git a/...stree/tests/snapshots/javascript/destructuring/class-constructor-params-array.src.js.shot b/...stree/tests/snapshots/javascript/destructuring/class-constructor-params-array.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               45,

diff --git a/...ts/snapshots/javascript/destructuring/class-constructor-params-defaults-array.src.js.shot b/...ts/snapshots/javascript/destructuring/class-constructor-params-defaults-array.src.js.shot
@@ -37,6 +37,7 @@ Object {
                 "line": 2,
               },
             },
+            "override": false,
             "range": Array [
               14,
               49,