gen-docs WIP

docs/_sidebar.md

@@ -2,10 +2,10 @@
   - [Installing](/docs/Installing)
   - [Working Locally](/docs/WorkingLocally)
   - [Usage](/docs/Usage)
-- API
+- Guide
   - [Top Level](/docs/top-level-api)
   - [Screen](/docs/screen-api)
-  - [Layout types](/docs/layout-types)
+  - [Layout Types](/docs/layout-types)
   - [Styling](/docs/styling)
 - Migration from v1
   - [Top Level](/docs/top-level-api-migration)

docs/api/Navigation.md

@@ -0,0 +1,188 @@
+# Navigation
+
+## Properties
+
+- Element (any)
+
+## Methods
+
+### `registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): void`
+
+[source](/lib/src//Navigation.ts#52)
+
+Every navigation component in your app must be registered with a unique name.
+The component itself is a traditional React component extending React.Component.
+
+#### Arguments
+- componentName (string)
+- getComponentClassFunc (ComponentProvider)
+
+#### Returns
+- (void)
+
+### `setRoot(layout: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#59)
+
+Reset the app to a new layout
+
+#### Arguments
+- layout (any)
+
+#### Returns
+- (Promise<any>)
+
+### `setDefaultOptions(options: any): void`
+
+[source](/lib/src//Navigation.ts#66)
+
+Set default options to all screens. Useful for declaring a consistent style across the app.
+
+#### Arguments
+- options (any)
+
+#### Returns
+- (void)
+
+### `mergeOptions(componentId: string, options: any): void`
+
+[source](/lib/src//Navigation.ts#73)
+
+Change a component's navigation options
+
+#### Arguments
+- componentId (string)
+- options (any)
+
+#### Returns
+- (void)
+
+### `showModal(layout: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#80)
+
+Show a screen as a modal.
+
+#### Arguments
+- layout (any)
+
+#### Returns
+- (Promise<any>)
+
+### `dismissModal(componentId: string): Promise<any>`
+
+[source](/lib/src//Navigation.ts#87)
+
+Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack.
+
+#### Arguments
+- componentId (string)
+
+#### Returns
+- (Promise<any>)
+
+### `dismissAllModals(): Promise<any>`
+
+[source](/lib/src//Navigation.ts#94)
+
+Dismiss all Modals
+
+#### Returns
+- (Promise<any>)
+
+### `push(componentId: string, layout: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#101)
+
+Push a new layout into this screen's navigation stack.
+
+#### Arguments
+- componentId (string)
+- layout (any)
+
+#### Returns
+- (Promise<any>)
+
+### `pop(componentId: string, params: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#108)
+
+Pop a component from the stack, regardless of it's position.
+
+#### Arguments
+- componentId (string)
+- params (any)
+
+#### Returns
+- (Promise<any>)
+
+### `popTo(componentId: string): Promise<any>`
+
+[source](/lib/src//Navigation.ts#115)
+
+Pop the stack to a given component
+
+#### Arguments
+- componentId (string)
+
+#### Returns
+- (Promise<any>)
+
+### `popToRoot(componentId: string): Promise<any>`
+
+[source](/lib/src//Navigation.ts#122)
+
+Pop the component's stack to root.
+
+#### Arguments
+- componentId (string)
+
+#### Returns
+- (Promise<any>)
+
+### `setStackRoot(componentId: string, layout: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#129)
+
+Sets new root component to stack.
+
+#### Arguments
+- componentId (string)
+- layout (any)
+
+#### Returns
+- (Promise<any>)
+
+### `showOverlay(layout: any): Promise<any>`
+
+[source](/lib/src//Navigation.ts#136)
+
+Show overlay on top of the entire app
+
+#### Arguments
+- layout (any)
+
+#### Returns
+- (Promise<any>)
+
+### `dismissOverlay(componentId: string): Promise<any>`
+
+[source](/lib/src//Navigation.ts#143)
+
+dismiss overlay by componentId
+
+#### Arguments
+- componentId (string)
+
+#### Returns
+- (Promise<any>)
+
+### `events(): EventsRegistry`
+
+[source](/lib/src//Navigation.ts#150)
+
+Obtain the events registry instance
+
+#### Returns
+- (EventsRegistry)
+

package.json

@@ -44,7 +44,7 @@
     "prerelease": "npm run build",
     "release": "node ./scripts/release",
     "local-docs": "node ./scripts/local-docs",
-    "gen-docs": "echo 'This is a work in progress'"
+    "gen-docs": "echo 'this is a work in progress!!!' && ts-node ./scripts/gen-docs/Main"
   },
   "peerDependencies": {
     "react": "*",

scripts/gen-doc.js

@@ -1,7 +0,0 @@
-const exec = require('shell-utils').exec;
-
-run();
-
-function run() {
-  exec.execSync(`ts-node `);
-}

scripts/gen-docs/Main.ts

@@ -0,0 +1,33 @@
+import * as fs from 'fs';
+import { ReflectionsReader } from './ReflectionsReader';
+import { MarkdownCreator } from './MarkdownCreator';
+import * as Handlebars from 'handlebars';
+
+const MD_RELATIVE_LINK = `/lib/src/`;
+const OUTPUT_DIR = `${__dirname}/../../docs/api`;
+const TEMPLATES_DIR = `${__dirname}/templates`;
+const TSCONFIG = JSON.parse(fs.readFileSync(`${__dirname}/../../tsconfig.json`).toString());
+
+class Main {
+  public run() {
+    const handlebarsFn = this.setupHandlebars();
+
+    const reflection = new ReflectionsReader(TSCONFIG).read('./lib/src/Navigation.ts');
+    const markdown = new MarkdownCreator(MD_RELATIVE_LINK, handlebarsFn).create(reflection);
+
+    fs.writeFileSync(`${OUTPUT_DIR}/Navigation.md`, markdown, { encoding: 'utf8' });
+  }
+
+  private setupHandlebars() {
+    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, noEscape: true });
+  }
+}
+
+new Main().run();

scripts/gen-doc/MarkdownCreator.ts → scripts/gen-docs/MarkdownCreator.ts

@@ -2,10 +2,8 @@ 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>) { }
+  constructor(private mdRelativeLinkPath: string, private handlebarsFn: HandlebarsTemplateDelegate<any>) { }
 
   public create(reflection: Typedoc.DeclarationReflection) {
     const context = {
@@ -25,7 +23,7 @@ export class MarkdownCreator {
       name: methodReflection.name,
       arguments: this.readArguments(methodReflection.signatures[0].parameters || []),
       returnType: methodReflection.signatures[0].type.toString(),
-      source: `/docs/api/${methodReflection.sources[0].fileName}#${methodReflection.sources[0].line}`,
+      source: `${this.mdRelativeLinkPath}/${methodReflection.sources[0].fileName}#${methodReflection.sources[0].line}`,
       comment: methodReflection.signatures[0].comment ? methodReflection.signatures[0].comment.shortText : ''
     }));
   }
@@ -44,13 +42,4 @@ export class MarkdownCreator {
       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 → scripts/gen-docs/ReflectionsReader.ts

@@ -4,6 +4,7 @@ const OPTIONS = {
   excludeExternals: true,
   excludePrivate: true,
   includeDeclarations: true,
+  mode: 'modules',
   module: 'commonjs',
   readme: 'none',
   target: 'ES6'
@@ -12,13 +13,14 @@ const OPTIONS = {
 export class ReflectionsReader {
   private typedocApp: Typedoc.Application;
 
-  constructor() {
-    this.typedocApp = new Typedoc.Application(OPTIONS);
+  constructor(tsconfig) {
+    this.typedocApp = new Typedoc.Application({ ...OPTIONS, ...tsconfig.compilerOptions });
   }
 
   public read(modulePath: string): Typedoc.DeclarationReflection {
     const expandedFiles = this.typedocApp.expandInputFiles([modulePath]);
     const projectReflection = this.typedocApp.convert(expandedFiles);
+    // console.log(JSON.stringify(this.typedocApp.serializer.projectToObject(projectReflection)));
     const externalModule = projectReflection.getChildrenByKind(Typedoc.ReflectionKind.ExternalModule)[0];
     const classReflection = externalModule.getChildrenByKind(Typedoc.ReflectionKind.Class)[0];
     return classReflection;