feat(flags): isStatic (#91)

buehler · web-flow · commit 617764dc1632 · 2018-08-28T07:41:49.000+02:00
Add isStatic flag to various declarations
diff --git a/src/declarations/AccessorDeclaration.ts b/src/declarations/AccessorDeclaration.ts
@@ -1,4 +1,4 @@
-import { AbstractDeclaration, ScopedDeclaration, TypedDeclaration } from './Declaration';
+import { AbstractDeclaration, ScopedDeclaration, StaticDeclaration, TypedDeclaration } from './Declaration';
 import { DeclarationVisibility } from './DeclarationVisibility';
 
 /**
@@ -11,12 +11,17 @@ import { DeclarationVisibility } from './DeclarationVisibility';
  * @implements {TypedDeclaration}
  * @implements {AbstractDeclaration}
  */
-export abstract class AccessorDeclaration implements ScopedDeclaration, TypedDeclaration, AbstractDeclaration {
+export abstract class AccessorDeclaration implements
+    ScopedDeclaration,
+    StaticDeclaration,
+    TypedDeclaration,
+    AbstractDeclaration {
     constructor(
         public name: string,
         public visibility: DeclarationVisibility | undefined,
         public type: string | undefined,
         public isAbstract: boolean,
+        public isStatic: boolean,
         public start?: number,
         public end?: number,
     ) { }
diff --git a/src/declarations/Declaration.ts b/src/declarations/Declaration.ts
@@ -192,3 +192,20 @@ export interface OptionalDeclaration extends Declaration {
      */
     isOptional: boolean;
 }
+
+/**
+ * Interface for possible static declarations.
+ *
+ * @export
+ * @interface StaticDeclaration
+ * @extends {Declaration}
+ */
+export interface StaticDeclaration extends Declaration {
+    /**
+     * Defines if the declaration is static or not.
+     *
+     * @type {boolean}
+     * @memberof StaticDeclaration
+     */
+    isStatic: boolean;
+}
diff --git a/src/declarations/MethodDeclaration.ts b/src/declarations/MethodDeclaration.ts
@@ -3,6 +3,7 @@ import {
     CallableDeclaration,
     OptionalDeclaration,
     ScopedDeclaration,
+    StaticDeclaration,
     TypedDeclaration,
 } from './Declaration';
 import { DeclarationVisibility } from './DeclarationVisibility';
@@ -24,6 +25,7 @@ export class MethodDeclaration implements
     CallableDeclaration,
     OptionalDeclaration,
     ScopedDeclaration,
+    StaticDeclaration,
     TypedDeclaration {
 
     public parameters: ParameterDeclaration[] = [];
@@ -35,6 +37,7 @@ export class MethodDeclaration implements
         public visibility: DeclarationVisibility | undefined,
         public type: string | undefined,
         public isOptional: boolean,
+        public isStatic: boolean,
         public start?: number,
         public end?: number,
     ) { }
diff --git a/src/declarations/PropertyDeclaration.ts b/src/declarations/PropertyDeclaration.ts
@@ -1,4 +1,4 @@
-import { OptionalDeclaration, ScopedDeclaration, TypedDeclaration } from './Declaration';
+import { OptionalDeclaration, ScopedDeclaration, StaticDeclaration, TypedDeclaration } from './Declaration';
 import { DeclarationVisibility } from './DeclarationVisibility';
 
 /**
@@ -9,12 +9,13 @@ import { DeclarationVisibility } from './DeclarationVisibility';
  * @implements {ScopedDeclaration}
  * @implements {TypedDeclaration}
  */
-export class PropertyDeclaration implements OptionalDeclaration, ScopedDeclaration, TypedDeclaration {
+export class PropertyDeclaration implements OptionalDeclaration, ScopedDeclaration, StaticDeclaration, TypedDeclaration {
     constructor(
         public name: string,
         public visibility: DeclarationVisibility | undefined,
         public type: string | undefined,
         public isOptional: boolean,
+        public isStatic: boolean,
         public start?: number,
         public end?: number,
     ) { }
diff --git a/src/node-parser/class-parser.ts b/src/node-parser/class-parser.ts
@@ -29,6 +29,7 @@ import {
 import { parseFunctionParts, parseMethodParams } from './function-parser';
 import { parseIdentifier } from './identifier-parser';
 import {
+    containsModifier,
     getDefaultResourceIdentifier,
     getNodeType,
     getNodeVisibility,
@@ -89,6 +90,7 @@ export function parseCtorParams(
                     getNodeVisibility(o),
                     getNodeType(o.type),
                     !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
                     o.getStart(),
                     o.getEnd(),
                 ),
@@ -139,6 +141,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                             getNodeVisibility(o),
                             getNodeType(o.type),
                             !!o.questionToken,
+                            containsModifier(o, SyntaxKind.StaticKeyword),
                             o.getStart(),
                             o.getEnd(),
                         ),
@@ -151,6 +154,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                             getNodeVisibility(o),
                             getNodeType(o.type),
                             !!o.questionToken,
+                            containsModifier(o, SyntaxKind.StaticKeyword),
                             o.getStart(),
                             o.getEnd(),
                         ),
@@ -166,6 +170,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                         getNodeVisibility(o),
                         getNodeType(o.type),
                         o.modifiers !== undefined && o.modifiers.some(m => m.kind === SyntaxKind.AbstractKeyword),
+                        containsModifier(o, SyntaxKind.StaticKeyword),
                         o.getStart(),
                         o.getEnd(),
                     ),
@@ -179,6 +184,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                         getNodeVisibility(o),
                         getNodeType(o.type),
                         o.modifiers !== undefined && o.modifiers.some(m => m.kind === SyntaxKind.AbstractKeyword),
+                        containsModifier(o, SyntaxKind.StaticKeyword),
                         o.getStart(),
                         o.getEnd(),
                     ),
@@ -197,6 +203,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                     getNodeVisibility(o),
                     getNodeType(o.type),
                     !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );
diff --git a/src/node-parser/interface-parser.ts b/src/node-parser/interface-parser.ts
@@ -1,4 +1,4 @@
-import { Identifier, InterfaceDeclaration } from 'typescript';
+import { Identifier, InterfaceDeclaration, SyntaxKind } from 'typescript';
 
 import { DeclarationVisibility } from '../declarations/DeclarationVisibility';
 import { DefaultDeclaration } from '../declarations/DefaultDeclaration';
@@ -8,7 +8,13 @@ import { PropertyDeclaration } from '../declarations/PropertyDeclaration';
 import { Resource } from '../resources/Resource';
 import { isMethodSignature, isPropertySignature } from '../type-guards/TypescriptGuards';
 import { parseMethodParams } from './function-parser';
-import { getDefaultResourceIdentifier, getNodeType, isNodeDefaultExported, isNodeExported } from './parse-utilities';
+import {
+    containsModifier,
+    getDefaultResourceIdentifier,
+    getNodeType,
+    isNodeDefaultExported,
+    isNodeExported,
+} from './parse-utilities';
 
 /**
  * Parses an interface node into its declaration.
@@ -38,6 +44,7 @@ export function parseInterface(resource: Resource, node: InterfaceDeclaration):
                         DeclarationVisibility.Public,
                         getNodeType(o.type),
                         !!o.questionToken,
+                        containsModifier(o, SyntaxKind.StaticKeyword),
                         o.getStart(),
                         o.getEnd(),
                     ),
@@ -49,6 +56,7 @@ export function parseInterface(resource: Resource, node: InterfaceDeclaration):
                     DeclarationVisibility.Public,
                     getNodeType(o.type),
                     !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );
diff --git a/src/node-parser/parse-utilities.ts b/src/node-parser/parse-utilities.ts
@@ -41,6 +41,19 @@ export function getNodeType(node: TypeNode | undefined): string | undefined {
     return node ? node.getText() : undefined;
 }
 
+/**
+ * Checks if a node contains a certain modifier (of a given kind)
+ *
+ * @export
+ * @param {Node} node
+ * @param {SyntaxKind} modifierKind
+ * @returns {boolean}
+ */
+export function containsModifier(node: Node, modifierKind: SyntaxKind): boolean {
+    if (!node.modifiers) return false;
+    return node.modifiers.some(mod => mod.kind === modifierKind);
+}
+
 /**
  * Returns the enum value (visibility) of a node.
  *
diff --git a/test/TypescriptParser.spec.ts b/test/TypescriptParser.spec.ts
@@ -460,7 +460,7 @@ describe('TypescriptParser', () => {
             });
 
             it('should parse a file', () => {
-                expect(parsed.declarations).toHaveLength(9);
+                expect(parsed.declarations).toHaveLength(10);
             });
 
             it('should parse an abstract class', () => {
@@ -547,6 +547,12 @@ describe('TypescriptParser', () => {
                 expect(parsedClass.properties).toMatchSnapshot();
             });
 
+            it('should parse static class properties and methods', () => {
+                const parsedClass = parsed.declarations[9] as ClassDeclaration;
+
+                expect(parsedClass).toMatchSnapshot();
+            });
+
         });
 
         describe('Modules', () => {
diff --git a/test/__snapshots__/TypescriptParser.spec.ts.snap b/test/__snapshots__/TypescriptParser.spec.ts.snap
diff --git a/test/_workspace/typescript-parser/class.ts b/test/_workspace/typescript-parser/class.ts
diff --git a/test/declaration-index/__snapshots__/DeclarationIndex.spec.ts.snap b/test/declaration-index/__snapshots__/DeclarationIndex.spec.ts.snap
diff --git a/test/declaration-index/specific-cases/reindex-with-global-module/__snapshots__/DeclarationIndex.reindex-with-global-module-export.spec.ts.snap b/test/declaration-index/specific-cases/reindex-with-global-module/__snapshots__/DeclarationIndex.reindex-with-global-module-export.spec.ts.snap
