feat(typescript-estree): add support for declare class properties (#1136

)
typescript-eslint · Oct 24, 2019 · 1508670 · 1508670
1 parent 6d0f2ce
commit 1508670
Show file tree

Hide file tree

Showing 10 changed files with 5,865 additions and 2,841 deletions.
diff --git a/packages/eslint-plugin/src/rules/indent.ts b/packages/eslint-plugin/src/rules/indent.ts
@@ -163,6 +163,7 @@ export default util.createRule<Options, MessageIds>({
           type,
           static: false,
           readonly: false,
+          declare: false,
           ...base,
         } as TSESTree.ClassProperty;
       }

diff --git a/packages/parser/tests/lib/__snapshots__/typescript.ts.snap b/packages/parser/tests/lib/__snapshots__/typescript.ts.snap
@@ -932,6 +932,171 @@ Object {
 }
 `;
 
+exports[`typescript fixtures/basics/abstract-class-with-declare-properties.src 1`] = `
+Object {
+  "$id": 4,
+  "block": Object {
+    "range": Array [
+      0,
+      230,
+    ],
+    "type": "Program",
+  },
+  "childScopes": Array [
+    Object {
+      "$id": 3,
+      "block": Object {
+        "range": Array [
+          0,
+          230,
+        ],
+        "type": "Program",
+      },
+      "childScopes": Array [
+        Object {
+          "$id": 2,
+          "block": Object {
+            "range": Array [
+              0,
+              229,
+            ],
+            "type": "ClassDeclaration",
+          },
+          "childScopes": Array [],
+          "functionExpressionScope": false,
+          "isStrict": true,
+          "references": Array [],
+          "throughReferences": Array [],
+          "type": "class",
+          "upperScope": Object {
+            "$ref": 3,
+          },
+          "variableMap": Object {
+            "AbstractDeclProps": Object {
+              "$ref": 1,
+            },
+          },
+          "variableScope": Object {
+            "$ref": 3,
+          },
+          "variables": Array [
+            Object {
+              "$id": 1,
+              "defs": Array [
+                Object {
+                  "name": Object {
+                    "name": "AbstractDeclProps",
+                    "range": Array [
+                      15,
+                      32,
+                    ],
+                    "type": "Identifier",
+                  },
+                  "node": Object {
+                    "range": Array [
+                      0,
+                      229,
+                    ],
+                    "type": "ClassDeclaration",
+                  },
+                  "parent": undefined,
+                  "type": "ClassName",
+                },
+              ],
+              "eslintUsed": undefined,
+              "identifiers": Array [
+                Object {
+                  "name": "AbstractDeclProps",
+                  "range": Array [
+                    15,
+                    32,
+                  ],
+                  "type": "Identifier",
+                },
+              ],
+              "name": "AbstractDeclProps",
+              "references": Array [],
+              "scope": Object {
+                "$ref": 2,
+              },
+            },
+          ],
+        },
+      ],
+      "functionExpressionScope": false,
+      "isStrict": true,
+      "references": Array [],
+      "throughReferences": Array [],
+      "type": "module",
+      "upperScope": Object {
+        "$ref": 4,
+      },
+      "variableMap": Object {
+        "AbstractDeclProps": Object {
+          "$ref": 0,
+        },
+      },
+      "variableScope": Object {
+        "$ref": 3,
+      },
+      "variables": Array [
+        Object {
+          "$id": 0,
+          "defs": Array [
+            Object {
+              "name": Object {
+                "name": "AbstractDeclProps",
+                "range": Array [
+                  15,
+                  32,
+                ],
+                "type": "Identifier",
+              },
+              "node": Object {
+                "range": Array [
+                  0,
+                  229,
+                ],
+                "type": "ClassDeclaration",
+              },
+              "parent": null,
+              "type": "ClassName",
+            },
+          ],
+          "eslintUsed": undefined,
+          "identifiers": Array [
+            Object {
+              "name": "AbstractDeclProps",
+              "range": Array [
+                15,
+                32,
+              ],
+              "type": "Identifier",
+            },
+          ],
+          "name": "AbstractDeclProps",
+          "references": Array [],
+          "scope": Object {
+            "$ref": 3,
+          },
+        },
+      ],
+    },
+  ],
+  "functionExpressionScope": false,
+  "isStrict": false,
+  "references": Array [],
+  "throughReferences": Array [],
+  "type": "global",
+  "upperScope": null,
+  "variableMap": Object {},
+  "variableScope": Object {
+    "$ref": 4,
+  },
+  "variables": Array [],
+}
+`;
+
 exports[`typescript fixtures/basics/abstract-class-with-optional-method.src 1`] = `
 Object {
   "$id": 4,
@@ -4605,6 +4770,171 @@ Object {
 }
 `;
 
+exports[`typescript fixtures/basics/class-with-declare-properties.src 1`] = `
+Object {
+  "$id": 4,
+  "block": Object {
+    "range": Array [
+      0,
+      271,
+    ],
+    "type": "Program",
+  },
+  "childScopes": Array [
+    Object {
+      "$id": 3,
+      "block": Object {
+        "range": Array [
+          0,
+          271,
+        ],
+        "type": "Program",
+      },
+      "childScopes": Array [
+        Object {
+          "$id": 2,
+          "block": Object {
+            "range": Array [
+              0,
+              270,
+            ],
+            "type": "ClassDeclaration",
+          },
+          "childScopes": Array [],
+          "functionExpressionScope": false,
+          "isStrict": true,
+          "references": Array [],
+          "throughReferences": Array [],
+          "type": "class",
+          "upperScope": Object {
+            "$ref": 3,
+          },
+          "variableMap": Object {
+            "DeclProps": Object {
+              "$ref": 1,
+            },
+          },
+          "variableScope": Object {
+            "$ref": 3,
+          },
+          "variables": Array [
+            Object {
+              "$id": 1,
+              "defs": Array [
+                Object {
+                  "name": Object {
+                    "name": "DeclProps",
+                    "range": Array [
+                      6,
+                      15,
+                    ],
+                    "type": "Identifier",
+                  },
+                  "node": Object {
+                    "range": Array [
+                      0,
+                      270,
+                    ],
+                    "type": "ClassDeclaration",
+                  },
+                  "parent": undefined,
+                  "type": "ClassName",
+                },
+              ],
+              "eslintUsed": undefined,
+              "identifiers": Array [
+                Object {
+                  "name": "DeclProps",
+                  "range": Array [
+                    6,
+                    15,
+                  ],
+                  "type": "Identifier",
+                },
+              ],
+              "name": "DeclProps",
+              "references": Array [],
+              "scope": Object {
+                "$ref": 2,
+              },
+            },
+          ],
+        },
+      ],
+      "functionExpressionScope": false,
+      "isStrict": true,
+      "references": Array [],
+      "throughReferences": Array [],
+      "type": "module",
+      "upperScope": Object {
+        "$ref": 4,
+      },
+      "variableMap": Object {
+        "DeclProps": Object {
+          "$ref": 0,
+        },
+      },
+      "variableScope": Object {
+        "$ref": 3,
+      },
+      "variables": Array [
+        Object {
+          "$id": 0,
+          "defs": Array [
+            Object {
+              "name": Object {
+                "name": "DeclProps",
+                "range": Array [
+                  6,
+                  15,
+                ],
+                "type": "Identifier",
+              },
+              "node": Object {
+                "range": Array [
+                  0,
+                  270,
+                ],
+                "type": "ClassDeclaration",
+              },
+              "parent": null,
+              "type": "ClassName",
+            },
+          ],
+          "eslintUsed": undefined,
+          "identifiers": Array [
+            Object {
+              "name": "DeclProps",
+              "range": Array [
+                6,
+                15,
+              ],
+              "type": "Identifier",
+            },
+          ],
+          "name": "DeclProps",
+          "references": Array [],
+          "scope": Object {
+            "$ref": 3,
+          },
+        },
+      ],
+    },
+  ],
+  "functionExpressionScope": false,
+  "isStrict": false,
+  "references": Array [],
+  "throughReferences": Array [],
+  "type": "global",
+  "upperScope": null,
+  "variableMap": Object {},
+  "variableScope": Object {
+    "$ref": 4,
+  },
+  "variables": Array [],
+}
+`;
+
 exports[`typescript fixtures/basics/class-with-definite-assignment.src 1`] = `
 Object {
   "$id": 4,

diff --git a/.../shared-fixtures/fixtures/typescript/basics/abstract-class-with-declare-properties.src.ts b/.../shared-fixtures/fixtures/typescript/basics/abstract-class-with-declare-properties.src.ts
@@ -0,0 +1,7 @@
+abstract class AbstractDeclProps {
+  declare prop1: string;
+  declare abstract prop2: string;
+  declare public abstract prop3: string;
+  declare readonly abstract prop4: string;
+  declare public readonly abstract prop5: string;
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/basics/class-with-declare-properties.src.ts b/packages/shared-fixtures/fixtures/typescript/basics/class-with-declare-properties.src.ts
@@ -0,0 +1,9 @@
+class DeclProps {
+  declare prop1: string;
+  declare public prop2: string;
+  declare static prop3: string;
+  declare readonly prop3: string;
+  declare public readonly prop4: string;
+  declare public static prop5: string;
+  declare public static readonly prop6: string;
+}
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -926,6 +926,7 @@ export class Converter {
           computed: isComputedProperty(node.name),
           static: hasModifier(SyntaxKind.StaticKeyword, node),
           readonly: hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
+          declare: hasModifier(SyntaxKind.DeclareKeyword, node),
         });
 
         if (node.type) {

diff --git a/packages/typescript-estree/src/ts-estree/ts-estree.ts b/packages/typescript-estree/src/ts-estree/ts-estree.ts
@@ -472,6 +472,7 @@ interface ClassPropertyBase extends BaseNode {
   value: Expression | null;
   computed: boolean;
   static: boolean;
+  declare: boolean;
   readonly?: boolean;
   decorators?: Decorator[];
   accessibility?: Accessibility;