taiko/lib/documentation.js

Taiko is a Node.js library for automating Chromium based browsers

const fs = require("node:fs");

const jsDocToJson = async (sourceFiles, outputFile) => {
  try {
    const documentation = await import("documentation");
    documentation
      .build(sourceFiles, { shallow: true })
      .then(documentation.formats.json)
      .then((output) => {
        // output is a string of JSON data
        fs.writeFileSync(outputFile, output);
      });
  } catch (error) {
    console.error("Failed to load `documentation`:", error);
  }
};

module.exports.jsDocToJson = jsDocToJson;

/** isRunDirectlyFromTheCommandLine
 *  true - if this module was run directly from the command line as in `node documentation.js`
 *  false - if it is imported by another module
 */
const isRunDirectlyFromTheCommandLine = require.main === module;

if (isRunDirectlyFromTheCommandLine && !process.env.TAIKO_SKIP_DOCUMENTATION) {
  const sourceFiles = ["lib/taiko.js", "lib/elementWrapper/*.js"];
  const outputFile = "lib/api.json";
  jsDocToJson(sourceFiles, outputFile);
}