feat(flags): add isAsync flag for methods and functions (#92)

Adds a flag to methods and functions that declares if the object is modified with `async`. Closes #66.
buehler · Aug 31, 2018 · b21136a · b21136a
1 parent 617764d
commit b21136a
Show file tree

Hide file tree

Showing 13 changed files with 251 additions and 30 deletions.
diff --git a/src/declarations/Declaration.ts b/src/declarations/Declaration.ts
@@ -209,3 +209,20 @@ export interface StaticDeclaration extends Declaration {
      */
     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;
+}
diff --git a/src/declarations/FunctionDeclaration.ts b/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,

diff --git a/src/declarations/MethodDeclaration.ts b/src/declarations/MethodDeclaration.ts
@@ -1,5 +1,6 @@
 import {
     AbstractDeclaration,
+    AsyncDeclaration,
     CallableDeclaration,
     OptionalDeclaration,
     ScopedDeclaration,
@@ -22,6 +23,7 @@ import { VariableDeclaration } from './VariableDeclaration';
  */
 export class MethodDeclaration implements
     AbstractDeclaration,
+    AsyncDeclaration,
     CallableDeclaration,
     OptionalDeclaration,
     ScopedDeclaration,
@@ -38,6 +40,7 @@ export class MethodDeclaration implements
         public type: string | undefined,
         public isOptional: boolean,
         public isStatic: boolean,
+        public isAsync: boolean,
         public start?: number,
         public end?: number,
     ) { }

diff --git a/src/node-parser/class-parser.ts b/src/node-parser/class-parser.ts
@@ -204,6 +204,7 @@ export function parseClass(tsResource: Resource, node: ClassDeclaration): void {
                     getNodeType(o.type),
                     !!o.questionToken,
                     containsModifier(o, SyntaxKind.StaticKeyword),
+                    containsModifier(o, SyntaxKind.AsyncKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );

diff --git a/src/node-parser/function-parser.ts b/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;

diff --git a/src/node-parser/interface-parser.ts b/src/node-parser/interface-parser.ts
@@ -57,6 +57,7 @@ export function parseInterface(resource: Resource, node: InterfaceDeclaration):
                     getNodeType(o.type),
                     !!o.questionToken,
                     containsModifier(o, SyntaxKind.StaticKeyword),
+                    containsModifier(o, SyntaxKind.AsyncKeyword),
                     o.getStart(),
                     o.getEnd(),
                 );

diff --git a/test/__snapshots__/TypescriptParser.spec.ts.snap b/test/__snapshots__/TypescriptParser.spec.ts.snap
@@ -23,6 +23,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 203,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method1",
@@ -35,6 +36,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 237,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method2",
@@ -47,6 +49,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 300,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method3",
@@ -132,6 +135,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 55,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method1",
@@ -144,6 +148,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 100,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "abstractMethod",
@@ -259,6 +264,7 @@ Array [
   MethodDeclaration {
     "end": 1251,
     "isAbstract": false,
+    "isAsync": false,
     "isOptional": false,
     "isStatic": false,
     "name": "objMethod",
@@ -298,6 +304,7 @@ Array [
   MethodDeclaration {
     "end": 1307,
     "isAbstract": false,
+    "isAsync": false,
     "isOptional": false,
     "isStatic": false,
     "name": "arrMethod",
@@ -337,6 +344,7 @@ Array [
   MethodDeclaration {
     "end": 1386,
     "isAbstract": false,
+    "isAsync": false,
     "isOptional": false,
     "isStatic": false,
     "name": "objAndArrMethod",
@@ -478,6 +486,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 1621,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": true,
       "name": "method",
@@ -490,6 +499,7 @@ ClassDeclaration {
     MethodDeclaration {
       "end": 1660,
       "isAbstract": false,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "methodNonStatic",
@@ -546,6 +556,7 @@ EnumDeclaration {
 exports[`TypescriptParser Declaration parsing Functions should parse a function correctly 1`] = `
 FunctionDeclaration {
   "end": 84,
+  "isAsync": false,
   "isExported": false,
   "name": "function1",
   "parameters": Array [
@@ -574,6 +585,7 @@ FunctionDeclaration {
 exports[`TypescriptParser Declaration parsing Functions should parse an exported function correctly 1`] = `
 FunctionDeclaration {
   "end": 219,
+  "isAsync": false,
   "isExported": true,
   "name": "function2",
   "parameters": Array [
@@ -736,6 +748,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 93,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method1",
@@ -748,6 +761,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 128,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method2",
@@ -799,6 +813,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 247,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method1",
@@ -832,6 +847,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 284,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "method2",
@@ -897,6 +913,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 680,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": false,
       "isStatic": false,
       "name": "nonOptionalFunction2",
@@ -909,6 +926,7 @@ InterfaceDeclaration {
     MethodDeclaration {
       "end": 712,
       "isAbstract": true,
+      "isAsync": false,
       "isOptional": true,
       "isStatic": false,
       "name": "optionalFunction3",
@@ -990,6 +1008,7 @@ Module {
   "declarations": Array [
     FunctionDeclaration {
       "end": 62,
+      "isAsync": false,
       "isExported": true,
       "name": "modFunc",
       "parameters": Array [],
@@ -1273,6 +1292,7 @@ ObjectBoundParameterDeclaration {
 exports[`TypescriptParser Declaration parsing Parameters should parse some mixed parameters (all above) 1`] = `
 FunctionDeclaration {
   "end": 654,
+  "isAsync": false,
   "isExported": false,
   "name": "mixed",
   "parameters": Array [
@@ -1846,6 +1866,7 @@ File {
         MethodDeclaration {
           "end": 304,
           "isAbstract": false,
+          "isAsync": false,
           "isOptional": false,
           "isStatic": false,
           "name": "render",
@@ -1912,6 +1933,7 @@ Array [
           MethodDeclaration {
             "end": 304,
             "isAbstract": false,
+            "isAsync": false,
             "isOptional": false,
             "isStatic": false,
             "name": "render",
@@ -1978,6 +2000,7 @@ File {
         MethodDeclaration {
           "end": 304,
           "isAbstract": false,
+          "isAsync": false,
           "isOptional": false,
           "isStatic": false,
           "name": "render",
@@ -2052,6 +2075,7 @@ File {
         MethodDeclaration {
           "end": 93,
           "isAbstract": false,
+          "isAsync": false,
           "isOptional": false,
           "isStatic": false,
           "name": "doSomething",
@@ -2112,6 +2136,7 @@ Array [
           MethodDeclaration {
             "end": 93,
             "isAbstract": false,
+            "isAsync": false,
             "isOptional": false,
             "isStatic": false,
             "name": "doSomething",
@@ -2172,6 +2197,7 @@ File {
         MethodDeclaration {
           "end": 93,
           "isAbstract": false,
+          "isAsync": false,
           "isOptional": false,
           "isStatic": false,
           "name": "doSomething",
@@ -2273,6 +2299,7 @@ File {
         MethodDeclaration {
           "end": 142,
           "isAbstract": false,
+          "isAsync": false,
           "isOptional": false,
           "isStatic": false,
           "name": "test",

diff --git a/test/_workspace/typescript-parser/async.ts b/test/_workspace/typescript-parser/async.ts
@@ -0,0 +1,11 @@
+class Class1 {
+    public static async staticAsync() { }
+    public func(): void { }
+    public async asyncFunc(): Promise<void> { }
+    public async asyncFuncWithoutType() { }
+}
+
+function func(): void { }
+async function asyncFunc(): Promise<void> { }
+async function asyncFuncWithoutType() { }
+function promiseFunc(): Promise<void> { }