feat: make Structure.isX function more flexible

Closes #1219
dsherret · Nov 20, 2021 · a54dd69 · a54dd69
1 parent bcf694f
commit a54dd69
Show file tree

Hide file tree

Showing 45 changed files with 510 additions and 745 deletions.
diff --git a/deno/ts_morph.d.ts b/deno/ts_morph.d.ts
diff --git a/deno/ts_morph.js b/deno/ts_morph.js
diff --git a/packages/ts-morph/lib/ts-morph.d.ts b/packages/ts-morph/lib/ts-morph.d.ts
diff --git a/packages/ts-morph/scripts/generation/createStructureTypeGuards.ts b/packages/ts-morph/scripts/generation/createStructureTypeGuards.ts
@@ -1,15 +1,15 @@
 /**
  * Code Manipulation - Create type guards on `Structure`
  * -------------------------------------------------
- * This modifies the Structure.ts file that is used
+ * This modifies the Structure.generated.ts file that is used
  * for doing type guards on structures.
  * -------------------------------------------------
  */
 import { tsMorph } from "../deps.ts";
 import { Structure, TsMorphInspector } from "../inspectors/mod.ts";
 
 export function createStructureTypeGuards(inspector: TsMorphInspector) {
-  const structureTypeGuardsFile = inspector.getProject().getSourceFileOrThrow("Structure.ts");
+  const structureTypeGuardsFile = inspector.getProject().getSourceFileOrThrow("Structure.generated.ts");
   const typeGuardsExpr = structureTypeGuardsFile
     .getVariableDeclarationOrThrow("Structure")
     .getInitializerIfKindOrThrow(tsMorph.SyntaxKind.AsExpression)
@@ -86,9 +86,9 @@ function addNewMethods(typeGuardsExpr: tsMorph.ObjectLiteralExpression, structur
     typeParameters: getTypeParameters(info),
     statements: writer => {
       if (info.kinds.size === 1)
-        writer.write(`return structure.kind === StructureKind.${Array.from(info.kinds)[0]};`);
+        writer.write(`return (structure as any)?.kind === StructureKind.${Array.from(info.kinds)[0]};`);
       else {
-        writer.write("switch (structure.kind)").block(() => {
+        writer.write("switch ((structure as any)?.kind)").block(() => {
           for (const kind of info.kinds)
             writer.writeLine(`case StructureKind.${kind}:`);
 
@@ -102,14 +102,14 @@ function addNewMethods(typeGuardsExpr: tsMorph.ObjectLiteralExpression, structur
 
   function getTypeParameters(info: StructureInfo): tsMorph.OptionalKind<tsMorph.TypeParameterDeclarationStructure>[] {
     if (info.kind == null)
-      return [{ name: "T", constraint: "Structure & { kind: StructureKind; }" }];
+      return [{ name: "T" }];
     return [];
   }
 
   function getParameterType(info: StructureInfo) {
     if (info.kind == null)
       return "T";
-    return "Structure & { kind: StructureKind; }";
+    return "unknown";
   }
 
   function getReturnType(info: StructureInfo) {

diff --git a/...ages/ts-morph/src/structures/Structure.ts → ...rph/src/structures/Structure.generated.ts b/...ages/ts-morph/src/structures/Structure.ts → ...rph/src/structures/Structure.generated.ts
diff --git a/packages/ts-morph/src/structures/class/ClassDeclarationStructure.ts b/packages/ts-morph/src/structures/class/ClassDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { AmbientableNodeStructure, ExportableNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { ClassLikeDeclarationBaseStructure } from "./base";
 

diff --git a/packages/ts-morph/src/structures/class/ClassStaticBlockDeclarationStructure.ts b/packages/ts-morph/src/structures/class/ClassStaticBlockDeclarationStructure.ts
@@ -1,6 +1,6 @@
 import { JSDocableNodeStructure } from "../base";
 import { StatementedNodeStructure } from "../statement";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ClassStaticBlockDeclarationStructure

diff --git a/packages/ts-morph/src/structures/class/ConstructorDeclarationStructure.ts b/packages/ts-morph/src/structures/class/ConstructorDeclarationStructure.ts
@@ -1,6 +1,6 @@
 import { JSDocableNodeStructure, ScopedNodeStructure, SignaturedDeclarationStructure, TypeParameteredNodeStructure } from "../base";
 import { FunctionLikeDeclarationStructure } from "../function";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 

diff --git a/packages/ts-morph/src/structures/class/GetAccessorDeclarationStructure.ts b/packages/ts-morph/src/structures/class/GetAccessorDeclarationStructure.ts
@@ -1,6 +1,6 @@
 import { AbstractableNodeStructure, DecoratableNodeStructure, PropertyNamedNodeStructure, ScopedNodeStructure, StaticableNodeStructure } from "../base";
 import { FunctionLikeDeclarationStructure } from "../function";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface GetAccessorDeclarationStructure

diff --git a/packages/ts-morph/src/structures/class/MethodDeclarationStructure.ts b/packages/ts-morph/src/structures/class/MethodDeclarationStructure.ts
@@ -13,7 +13,7 @@ import {
   TypeParameteredNodeStructure,
 } from "../base";
 import { FunctionLikeDeclarationStructure } from "../function";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 

diff --git a/packages/ts-morph/src/structures/class/PropertyDeclarationStructure.ts b/packages/ts-morph/src/structures/class/PropertyDeclarationStructure.ts
@@ -13,7 +13,7 @@ import {
   StaticableNodeStructure,
   TypedNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface PropertyDeclarationStructure

diff --git a/packages/ts-morph/src/structures/class/SetAccessorDeclarationStructure.ts b/packages/ts-morph/src/structures/class/SetAccessorDeclarationStructure.ts
@@ -1,6 +1,6 @@
 import { AbstractableNodeStructure, DecoratableNodeStructure, PropertyNamedNodeStructure, ScopedNodeStructure, StaticableNodeStructure } from "../base";
 import { FunctionLikeDeclarationStructure } from "../function";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface SetAccessorDeclarationStructure

diff --git a/packages/ts-morph/src/structures/decorator/DecoratorStructure.ts b/packages/ts-morph/src/structures/decorator/DecoratorStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface DecoratorStructure extends Structure, DecoratorSpecificStructure {

diff --git a/packages/ts-morph/src/structures/doc/JSDocStructure.ts b/packages/ts-morph/src/structures/doc/JSDocStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { JSDocTagStructure } from "./JSDocTagStructure";

diff --git a/packages/ts-morph/src/structures/doc/JSDocTagStructure.ts b/packages/ts-morph/src/structures/doc/JSDocTagStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface JSDocTagStructure extends Structure, JSDocTagSpecificStructure {

diff --git a/packages/ts-morph/src/structures/enum/EnumDeclarationStructure.ts b/packages/ts-morph/src/structures/enum/EnumDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { AmbientableNodeStructure, ExportableNodeStructure, JSDocableNodeStructure, NamedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { EnumMemberStructure } from "./EnumMemberStructure";

diff --git a/packages/ts-morph/src/structures/enum/EnumMemberStructure.ts b/packages/ts-morph/src/structures/enum/EnumMemberStructure.ts
@@ -1,5 +1,5 @@
 import { InitializerExpressionableNodeStructure, JSDocableNodeStructure, PropertyNamedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface EnumMemberStructure

diff --git a/packages/ts-morph/src/structures/expression/object/PropertyAssignmentStructure.ts b/packages/ts-morph/src/structures/expression/object/PropertyAssignmentStructure.ts
@@ -1,6 +1,6 @@
 import { WriterFunction } from "../../../types";
 import { PropertyNamedNodeStructure } from "../../base";
-import { KindedStructure, Structure } from "../../Structure";
+import { KindedStructure, Structure } from "../../Structure.generated";
 import { StructureKind } from "../../StructureKind";
 
 export interface PropertyAssignmentStructure extends Structure, PropertyAssignmentSpecificStructure, PropertyNamedNodeStructure {

diff --git a/packages/ts-morph/src/structures/expression/object/ShorthandPropertyAssignmentStructure.ts b/packages/ts-morph/src/structures/expression/object/ShorthandPropertyAssignmentStructure.ts
@@ -1,5 +1,5 @@
 import { NamedNodeStructure } from "../../base";
-import { KindedStructure, Structure } from "../../Structure";
+import { KindedStructure, Structure } from "../../Structure.generated";
 import { StructureKind } from "../../StructureKind";
 
 export interface ShorthandPropertyAssignmentStructure extends Structure, ShorthandPropertyAssignmentSpecificStructure, NamedNodeStructure {

diff --git a/packages/ts-morph/src/structures/expression/object/SpreadAssignmentStructure.ts b/packages/ts-morph/src/structures/expression/object/SpreadAssignmentStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../../Structure";
+import { KindedStructure, Structure } from "../../Structure.generated";
 import { StructureKind } from "../../StructureKind";
 import { ExpressionedNodeStructure } from "../expressioned";
 

diff --git a/packages/ts-morph/src/structures/function/FunctionDeclarationStructure.ts b/packages/ts-morph/src/structures/function/FunctionDeclarationStructure.ts
@@ -8,7 +8,7 @@ import {
   SignaturedDeclarationStructure,
   TypeParameteredNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { FunctionLikeDeclarationStructure } from "./FunctionLikeDeclarationStructure";

diff --git a/packages/ts-morph/src/structures/function/ParameterDeclarationStructure.ts b/packages/ts-morph/src/structures/function/ParameterDeclarationStructure.ts
@@ -8,7 +8,7 @@ import {
   ScopeableNodeStructure,
   TypedNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ParameterDeclarationStructure

diff --git a/packages/ts-morph/src/structures/index.ts b/packages/ts-morph/src/structures/index.ts
@@ -10,7 +10,7 @@ export * from "./interface";
 export * from "./jsx";
 export * from "./module";
 export * from "./statement";
-export * from "./Structure";
+export * from "./Structure.generated";
 export * from "./StructureKind";
 export * from "./type";
 export * from "./types";

diff --git a/packages/ts-morph/src/structures/interface/CallSignatureDeclarationStructure.ts b/packages/ts-morph/src/structures/interface/CallSignatureDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { JSDocableNodeStructure, SignaturedDeclarationStructure, TypeParameteredNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface CallSignatureDeclarationStructure

diff --git a/packages/ts-morph/src/structures/interface/ConstructSignatureDeclarationStructure.ts b/packages/ts-morph/src/structures/interface/ConstructSignatureDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { JSDocableNodeStructure, SignaturedDeclarationStructure, TypeParameteredNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ConstructSignatureDeclarationStructure

diff --git a/packages/ts-morph/src/structures/interface/IndexSignatureDeclarationStructure.ts b/packages/ts-morph/src/structures/interface/IndexSignatureDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { JSDocableNodeStructure, ReadonlyableNodeStructure, ReturnTypedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface IndexSignatureDeclarationStructure

diff --git a/packages/ts-morph/src/structures/interface/InterfaceDeclarationStructure.ts b/packages/ts-morph/src/structures/interface/InterfaceDeclarationStructure.ts
@@ -7,7 +7,7 @@ import {
   TypeElementMemberedNodeStructure,
   TypeParameteredNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface InterfaceDeclarationStructure

diff --git a/packages/ts-morph/src/structures/interface/MethodSignatureStructure.ts b/packages/ts-morph/src/structures/interface/MethodSignatureStructure.ts
@@ -5,7 +5,7 @@ import {
   SignaturedDeclarationStructure,
   TypeParameteredNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface MethodSignatureStructure

diff --git a/packages/ts-morph/src/structures/interface/PropertySignatureStructure.ts b/packages/ts-morph/src/structures/interface/PropertySignatureStructure.ts
@@ -6,7 +6,7 @@ import {
   ReadonlyableNodeStructure,
   TypedNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface PropertySignatureStructure

diff --git a/packages/ts-morph/src/structures/jsx/JsxAttributeStructure.ts b/packages/ts-morph/src/structures/jsx/JsxAttributeStructure.ts
@@ -1,5 +1,5 @@
 import { NamedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface JsxAttributeStructure extends Structure, JsxAttributeSpecificStructure, NamedNodeStructure {

diff --git a/packages/ts-morph/src/structures/jsx/JsxElementStructure.ts b/packages/ts-morph/src/structures/jsx/JsxElementStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { JsxAttributeStructure } from "./JsxAttributeStructure";

diff --git a/packages/ts-morph/src/structures/jsx/JsxSelfClosingElementStructure.ts b/packages/ts-morph/src/structures/jsx/JsxSelfClosingElementStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { JsxAttributedNodeStructure, JsxTagNamedNodeStructure } from "./base";
 

diff --git a/packages/ts-morph/src/structures/jsx/JsxSpreadAttributeStructure.ts b/packages/ts-morph/src/structures/jsx/JsxSpreadAttributeStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface JsxSpreadAttributeStructure extends Structure, JsxSpreadAttributeSpecificStructure {

diff --git a/packages/ts-morph/src/structures/module/AssertEntryStructure.ts b/packages/ts-morph/src/structures/module/AssertEntryStructure.ts
@@ -1,5 +1,5 @@
 import { AssertionKeyNamedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface AssertEntryStructure extends Structure, AssertEntryStructureSpecificStructure, AssertionKeyNamedNodeStructure {

diff --git a/packages/ts-morph/src/structures/module/ExportAssignmentStructure.ts b/packages/ts-morph/src/structures/module/ExportAssignmentStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ExportAssignmentStructure extends Structure, ExportAssignmentSpecificStructure {

diff --git a/packages/ts-morph/src/structures/module/ExportDeclarationStructure.ts b/packages/ts-morph/src/structures/module/ExportDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { AssertEntryStructure } from "./AssertEntryStructure";

diff --git a/packages/ts-morph/src/structures/module/ExportSpecifierStructure.ts b/packages/ts-morph/src/structures/module/ExportSpecifierStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ExportSpecifierStructure extends Structure, ExportSpecifierSpecificStructure {

diff --git a/packages/ts-morph/src/structures/module/ImportDeclarationStructure.ts b/packages/ts-morph/src/structures/module/ImportDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { WriterFunction } from "../../types";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { AssertEntryStructure } from "./AssertEntryStructure";

diff --git a/packages/ts-morph/src/structures/module/ImportSpecifierStructure.ts b/packages/ts-morph/src/structures/module/ImportSpecifierStructure.ts
@@ -1,4 +1,4 @@
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ImportSpecifierStructure extends Structure, ImportSpecifierSpecificStructure {

diff --git a/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts b/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts
@@ -1,7 +1,7 @@
 import { ModuleDeclarationKind } from "../../compiler";
 import { AmbientableNodeStructure, ExportableNodeStructure, JSDocableNodeStructure, ModuleNamedNodeStructure } from "../base";
 import { StatementedNodeStructure } from "../statement";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface ModuleDeclarationStructure

diff --git a/packages/ts-morph/src/structures/module/SourceFileStructure.ts b/packages/ts-morph/src/structures/module/SourceFileStructure.ts
@@ -1,5 +1,5 @@
 import { StatementedNodeStructure } from "../statement";
-import { Structure } from "../Structure";
+import { Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface SourceFileStructure extends Structure, SourceFileSpecificStructure, StatementedNodeStructure {

diff --git a/packages/ts-morph/src/structures/statement/VariableDeclarationStructure.ts b/packages/ts-morph/src/structures/statement/VariableDeclarationStructure.ts
@@ -1,5 +1,5 @@
 import { BindingNamedNodeStructure, ExclamationTokenableNodeStructure, InitializerExpressionableNodeStructure, TypedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface VariableDeclarationStructure

diff --git a/packages/ts-morph/src/structures/statement/VariableStatementStructure.ts b/packages/ts-morph/src/structures/statement/VariableStatementStructure.ts
@@ -1,6 +1,6 @@
 import { VariableDeclarationKind } from "../../compiler";
 import { AmbientableNodeStructure, ExportableNodeStructure, JSDocableNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 import { OptionalKind } from "../types";
 import { VariableDeclarationStructure } from "./VariableDeclarationStructure";

diff --git a/packages/ts-morph/src/structures/type/TypeAliasDeclarationStructure.ts b/packages/ts-morph/src/structures/type/TypeAliasDeclarationStructure.ts
@@ -7,7 +7,7 @@ import {
   TypedNodeStructure,
   TypeParameteredNodeStructure,
 } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface TypeAliasDeclarationStructure

diff --git a/packages/ts-morph/src/structures/type/TypeParameterDeclarationStructure.ts b/packages/ts-morph/src/structures/type/TypeParameterDeclarationStructure.ts
@@ -1,6 +1,6 @@
 import { WriterFunction } from "../../types";
 import { NamedNodeStructure } from "../base";
-import { KindedStructure, Structure } from "../Structure";
+import { KindedStructure, Structure } from "../Structure.generated";
 import { StructureKind } from "../StructureKind";
 
 export interface TypeParameterDeclarationStructure extends Structure, TypeParameterDeclarationSpecificStructure, NamedNodeStructure {