readChangelogSnippet() — react Function Reference

Architecture documentation for the readChangelogSnippet() function in summaries.js from the react codebase.

Function javascript BabelCompiler Entrypoint called by 1

Entity Profile

BabelCompiler→ Entrypoint→ readChangelogSnippet() — react Function Reference

Dependency Diagram

graph TD
  ec5480b9_fa97_0f38_9e96_df41ded354f1["readChangelogSnippet()"]
  b5cf948c_d822_859d_c0f5_1e2c15545976["summaries.js"]
  ec5480b9_fa97_0f38_9e96_df41ded354f1 -->|defined in| b5cf948c_d822_859d_c0f5_1e2c15545976
  349b50fc_02df_e8e0_07c9_00b7984d8884["summarizePackageCommits()"]
  349b50fc_02df_e8e0_07c9_00b7984d8884 -->|calls| ec5480b9_fa97_0f38_9e96_df41ded354f1
  style ec5480b9_fa97_0f38_9e96_df41ded354f1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/tasks/generate-changelog/summaries.js lines 8–41

function readChangelogSnippet(preferredPackage) {
  const cacheKey =
    preferredPackage === 'eslint-plugin-react-hooks'
      ? preferredPackage
      : 'root';
  if (!readChangelogSnippet.cache) {
    readChangelogSnippet.cache = new Map();
  }
  const cache = readChangelogSnippet.cache;
  if (cache.has(cacheKey)) {
    return cache.get(cacheKey);
  }

  const targetPath =
    preferredPackage === 'eslint-plugin-react-hooks'
      ? path.join(
          repoRoot,
          'packages',
          'eslint-plugin-react-hooks',
          'CHANGELOG.md'
        )
      : path.join(repoRoot, 'CHANGELOG.md');

  let content = '';
  try {
    content = fs.readFileSync(targetPath, 'utf8');
  } catch {
    content = '';
  }

  const snippet = content.slice(0, 4000);
  cache.set(cacheKey, snippet);
  return snippet;
}