Function renderFile

scripts/website.js:464–593

* Render a given file with the given options * @param {String} filename The documentation file path to render * @param {import("../docs/source/index").DocsOptions} options The options to use to render the file (api may be overwritten at reload) * @param {Boolean} isReload Indicate this is a reloa

(filename, options, isReload = false)

 * @returns
 */
async function renderFile(filename, options, isReload = false) {
  /** Path for the output file */
  let newfile = undefined;
  options = options || {};
  options.package = pkg;
  let markdownSource = null;

  const _editLink = 'https://github.com/Automattic/mongoose/edit/master' +
    filename.replace(cwd, '');
  options.editLink = options.editLink || _editLink;

  /** Set which path to read, also pug uses this to resolve relative includes from */
  let inputFile = filename;

  if (options.api) {
    // only re-parse the api file when in a reload, because it is done once at file load
    if (isReload) {
      apiReq.parseFile(options.file);
      // overwrite original options because of reload
      options = { ...options, ...apiReq.docs.get(options.file) };
    }
    inputFile = path.resolve(cwd, 'docs/api_split.pug');
  }

  if (options.apiMarkdown) {
    newfile = path.resolve(cwd, filename);
    const str = options.markdownSource;
    if (typeof str !== 'string') {
      throw new Error(`No markdown source found for API page "${filename}"`);
    }

    if (versionObj.versionedDeploy) {
      const versionedMarkdownPath = path.resolve(cwd, path.join('.', versionObj.versionedPath), path.relative(cwd, filename));
      await fs.promises.mkdir(path.dirname(versionedMarkdownPath), { recursive: true });
      await fs.promises.writeFile(versionedMarkdownPath, str);
      console.log('%s : rendered %s', (new Date()).toISOString(), versionedMarkdownPath);
    }

    await fs.promises.mkdir(path.dirname(newfile), { recursive: true });
    await fs.promises.writeFile(newfile, str).catch((err) => {
      console.error('could not write', err.stack);
    }).then(() => {
      console.log('%s : rendered %s', (new Date()).toISOString(), newfile);
    });

    return;
  }

  let contents = fs.readFileSync(path.resolve(cwd, inputFile)).toString();
  const originalContents = contents;

  if (options.acquit) {
    const tests = getTests();
    contents = contents.replace(/```javascript acquit:([^\n]+)\n[\s\S]*?```/g, (match, pattern) => {
      const code = findTest(pattern, tests);
      if (!code) {
        throw new Error(`No test found for acquit pattern "${pattern}" in ${filename}`);
      }