copied all work from typedoc-markdown-creator

package.json

@@ -73,7 +73,10 @@
     "semver": "5.x.x",
     "shell-utils": "1.x.x",
     "tslint": "5.x.x",
-    "typescript": "2.7.x"
+    "typescript": "2.7.x",
+    "typedoc": "0.x.x",
+    "handlebars": "4.x.x",
+    "ts-node": "5.x.x"
   },
   "babel": {
     "env": {

scripts/gen-doc/MarkdownCreator.ts

@@ -0,0 +1,54 @@
+import * as Handlebars from 'handlebars';
+import * as Typedoc from 'typedoc';
+import * as fs from 'fs';
+
+const TEMPLATES_DIR = `./src/templates`;
+
+export class MarkdownCreator {
+  constructor(private handlebarsFn: HandlebarsTemplateDelegate<any>) { }
+
+  public create(reflection: Typedoc.DeclarationReflection) {
+    const context = {
+      name: reflection.name,
+      properties: this.readProperties(reflection),
+      methods: this.readMethods(reflection)
+    };
+    return this.handlebarsFn(context);
+  }
+
+  private readMethods(reflection: Typedoc.DeclarationReflection) {
+    const methodReflections = reflection.getChildrenByKind(Typedoc.ReflectionKind.Method);
+    methodReflections.sort((a, b) => a.sources[0].line - b.sources[0].line);
+    return methodReflections.map((methodReflection) => ({
+      name: methodReflection.name,
+      arguments: this.readArguments(methodReflection.signatures[0].parameters || []),
+      returnType: methodReflection.signatures[0].type.toString(),
+      source: `${methodReflection.sources[0].fileName}#${methodReflection.sources[0].line}`,
+      comment: methodReflection.signatures[0].comment ? methodReflection.signatures[0].comment.shortText : ''
+    }));
+  }
+
+  private readArguments(parameters: Typedoc.ParameterReflection[]) {
+    return parameters.map((parameter) => ({
+      name: parameter.name,
+      type: parameter.type.toString()
+    }));
+  }
+
+  private readProperties(reflection: Typedoc.DeclarationReflection) {
+    const propsReflections = reflection.getChildrenByKind(Typedoc.ReflectionKind.Property);
+    return propsReflections.map((propReflection) => ({
+      name: propReflection.name,
+      type: propReflection.type.toString()
+    }));
+  }
+
+  private setupTemplates() {
+    const mainTemplate = fs.readFileSync(`${TEMPLATES_DIR}/main.hbs`).toString();
+    const classTemplate = fs.readFileSync(`${TEMPLATES_DIR}/class.hbs`).toString();
+    const methodTemplate = fs.readFileSync(`${TEMPLATES_DIR}/method.hbs`).toString();
+    Handlebars.registerPartial('class', classTemplate);
+    Handlebars.registerPartial('method', methodTemplate);
+    return Handlebars.compile(mainTemplate, { strict: true });
+  }
+}

scripts/gen-doc/ReflectionsReader.ts

@@ -0,0 +1,26 @@
+import * as Typedoc from 'typedoc';
+
+const OPTIONS = {
+  excludeExternals: true,
+  excludePrivate: true,
+  includeDeclarations: true,
+  module: 'commonjs',
+  readme: 'none',
+  target: 'ES6'
+};
+
+export class ReflectionsReader {
+  private typedocApp: Typedoc.Application;
+
+  constructor() {
+    this.typedocApp = new Typedoc.Application(OPTIONS);
+  }
+
+  public read(modulePath: string): Typedoc.DeclarationReflection {
+    const expandedFiles = this.typedocApp.expandInputFiles([modulePath]);
+    const projectReflection = this.typedocApp.convert(expandedFiles);
+    const externalModule = projectReflection.getChildrenByKind(Typedoc.ReflectionKind.ExternalModule)[0];
+    const classReflection = externalModule.getChildrenByKind(Typedoc.ReflectionKind.Class)[0];
+    return classReflection;
+  }
+}

scripts/gen-doc/templates/class.hbs

@@ -0,0 +1,17 @@
+# {{name}}
+
+{{#if properties}}
+## Properties
+
+{{#each properties}}
+- {{name}} ({{type}})
+{{/each}}
+
+{{/if}}
+{{#if methods}}
+## Methods
+
+{{#each methods}}
+{{> method}}
+{{/each}}
+{{/if}}

scripts/gen-doc/templates/main.hbs

@@ -0,0 +1 @@
+{{> class}}

scripts/gen-doc/templates/method.hbs

@@ -0,0 +1,18 @@
+### `{{name}}({{#each arguments}}{{name}}: {{type}}{{#unless @last}}, {{/unless}}{{/each}}): {{returnType}}`
+
+[source]({{source}})
+
+{{#if comment}}
+{{comment}}
+
+{{/if}}
+{{#if arguments}}
+#### Arguments
+{{#each arguments}}
+- {{name}} ({{type}})
+{{/each}}
+
+{{/if}}
+#### Returns
+- ({{returnType}})
+