Function defaultFormatter

packages/bumpy/src/core/changelog.ts:91–148

(ctx)

/** Default formatter — version heading with date, bullet points sorted by bump type */
export const defaultFormatter: ChangelogFormatter = (ctx) => {
  const { release, bumpFiles, date } = ctx;
  const lines: string[] = [];
  lines.push(`## ${release.newVersion}`);
  lines.push(`<sub>${date}</sub>`);
  lines.push('');

  const relevantBumpFiles = bumpFiles.filter((bf) => release.bumpFiles.includes(bf.id));
  const sorted = sortBumpFilesByType(relevantBumpFiles, release.name);

  for (const bf of sorted) {
    if (!bf.summary || isChangelogSuppressed(bf, release.name)) continue;
    const type = getBumpTypeForPackage(bf, release.name);
    const summaryLines = trimBlankEdges(bf.summary.split('\n'));
    if (summaryLines.length === 0) continue;

    if (summaryNeedsBlockLayout(bf.summary)) {
      // Metadata on its own line; summary block indented below
      lines.push(`- *(${type})*`);
      for (const sl of summaryLines) {
        lines.push(sl.trim() ? `  ${sl}` : '');
      }
    } else {
      lines.push(`- *(${type})* ${summaryLines[0]}`);
    }
  }

  const sourceList =
    release.bumpSources.length > 0 ? release.bumpSources.map((s) => `\`${s.name}\` v${s.newVersion}`).join(', ') : '';

  if (release.isDependencyBump) {
    const depBumpType = release.bumpSources.reduce<BumpType | undefined>(
      (max, s) => maxBump(max, s.bumpType),
      undefined,
    );
    const depBumpTag = depBumpType ? `*(${depBumpType})* ` : '';
    lines.push(`- ${depBumpTag}Updated dependency ${sourceList || '(internal)'}`);
  }

  if (release.isGroupBump) {
    lines.push(
      sourceList
        ? `- *(${release.type})* Version bump from group with ${sourceList}`
        : `- *(${release.type})* Version bump from group`,
    );
  }

  if (release.isCascadeBump && !release.isDependencyBump && !release.isGroupBump) {
    lines.push(
      sourceList
        ? `- *(${release.type})* Version bump from ${sourceList}`
        : `- *(${release.type})* Version bump via cascade rule`,
    );
  }

  lines.push('');
  return lines.join('\n');
};