refactor reflectionsReader

scripts/gen-docs/Main.ts

@@ -14,16 +14,9 @@ class Main {
   public run() {
     const classParser = new ClassParser(SOURCE_LINK_PREFIX);
     const markdownWriter = new MarkdownWriter(TEMPLATES_DIR, OUTPUT_DIR);
-    const projectReflections = new ReflectionsReader(TSCONFIG_PATH).read(INPUT_DIR);
+    const reflections = new ReflectionsReader(TSCONFIG_PATH).read(INPUT_DIR);
 
-    const externalModules = projectReflections.getChildrenByKind(ReflectionKind.ExternalModule)
-      .filter((m) => !m.name.endsWith('.mock"') && !m.name.endsWith('.test"'));
-
-    const classReflections = externalModules.filter((m) => m.getChildrenByKind(ReflectionKind.Class).length === 1)
-      .map((m) => m.getChildrenByKind(ReflectionKind.Class)[0]);
-    // just class modules, TODO: extract interfaces and types to their own modules, generate docs for interfaces and types
-
-    const parsedClasses = classReflections.map((c) => classParser.parseClass(c));
+    const parsedClasses = reflections.classReflections.map((c) => classParser.parseClass(c));
     markdownWriter.writeClasses(parsedClasses);
     markdownWriter.writeMenu(parsedClasses);
   }

scripts/gen-docs/ReflectionsReader.ts

@@ -1,6 +1,5 @@
-import * as Typedoc from 'typedoc';
-import { OptionsReadMode } from 'typedoc/dist/lib/utils/options';
 import * as fs from 'fs';
+import { ReflectionKind, ProjectReflection, DeclarationReflection, Application } from 'typedoc';
 
 const OPTIONS = {
   excludeExternals: true,
@@ -12,18 +11,39 @@ const OPTIONS = {
   target: 'ES6'
 };
 
+export interface Reflections {
+  classReflections: DeclarationReflection[];
+}
+
 export class ReflectionsReader {
-  private typedocApp: Typedoc.Application;
+  private typedocApp: Application;
 
   constructor(tsconfigPath) {
     const tsconfig = JSON.parse(fs.readFileSync(tsconfigPath).toString());
-    this.typedocApp = new Typedoc.Application({ ...OPTIONS, ...tsconfig.compilerOptions });
+    this.typedocApp = new Application({ ...OPTIONS, ...tsconfig.compilerOptions });
   }
 
-  public read(rootPath: string): Typedoc.ProjectReflection {
+  // just class modules, TODO: extract interfaces and types to their own modules, generate docs for interfaces and types
+  public read(rootPath: string): Reflections {
     const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
     const projectReflection = this.typedocApp.convert(expandedFiles);
     // console.log(JSON.stringify(this.typedocApp.serializer.projectToObject(projectReflection)));
-    return projectReflection;
+
+    const externalModules = this.externalModulesWithoutTestsAndMocks(projectReflection);
+    const classReflections = this.classReflections(externalModules);
+
+    return {
+      classReflections
+    };
+  }
+
+  private externalModulesWithoutTestsAndMocks(projectReflection: ProjectReflection): DeclarationReflection[] {
+    return projectReflection.getChildrenByKind(ReflectionKind.ExternalModule)
+      .filter((m) => !m.name.endsWith('.mock"') && !m.name.endsWith('.test"'));
+  }
+
+  private classReflections(externalModules: DeclarationReflection[]): DeclarationReflection[] {
+    return externalModules.filter((m) => m.getChildrenByKind(ReflectionKind.Class).length === 1)
+      .map((m) => m.getChildrenByKind(ReflectionKind.Class)[0]);
   }
 }