Merge pull request #108 from SimplrJS/dev

v4.0.0-rc.4

Author: Martynas Žilinskas

examples/simple/index.ts

@@ -1,6 +1 @@
-/**
- * @private
- */
-export class Foo {
-    private privateFoo: string = "";
-}
+export const a = Symbol("Hello");

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-extractor",
-    "version": "4.0.0-rc.3",
+    "version": "4.0.0-rc.4",
     "description": "TypeScript AST extractor to useful JSON structure.",
     "keywords": [
         "typescript",
@@ -43,19 +43,19 @@
         "fs-extra": "^5.0.0",
         "read-package-json": "^2.0.12",
         "simplr-logger": "^1.0.1",
-        "typescript": "^2.6.2"
+        "typescript": "^2.7.1"
     },
     "devDependencies": {
         "@simplrjs/test-generator-cli": "^0.1.3",
         "@types/globby": "^6.1.0",
-        "@types/jest": "^21.1.9",
+        "@types/jest": "^22.1.1",
         "coveralls": "^3.0.0",
-        "jest": "^22.0.3",
+        "jest": "^22.1.4",
         "rimraf": "^2.6.2",
         "simplr-tslint": "0.0.1",
-        "ts-jest": "^22.0.0",
-        "ts-node": "^4.0.2",
-        "tslint": "^5.8.0"
+        "ts-jest": "^22.0.2",
+        "ts-node": "^4.1.0",
+        "tslint": "^5.9.1"
     },
     "files": [
         "dist",

package.json

@@ -31,7 +31,7 @@ export abstract class ApiItem<TDeclaration extends ts.Declaration = ts.Declarati
 
     public GetItemMetadata(): ApiMetadataDto {
         return {
-            DocumentationComment: ts.displayPartsToString(this.Symbol.getDocumentationComment()),
+            DocumentationComment: ts.displayPartsToString(this.Symbol.getDocumentationComment(this.TypeChecker)),
             JSDocTags: this.Symbol.getJsDocTags()
         };
     }

src/abstractions/api-item.ts

@@ -150,9 +150,19 @@ export namespace ApiTypeHelpers {
         type: ts.Type,
         typeNode: ts.TypeNode
     ): ApiBasicTypeDto {
+        const typeChecker = options.Program.getTypeChecker();
+        let text: string | undefined;
+        if (TsHelpers.IsNodeSynthesized(typeNode)) {
+            text = ts.tokenToString(typeNode.kind);
+        }
+        if (text == null) {
+            text = typeChecker.typeToString(type);
+        }
+
         return {
             ...typeNodeToBaseType(options, location, type, typeNode),
-            ApiTypeKind: ApiTypeKind.Basic
+            ApiTypeKind: ApiTypeKind.Basic,
+            Text: text
         };
     }
 
@@ -348,22 +358,32 @@ export namespace ApiTypeHelpers {
         typeNode: ts.TypeOperatorNode
     ): TypeOperatorTypeDto {
         const typeChecker = options.Program.getTypeChecker();
-        const apiType = ResolveApiType(options, location, typeChecker.getTypeFromTypeNode(typeNode.type), typeNode.type);
+        const apiType: ApiType = ResolveApiType(options, location, typeChecker.getTypeFromTypeNode(typeNode.type), typeNode.type);
+
+        let text = typeChecker.typeToString(type);
         let operator: TypeKeywords;
 
         switch (typeNode.operator) {
             case ts.SyntaxKind.KeyOfKeyword: {
                 operator = TypeKeywords.Keyof;
+                // Otherwise text will be union of keys.
+                text = `${operator} ${apiType.Text}`;
+                break;
+            }
+            case ts.SyntaxKind.UniqueKeyword: {
+                operator = TypeKeywords.Unique;
                 break;
             }
             default: {
+                ApiHelpers.LogWithLocation(
+                    LogLevel.Debug,
+                    location,
+                    `Unknown TypeOperator "${ts.SyntaxKind[typeNode.operator]}" keyword.`
+                );
                 operator = TypeKeywords.Unknown;
             }
         }
 
-        // Otherwise text will be union.
-        const text = `${operator} ${apiType.Text}`;
-
         return {
             ...typeNodeToBaseType(options, location, type, typeNode),
             ApiTypeKind: ApiTypeKind.TypeOperator,

src/api-type-helpers.ts

@@ -39,7 +39,8 @@ export enum ApiTypeKind {
 export enum TypeKeywords {
     Unknown = "???",
     Keyof = "keyof",
-    Typeof = "typeof"
+    Typeof = "typeof",
+    Unique = "unique"
 }
 
 export interface TypeScriptTypeNodeDebug {
@@ -155,7 +156,7 @@ export interface TypePredicateTypeDto extends ApiBaseType {
  */
 export interface TypeOperatorTypeDto extends ApiBaseType {
     ApiTypeKind: ApiTypeKind.TypeOperator;
-    Keyword: TypeKeywords.Keyof | TypeKeywords.Unknown;
+    Keyword: TypeKeywords.Keyof | TypeKeywords.Unique | TypeKeywords.Unknown;
     Type: ApiType;
 }
 

src/contracts/api-types.ts

@@ -73,9 +73,12 @@ export class Extractor {
         // Go through all given files.
         const rootFiles = program.getRootFileNames();
         rootFiles.forEach(fileName => {
-            const sourceFile: ts.SourceFile = program.getSourceFile(fileName);
-            const symbol = typeChecker.getSymbolAtLocation(sourceFile);
+            const sourceFile: ts.SourceFile | undefined = program.getSourceFile(fileName);
+            if (sourceFile == null) {
+                return;
+            }
 
+            const symbol = typeChecker.getSymbolAtLocation(sourceFile);
             if (symbol == null) {
                 Logger.Warn(`Source file "${fileName}" is skipped, because no exported members were found.`);
                 return;