type2docfx/src/tocGenerator.ts

A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.

import { YamlModel } from './interfaces/YamlModel';
import { TocItem } from './interfaces/TocItem';
import { flags } from './common/flags';

export function generateToc(elements: YamlModel[], packageUid: string): TocItem[] {
    let result: TocItem[] = [];
    let previousUid: string = null;
    if (elements) {
        let tocs = elements;
        if (flags.enableAlphabetOrder) {
            tocs  = elements.sort(sortToc);
        }
        let dictModuleName: { [key: string]: TocItem } = {};
        tocs.forEach(element => {
            if (element.uid.indexOf('constructor') >= 0 || element.uid === previousUid) {
                return;
            }
            previousUid = element.uid;

            if (flags.hasModule) {
                let secondLevelToc: TocItem = {
                    uid: element.uid,
                    name: element.name.split('(')[0],
                    items: []
                };
                if (element.module) {
                    if (!dictModuleName[element.module]) {
                        dictModuleName[element.module] = {
                            uid: `${element.package}.${element.module.replace(/\//g, '.')}`,
                            name: element.module,
                            items: []
                        };
                        result.push(dictModuleName[element.module]);
                    }
                    dictModuleName[element.module].items.push(secondLevelToc);
                } else {
                    result.push(secondLevelToc);
                }
            } else {
                result.push({
                    uid: element.uid,
                    name: element.name.split('(')[0],
                    items: []
                });
            }
        });
    }
    return [{
        uid: packageUid,
        name: packageUid,
        items: result
    }];
}

function sortToc(a: YamlModel, b: YamlModel) {
    if (!a.module && b.module) {
        return 1;
    }

    if (a.module && !b.module) {
        return -1;
    }

    if (a.module && b.module) {
        let moduleNameA = a.module.toUpperCase();
        let moduleNameB = b.module.toUpperCase();
        if (moduleNameA < moduleNameB) {
          return -1;
        }
        if (moduleNameA > moduleNameB) {
          return 1;
        }
    }

    let nameA = a.name.toUpperCase();
    let nameB = b.name.toUpperCase();
    if (nameA < nameB) {
      return -1;
    }
    if (nameA > nameB) {
      return 1;
    }

    return 0;
}