Merge pull request #96 from buehler/develop

Release

Author: buehler

jest.json

@@ -3,6 +3,7 @@
     "transform": {
         "^.+\\.tsx?$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
     },
+    "testURL": "http://localhost/",
     "testMatch": [
         "**/test/**/*.spec.ts"
     ],

package.json

@@ -36,23 +36,23 @@
   "homepage": "https://github.com/TypeScript-Heroes/node-typescript-parser#readme",
   "devDependencies": {
     "@smartive/tslint-config": "^4.0.0",
-    "@types/jest": "^23.1.4",
-    "@types/lodash-es": "^4.17.0",
+    "@types/jest": "^23.3.1",
+    "@types/lodash-es": "^4.17.1",
     "@types/mock-fs": "^3.6.30",
-    "@types/node": "^10.5.1",
+    "@types/node": "^10.9.4",
     "del-cli": "^1.1.0",
-    "jest": "^23.3.0",
-    "mock-fs": "^4.5.0",
-    "semantic-release": "^15.6.3",
-    "ts-jest": "^23.0.0",
-    "tslint": "^5.10.0",
-    "tsutils": "^2.27.2",
-    "typedoc": "^0.11.1"
+    "jest": "^23.5.0",
+    "mock-fs": "^4.6.0",
+    "semantic-release": "^15.9.12",
+    "ts-jest": "^23.1.4",
+    "tslint": "^5.11.0",
+    "tsutils": "^3.0.0",
+    "typedoc": "^0.12.0"
   },
   "dependencies": {
     "lodash": "^4.17.10",
     "lodash-es": "^4.17.10",
     "tslib": "^1.9.3",
-    "typescript": "^2.9.2"
+    "typescript": "^3.0.3"
   }
 }

src/code-generators/typescript-generators/propertyDeclaration.ts

@@ -16,5 +16,5 @@ export function generatePropertyDeclaration(
 ): string {
     return `${Array(tabSize + 1).join(' ')}` +
             `${property.visibility !== undefined ? getVisibilityText(property.visibility) + ' ' : ''}` +
-            `${property.name}${property.type ? `: ${property.type}` : ''};\n`;
+            `${property.name}${property.isOptional ? '?' : ''}${property.type ? `: ${property.type}` : ''};\n`;
 }

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,
     ) { }

src/declarations/Declaration.ts

@@ -175,3 +175,54 @@ export interface AbstractDeclaration extends Declaration {
      */
     isAbstract: boolean;
 }
+
+/**
+ * Interface for possible optional declarations. Contains information if the element is optional or not.
+ *
+ * @export
+ * @interface OptionalDeclaration
+ * @extends {Declaration}
+ */
+export interface OptionalDeclaration extends Declaration {
+    /**
+     * Defines if the declaration is optional or not.
+     *
+     * @type {boolean}
+     * @memberof OptionalDeclaration
+     */
+    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;
+}
+
+/**
+ * Interface for possible async declarations.
+ *
+ * @export
+ * @interface AsyncDeclaration
+ * @extends {Declaration}
+ */
+export interface AsyncDeclaration extends Declaration {
+    /**
+     * Defines if the declaration is async or not.
+     *
+     * @type {boolean}
+     * @memberof AsyncDeclaration
+     */
+    isAsync: boolean;
+}

src/declarations/FunctionDeclaration.ts

@@ -1,4 +1,4 @@
-import { CallableDeclaration, ExportableDeclaration } from './Declaration';
+import { AsyncDeclaration, CallableDeclaration, ExportableDeclaration } from './Declaration';
 import { ParameterDeclaration } from './ParameterDeclaration';
 import { VariableDeclaration } from './VariableDeclaration';
 
@@ -11,13 +11,14 @@ import { VariableDeclaration } from './VariableDeclaration';
  * @implements {CallableDeclaration}
  * @implements {ExportableDeclaration}
  */
