cli/ts/mod_format/formatters

import { BaseFormatter } from '../classes.baseformatter.js';
import type { IPlannedChange } from '../interfaces.format.js';
import * as formatReadme from '../format.readme.js';

export class ReadmeFormatter extends BaseFormatter {
  get name(): string {
    return 'readme';
  }

  async analyze(): Promise<IPlannedChange[]> {
    return [
      {
        type: 'modify',
        path: 'readme.md',
        module: this.name,
        description: 'Ensure readme files exist',
      },
    ];
  }

  async applyChange(change: IPlannedChange): Promise<void> {
    await formatReadme.run();
  }
}