Feature: Cli (#31)

Author: Martynas Žilinskas

common/config/rush/npm-shrinkwrap.json

@@ -0,0 +1,3 @@
+{
+    "entryFile": "./src/index.ts"
+}

packages/ts-docs-gen/docs-gen.json

@@ -17,10 +17,12 @@
   "dependencies": {
     "@simplrjs/markdown": "^1.1.0",
     "@types/fs-extra": "^5.0.0",
+    "@types/yargs": "^10.0.1",
     "fs-extra": "^5.0.0",
     "simplr-logger": "^1.0.1",
     "ts-extractor": "^4.0.0-beta.8",
-    "typescript": "^2.6.2"
+    "typescript": "^2.6.2",
+    "yargs": "^11.0.0"
   },
   "devDependencies": {
     "@simplrjs/test-generator-cli": "^0.1.3",
@@ -32,6 +34,7 @@
     "ts-jest": "^22.0.1",
     "tslint": "^5.9.1"
   },
+  "bin": "./dist/cli/launcher.js",
   "jest": {
     "collectCoverage": true,
     "mapCoverage": true,

packages/ts-docs-gen/package.json

@@ -8,6 +8,12 @@ import { ApiTypes } from "../api-items/api-type-list";
 import { ReferenceRenderHandler } from "../contracts/serialized-api-item";
 
 export abstract class BasePlugin<TKind extends Contracts.ApiBaseDefinition = Contracts.ApiDefinition> implements Plugin<TKind> {
+    /**
+     * Used to identify class as Plugin.
+     */
+    // tslint:disable-next-line:no-empty
+    public static TsDocsGenPlugin(): void { }
+
     public abstract SupportedApiDefinitionKind(): SupportedApiItemKindType[];
 
     public CheckApiItem(item: TKind): boolean {

packages/ts-docs-gen/src/abstractions/base-plugin.ts

@@ -82,6 +82,7 @@ export abstract class ContainerPlugin<TKind extends ApiContainer> extends BasePl
                     } else {
                         switch (member.ApiItem.ApiKind) {
                             case Contracts.ApiDefinitionKind.Namespace:
+                            case Contracts.ApiDefinitionKind.ImportNamespace:
                             case Contracts.ApiDefinitionKind.Class: {
                                 const renderedItem = pluginOptions.GetItemPluginResult(member.Reference);
                                 pluginResultData.Members.push({

packages/ts-docs-gen/src/abstractions/container-plugin.ts

@@ -67,8 +67,13 @@ export abstract class ApiCallable<TKind extends Contracts.ApiCallableBaseDefinit
         const parametersString = this.ParametersToString(render);
 
         // ReturnType
-        const type = this.SerializedTypeToString(render, this.ReturnType);
-        const returnTypeString = typeDefChar !== "" && type != null ? `${typeDefChar}${type}` : "";
+        let returnTypeString: string;
+        if (typeDefChar !== "" && this.ReturnType != null) {
+            const type = this.SerializedTypeToString(render, this.ReturnType);
+            returnTypeString = `${typeDefChar}${type}`;
+        } else {
+            returnTypeString = "";
+        }
 
         return `${typeParametersString}(${parametersString})${returnTypeString}`;
     }

packages/ts-docs-gen/src/api-items/api-callable.ts

@@ -4,8 +4,7 @@ import { BaseApiItemClass } from "../abstractions/base-api-item";
 import { ApiItemReference } from "../contracts/api-item-reference";
 import { GeneratorHelpers } from "../generator-helpers";
 
-// Because of circular dependency we had to
-// implement interface and not extend ApiDefinitionBase.
+// Because of circular dependency we had to implement interface and not extend ApiDefinitionBase.
 export class ApiDefinitionDefault<TKind extends Contracts.ApiBaseDefinition = Contracts.ApiBaseDefinition>
     extends BaseApiItemClass<TKind> implements SerializedApiDefinition<TKind> {
 
@@ -37,10 +36,6 @@ export class ApiDefinitionDefault<TKind extends Contracts.ApiBaseDefinition = Co
         return this.ApiItem.Name;
     }
 
-    public get ApiItem(): TKind {
-        return this.ApiItem;
-    }
-
     public ToText(render: ReferenceRenderHandler = this.DefaultReferenceRenderer): string[] {
         return [this.Name];
     }

packages/ts-docs-gen/src/api-items/api-definition-default.ts

@@ -27,6 +27,32 @@ import { ApiClassProperty } from "./definitions/api-class-property";
 import { ApiClassMethod } from "./definitions/api-class-method";
 import { ApiAccessor } from "./definitions/api-accessor";
 
+export {
+    ApiSourceFile,
+    ApiCall,
+    ApiClass,
+    ApiConstruct,
+    ApiEnum,
+    ApiEnumMember,
+    ApiFunction,
+    ApiFunctionExpression,
+    ApiIndex,
+    ApiInterface,
+    ApiMapped,
+    ApiMethod,
+    ApiNamespace,
+    ApiParameter,
+    ApiProperty,
+    ApiTypeAlias,
+    ApiTypeParameter,
+    ApiVariable,
+    ApiTypeLiteral,
+    ApiClassConstructor,
+    ApiClassProperty,
+    ApiClassMethod,
+    ApiAccessor
+};
+
 export type ApiDefinitions = ApiDefinitionDefault |
     ApiSourceFile |
     ApiEnum |

packages/ts-docs-gen/src/api-items/api-definition-list.ts

@@ -15,6 +15,20 @@ import { ApiIndexedAccess } from "./types/api-type-indexed-access";
 import { ApiTypeParenthesized } from "./types/api-type-parenthesized";
 import { ApiTypeQuery } from "./types/api-type-query";
 
+export {
+    ApiTypeBasic,
+    ApiTypeReference,
+    ApiTypeUnionOrIntersection,
+    ApiTypeArray,
+    ApiTypeTuple,
+    ApiTypeDefinition,
+    ApiTypePredicate,
+    ApiTypeOperator,
+    ApiIndexedAccess,
+    ApiTypeParenthesized,
+    ApiTypeQuery
+};
+
 export type ApiTypes = ApiTypeDefault |
     ApiTypeBasic |
     ApiTypeReference |