Function preprocessIncludeCode

docs/src/preprocess/include_code.js:222–286

(markdownContent, filePath, rootDir)

  /^(?!<!--.*)(?=.*#include_code\s+(\S+)\s+(\S+)\s+(\S+)(?:[ ]+(\S+))?).*$/gm;

async function preprocessIncludeCode(markdownContent, filePath, rootDir) {
  // Process each include tag in the current markdown file
  let updatedContent = markdownContent;
  let matchesFound = false;
  let match;
  while ((match = regex.exec(markdownContent))) {
    matchesFound = true;
    const fullMatch = match[0];
    const identifier = match[1];
    let codeFilePath = match[2];
    const language = match[3];
    const opts = match[4] || "";

    if (codeFilePath.slice(0) != "/") {
      // Absolute path to the code file from the root of the Docusaurus project
      // Note: without prefixing with `/`, the later call to `path.resolve()` gives an incorrect path (absolute instead of relative)
      codeFilePath = `/${codeFilePath}`;
    }

    const noTitle = opts.includes("noTitle");
    const noLineNumbers = opts.includes("noLineNumbers");
    const noSourceLink = opts.includes("noSourceLink");

    try {
      const absCodeFilePath = path.join(rootDir, codeFilePath);

      // Extract the code snippet between the specified comments
      const [codeSnippet, startLine, endLine] = extractCodeSnippet(
        absCodeFilePath,
        identifier,
        filePath
      );

      const relativeCodeFilePath = path
        .resolve(rootDir, codeFilePath)
        .replace(/^\//, "");
      const urlText = `${relativeCodeFilePath}#L${startLine}-L${endLine}`;
      const tag = process.env.COMMIT_TAG
        ? `${process.env.COMMIT_TAG}`
        : "next";
      const url = `https://github.com/AztecProtocol/aztec-packages/blob/${tag}/${urlText}`;

      const title = noTitle ? "" : `title="${identifier}"`;
      const lineNumbers = noLineNumbers ? "" : "showLineNumbers";
      const source = noSourceLink
        ? ""
        : `\n> <sup><sub><a href="${url}" target="_blank" rel="noopener noreferrer">Source code: ${urlText}</a></sub></sup>`;
      const replacement =
        language === "raw"
          ? codeSnippet
          : `\`\`\`${language} ${title} ${lineNumbers} \n${codeSnippet}\n\`\`\`${source}\n`;

      // Replace the include tag with the code snippet
      updatedContent = updatedContent.replace(fullMatch, replacement);
    } catch (error) {
      const lineNum = getLineNumberFromIndex(markdownContent, match.index);
      // We were warning here, but code snippets were being broken. So making this throw an error instead:
      throw new Error(