Function readBumpFiles

packages/bumpy/src/core/bump-file.ts:43–89

(rootDir: string, opts: ReadBumpFilesOptions = {})

/** Read all bump files from .bumpy/ (and optionally channel subdirs), sorted by git creation order */
export async function readBumpFiles(rootDir: string, opts: ReadBumpFilesOptions = {}): Promise<ReadBumpFilesResult> {
  const dir = getBumpyDir(rootDir);
  const bumpFiles: BumpFile[] = [];
  const errors: string[] = [];

  const files = await listFiles(dir, '.md');
  for (const file of files) {
    if (file === 'README.md') continue;
    const result = await parseBumpFileFromPath(resolve(dir, file));
    if (result.bumpFile) bumpFiles.push(result.bumpFile);
    errors.push(...result.errors);
  }

  for (const channel of opts.channels ?? []) {
    const channelDir = resolve(dir, channel);
    const channelFiles = await listFiles(channelDir, '.md');
    for (const file of channelFiles) {
      if (file === 'README.md') continue;
      const result = await parseBumpFileFromPath(resolve(channelDir, file));
      if (result.bumpFile) {
        const duplicate = bumpFiles.find((bf) => bf.id === result.bumpFile!.id);
        if (duplicate) {
          errors.push(
            `Bump file "${result.bumpFile.id}" exists both ${duplicate.channel ? `in .bumpy/${duplicate.channel}/` : 'at .bumpy/ root'} and in .bumpy/${channel}/ — ` +
              'remove one copy (the change likely already shipped on one of them).',
          );
          continue;
        }
        bumpFiles.push({ ...result.bumpFile, channel });
      }
      errors.push(...result.errors);
    }
  }

  // Sort by the commit date when each bump file was first added to git.
  // Falls back to filename order for uncommitted bump files.
  const creationOrder = getBumpFileCreationOrder(rootDir);
  if (creationOrder.size > 0) {
    bumpFiles.sort((a, b) => {
      const aOrder = creationOrder.get(a.id) ?? Infinity;
      const bOrder = creationOrder.get(b.id) ?? Infinity;
      return aOrder - bOrder || a.id.localeCompare(b.id);
    });
  }

  return { bumpFiles, errors };
}

/**
 * Use `git log` to get the commit timestamp when each bump file was first added.