-export class FunctionDeclaration implements CallableDeclaration, ExportableDeclaration {
+export class FunctionDeclaration implements AsyncDeclaration, CallableDeclaration, ExportableDeclaration {
     public parameters: ParameterDeclaration[] = [];
     public variables: VariableDeclaration[] = [];
 
     constructor(
         public name: string,
         public isExported: boolean,
+        public isAsync: boolean,
         public type?: string,
         public start?: number,
         public end?: number,

src/declarations/MethodDeclaration.ts

@@ -1,4 +1,12 @@
-import { AbstractDeclaration, CallableDeclaration, ScopedDeclaration, TypedDeclaration } from './Declaration';
+import {
+    AbstractDeclaration,
+    AsyncDeclaration,
+    CallableDeclaration,
+    OptionalDeclaration,
+    ScopedDeclaration,
+    StaticDeclaration,
+    TypedDeclaration,
+} from './Declaration';
 import { DeclarationVisibility } from './DeclarationVisibility';
 import { ParameterDeclaration } from './ParameterDeclaration';
 import { VariableDeclaration } from './VariableDeclaration';
@@ -13,7 +21,15 @@ import { VariableDeclaration } from './VariableDeclaration';
  * @implements {ScopedDeclaration}
  * @implements {TypedDeclaration}
  */
-export class MethodDeclaration implements AbstractDeclaration, CallableDeclaration, ScopedDeclaration, TypedDeclaration {
+export class MethodDeclaration implements
+    AbstractDeclaration,
+    AsyncDeclaration,
+    CallableDeclaration,
+    OptionalDeclaration,
+    ScopedDeclaration,
+    StaticDeclaration,
+    TypedDeclaration {
+
     public parameters: ParameterDeclaration[] = [];
     public variables: VariableDeclaration[] = [];
 
@@ -22,6 +38,9 @@ export class MethodDeclaration implements AbstractDeclaration, CallableDeclarati
         public isAbstract: boolean,
         public visibility: DeclarationVisibility | undefined,
         public type: string | undefined,
+        public isOptional: boolean,
+        public isStatic: boolean,
+        public isAsync: boolean,
         public start?: number,
         public end?: number,
     ) { }

src/declarations/PropertyDeclaration.ts

@@ -1,4 +1,4 @@
-import { ScopedDeclaration, TypedDeclaration } from './Declaration';
+import { OptionalDeclaration, ScopedDeclaration, StaticDeclaration, TypedDeclaration } from './Declaration';
 import { DeclarationVisibility } from './DeclarationVisibility';
 
 /**
@@ -9,11 +9,13 @@ import { DeclarationVisibility } from './DeclarationVisibility';
  * @implements {ScopedDeclaration}
  * @implements {TypedDeclaration}
  */
-export class PropertyDeclaration implements 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,
     ) { }

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,
@@ -88,6 +89,8 @@ export function parseCtorParams(
                     (o.name as Identifier).text,
                     getNodeVisibility(o),
                     getNodeType(o.type),
+                    !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
                     o.getStart(),
                     o.getEnd(),
                 ),
@@ -137,6 +140,8 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                             (o.name as Identifier).text,
                             getNodeVisibility(o),
                             getNodeType(o.type),
+                            !!o.questionToken,
+                            containsModifier(o, SyntaxKind.StaticKeyword),
                             o.getStart(),
                             o.getEnd(),
                         ),
@@ -148,6 +153,8 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                             (o.name as Identifier).text,
                             getNodeVisibility(o),
                             getNodeType(o.type),
+                            !!o.questionToken,
+                            containsModifier(o, SyntaxKind.StaticKeyword),
                             o.getStart(),
                             o.getEnd(),
                         ),
@@ -163,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(),
                     ),
@@ -176,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(),
                     ),
@@ -193,6 +202,9 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                     o.modifiers !== undefined && o.modifiers.some(m => m.kind === SyntaxKind.AbstractKeyword),
                     getNodeVisibility(o),
                     getNodeType(o.type),
+                    !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
+                    containsModifier(o, SyntaxKind.AsyncKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );

src/node-parser/function-parser.ts

@@ -30,7 +30,13 @@ import {
     isPropertySignature,
 } from '../type-guards/TypescriptGuards';
 import { parseIdentifier } from './identifier-parser';
-import { getDefaultResourceIdentifier, getNodeType, isNodeDefaultExported, isNodeExported } from './parse-utilities';
+import {
+    containsModifier,
+    getDefaultResourceIdentifier,
+    getNodeType,
+    isNodeDefaultExported,
+    isNodeExported,
+} from './parse-utilities';
 import { parseVariable } from './variable-parser';
 
 /**
@@ -137,7 +143,12 @@ export function parseMethodParams(
 export function parseFunction(resource: Resource, node: FunctionDeclaration): void {
     const name = node.name ? node.name.text : getDefaultResourceIdentifier(resource);
     const func = new TshFunction(
-        name, isNodeExported(node), getNodeType(node.type), node.getStart(), node.getEnd(),
+        name,
+        isNodeExported(node),
+        containsModifier(node, SyntaxKind.AsyncKeyword),
+        getNodeType(node.type),
+        node.getStart(),
+        node.getEnd(),
     );
     if (isNodeDefaultExported(node)) {
         func.isExported = false;

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.
@@ -37,6 +43,8 @@ export function parseInterface(resource: Resource, node: InterfaceDeclaration):
                         (o.name as Identifier).text,
                         DeclarationVisibility.Public,
                         getNodeType(o.type),
+                        !!o.questionToken,
+                        containsModifier(o, SyntaxKind.StaticKeyword),
                         o.getStart(),
                         o.getEnd(),
                     ),
@@ -47,6 +55,9 @@ export function parseInterface(resource: Resource, node: InterfaceDeclaration):
                     true,
                     DeclarationVisibility.Public,
                     getNodeType(o.type),
+                    !!o.questionToken,
+                    containsModifier(o, SyntaxKind.StaticKeyword),
+                    containsModifier(o, SyntaxKind.AsyncKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );

src/node-parser/parse-utilities.ts

@@ -1,4 +1,4 @@
-import { getCombinedModifierFlags, ModifierFlags, Node, SyntaxKind, TypeNode } from 'typescript';
+import { Declaration, getCombinedModifierFlags, ModifierFlags, Node, SyntaxKind, TypeNode } from 'typescript';
 
 import { DeclarationVisibility } from '../declarations/DeclarationVisibility';
 import { File } from '../resources/File';
@@ -13,7 +13,7 @@ import { Resource } from '../resources/Resource';
  * @returns {boolean}
  */
 export function isNodeExported(node: Node): boolean {
-    const flags = getCombinedModifierFlags(node);
+    const flags = getCombinedModifierFlags(node as Declaration);
     return (flags & ModifierFlags.Export) === ModifierFlags.Export;
 }
 
@@ -26,7 +26,7 @@ export function isNodeExported(node: Node): boolean {
  * @returns {boolean}
  */
 export function isNodeDefaultExported(node: Node): boolean {
-    const flags = getCombinedModifierFlags(node);
+    const flags = getCombinedModifierFlags(node as Declaration);
     return (flags & ModifierFlags.Default) === ModifierFlags.Default;
 }
 
@@ -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.
  *