@tsed/ts-doc/src/tasks/build-api.js

Generate documentation in markdown for TypeScript API

"use strict";
const logger = require("fancy-log");
const chalk = require("chalk");
const {context} = require("../context");
const {writeSymbol, writeJson} = require("../write/write");
const {scanFiles, scanComponents} = require("../scan/scan");

module.exports = {
  /**
   *
   */
  buildApi(config) {
    context.set(config);
    return Promise.resolve()
      .then(() => context.readPkg())
      .then(() => scanComponents(context.templatesDir))
      .then(() => scanFiles(context.scanPatterns))
      .then(async () => {
        let symbols = 0;

        await Promise.all(
          context.symbols
            .toArray()
            .filter((symbol) => symbol.skip !== true)
            .map((symbol) => {
              const content = context.components.page(symbol);
              symbols++;
              return writeSymbol(symbol, content);
            })
        );

        logger(chalk.green(symbols) + " symbols write");
      })
      .then(() => writeJson())
      .then(() => logger("done"))
      .catch((err) => console.error(err));
  }
};