@typedproject/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, writeTemplate, writeJson} = require("../write/write");
const {scanFiles, scanComponents} = require("../scan/scan");
const path = require("path");

const options = {
  components: path.join(__dirname, "..", "..", "components")
};

module.exports = {
  /**
   *
   */
  buildApi(config) {
    context.set(config);
    return (
      Promise.resolve()
        .then(() => context.readPkg())
        .then(() => scanComponents(options.components))
        .then(() => scanFiles(context.scanPatterns))
        .then(() => {
          let symbols = 0;
          context.symbols.forEach((symbol) => {
            const content = context.components.page(symbol);
            symbols++;
            return writeSymbol(symbol, content);
          });
          logger(chalk.green(symbols) + " symbols write");
        })
        // .then(() => writeTemplate(context.docsDir + '/**/*.{ejs,emd}'))
        .then(() => writeJson())
        .then(() => logger("done"))
        .catch((err) => console.error(err))
    );
  }
};