adev/shared-docs/pipeline/api-gen/extraction/interpolate_code_examples.mts - main - githubmirror/angular

adev/shared-docs/pipeline/api-gen/extraction/interpolate_code_examples.mts
211 строк7 KB
Matthieu Riegler
docs(docs-infra): fix @example in class members (#64249)
06 окт 2025, 22:11
06 окт 2025, 22:111ffc643
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {DocEntry, ClassEntry, MethodEntry} from '@angular/compiler-cli';
import {basename, dirname, resolve} from 'path';
import fs from 'fs';

export const EXAMPLES_PATH = 'packages/examples';

// It's assumed that all markers start with #.
const REGION_START_MARKER = '#docregion';
const REGION_END_MARKER = '#enddocregion';

// Used only for clean up of leftovers comments
const TS_COMMENT_REGION_REGEX = /[ \t]*\/\/[ \t]*#(docregion|enddocregion)[ \t]*[\w-]*(\n|$)/g;
const HTML_COMMENT_REGION_REGEX =
  /[ \t]*<!--[ \t]*#(docregion|enddocregion)[ \t]*[\w-]*[ \t]*-->(\n|$)/g;

const examplesCache = new Map<string, Map<string, string>>(); // <file_path, <region, example>>

type FileType = 'ts' | 'js' | 'html';

type RegionStartToken = {name: string; startIdx: number};

const MD_CTYPE_MAP: {[key in FileType]: string} = {
  'ts': 'angular-ts',
  'js': 'javascript',
  'html': 'angular-html',
};

/**
 * Interpolate code examples in the `DocEntry`-ies JSDocs content and raw comments in place.
 * The examples are wrapped in a Markdown code block.
 *
 * @param entries Target `DocEntry`-ies array that has its examples substituted with the actual TS code.
 * @param examplesFiles A set with all examples files sources.
 */
export function interpolateCodeExamples(entries: DocEntry[]): void {
  for (const entry of entries) {
    entry.rawComment = replaceExample(entry.rawComment);
    entry.description = replaceExample(entry.description);

    for (const jsdocTag of entry.jsdocTags) {
      jsdocTag.comment = replaceExample(jsdocTag.comment);
    }

    if ('members' in entry) {
      const members = (entry as ClassEntry).members ?? [];
      for (const member of members) {
        member.description = replaceExample(member.description);

        for (const jsdocTag of member.jsdocTags) {
          jsdocTag.comment = replaceExample(jsdocTag.comment);
        }

        const method = member as MethodEntry;
        if (method.implementation) {
          for (const functionSignature of [method.implementation, ...(method.signatures ?? [])]) {
            functionSignature.description = replaceExample(functionSignature.description);
            functionSignature.jsdocTags.forEach((jsdocTag) => {
              jsdocTag.comment = replaceExample(jsdocTag.comment);
            });
          }
        }
      }
    }
  }
}

function replaceExample(text: string): string {
  // To generate a valid markdown code block, there should not be any leading spaces
  // The regex includes the leading spaces to make sure to remove them.
  // It shouldn't include line break because it create the code block at the end of the previous line
  const examplesTagRegex = /[ \t]*{@example (\S+) region=(['"])([^'"]+)\2\s*}/g;

  return text.replace(examplesTagRegex, (_: string, path: string, __: string, region: string) => {
    const example = getExample(path, region);
    if (!example) {
      throw new Error(`Missing code example ${EXAMPLES_PATH}/${path}#${region}`);
    }

    return example;
  });
}

/** Returns the example wrapped in a Markdown code block or an empty string, if the example doesn't exist. */
function getExample(path: string, region: string): string {
  let fileExamples = examplesCache.get(path);
  const src = `${EXAMPLES_PATH}/${path}`;
  const fullPath = resolve(dirname(src), basename(src));
  const fileType = path.split('.').pop() as FileType;

  if (!fileExamples) {
    const contents = fs.readFileSync(fullPath, {encoding: 'utf8'});

    fileExamples = extractExamplesFromContents(contents, fileType);
    examplesCache.set(path, fileExamples);
  }

  const example = fileExamples.get(region);
  if (!example) {
    return '';
  }

  return `\`\`\`${MD_CTYPE_MAP[fileType]}\n${example}\n\`\`\``;
}

/**
 * Extract `#docregion` examples from file contents represented as a string.
 *
 * @param contents File contents represented as a string
 * @param fileType File type
 * @returns A map with all available examples in a given file contents
 */
function extractExamplesFromContents(contents: string, fileType: FileType): Map<string, string> {
  let markerBuffer = '';
  let paramBuffer = '';
  let markerFound = false;

  const regionStack: RegionStartToken[] = [];
  const examples = new Map<string, string>();

  // Iterate over the contents string and determine the start and end indices.
  for (let i = 0; i < contents.length; i++) {
    const char = contents[i];

    // Build the marker string.
    if (char === REGION_START_MARKER[0]) {
      markerBuffer = char;
    } else if (markerBuffer && !markerFound) {
      if (!/\s/.test(char)) {
        markerBuffer += char;
      } else {
        markerFound = true;
      }
    }

    if (markerFound && !/\s/.test(char)) {
      // Build a param string.
      paramBuffer += char;
    } else if ((markerFound && char === '\n') || (paramBuffer && char === ' ')) {
      // Resolve found marker.
      switch (markerBuffer) {
        case REGION_START_MARKER:
          // Push the current index to the stack, if a start marker.
          regionStack.push({
            name: paramBuffer,
            startIdx: i + 1,
          });
          break;
        case REGION_END_MARKER:
          if (regionStack.length) {
            // Check whether the end marker has a parameter or not.
            // If not, pop from the stack (it corresponds to the last inserted token).
            // If yes, pull the corresponding token.
            let tokenIdx = paramBuffer ? regionStack.findIndex((t) => t.name === paramBuffer) : -1;
            let token: RegionStartToken;

            if (tokenIdx > -1) {
              token = regionStack.splice(tokenIdx, 1)[0];
            } else {
              token = regionStack.pop()!;
            }

            // Caclculate the end index (should represent the start of the marker).
            const endIdx =
              i - REGION_END_MARKER.length - (paramBuffer ? paramBuffer.length + 1 : 0);

            let example = contents.substring(token.startIdx, endIdx);
            example = removeLeftoverCommentsFromExample(example, fileType);

            // A code example can be composed by multiple regions;
            // hence, we check for an existing one.
            const existing = examples.get(token.name);
            example = (!!existing ? existing + '\n' : '') + example;
            examples.set(token.name, example);
          }
          break;
      }

      markerFound = false;
      markerBuffer = '';
      paramBuffer = '';
    }
  }

  return examples;
}

function removeLeftoverCommentsFromExample(example: string, fileType: FileType): string {
  example = example.trim();

  switch (fileType) {
    case 'ts':
    case 'js':
      return example
        .replace(/\n[ \t]*?\/\/\s*$/, '') // We can have only a trailing TS comment leftover
        .replace(TS_COMMENT_REGION_REGEX, '');
    case 'html':
      return example
        .replace(/(^\s*-->\n)|(\n[ \t]*?<!--\s*$)/g, '')
        .replace(HTML_COMMENT_REGION_REGEX, '');
    default:
      return example;
  }
}