packages/utils/upgrade/src/modules/format/formats.ts - develop - githubmirror/strapi

packages/utils/upgrade/src/modules/format/formats.ts
104 строки3 KB
Jean-Sébastien Herbaux
Update "upgrade major" rules (#21745)
11 окт 2024, 13:48
11 окт 2024, 13:482000806
import CliTable3 from 'cli-table3';
import chalk from 'chalk';

import { constants as timerConstants } from '../timer';

import type { AppProject, PluginProject, ProjectType } from '../project';
import type { Codemod } from '../codemod';
import type { Version } from '../version';
import type { Report } from '../report';

export const path = (path: string) => chalk.blue(path);

export const version = (version: Version.LiteralVersion | Version.SemVer) => {
  return chalk.italic.yellow(`v${version}`);
};

export const codemodUID = (uid: string) => {
  return chalk.bold.cyan(uid);
};

export const projectDetails = (project: AppProject | PluginProject) => {
  return `Project: TYPE=${projectType(project.type)}; CWD=${path(project.cwd)}; PATHS=${project.paths.map(path)}`;
};

export const projectType = (type: ProjectType) => chalk.cyan(type);

export const versionRange = (range: Version.Range) => chalk.italic.yellow(range.raw);

export const transform = (transformFilePath: string) => chalk.cyan(transformFilePath);

export const highlight = (arg: unknown) => chalk.bold.underline(arg);

export const upgradeStep = (text: string, step: [current: number, total: number]) => {
  return chalk.bold(`(${step[0]}/${step[1]}) ${text}...`);
};

export const reports = (reports: Report.CodemodReport[]) => {
  const rows = reports.map(({ codemod, report }, i) => {
    const fIndex = chalk.grey(i);
    const fVersion = chalk.magenta(codemod.version);
    const fKind = chalk.yellow(codemod.kind);
    const fFormattedTransformPath = chalk.cyan(codemod.format());
    const fTimeElapsed =
      i === 0
        ? `${report.timeElapsed}s ${chalk.dim.italic('(cold start)')}`
        : `${report.timeElapsed}s`;
    const fAffected = report.ok > 0 ? chalk.green(report.ok) : chalk.grey(0);
    const fUnchanged = report.ok === 0 ? chalk.red(report.nochange) : chalk.grey(report.nochange);

    return [fIndex, fVersion, fKind, fFormattedTransformPath, fAffected, fUnchanged, fTimeElapsed];
  });

  const table = new CliTable3({
    style: { compact: true },
    head: [
      chalk.bold.grey('N°'),
      chalk.bold.magenta('Version'),
      chalk.bold.yellow('Kind'),
      chalk.bold.cyan('Name'),
      chalk.bold.green('Affected'),
      chalk.bold.red('Unchanged'),
      chalk.bold.blue('Duration'),
    ],
  });

  table.push(...rows);

  return table.toString();
};

export const codemodList = (codemods: Codemod.List) => {
  type Row = [index: string, version: string, kind: string, name: string, uid: string];

  const rows = codemods.map<Row>((codemod, index) => {
    const fIndex = chalk.grey(index);
    const fVersion = chalk.magenta(codemod.version);
    const fKind = chalk.yellow(codemod.kind);
    const fName = chalk.blue(codemod.format());
    const fUID = codemodUID(codemod.uid);

    return [fIndex, fVersion, fKind, fName, fUID] satisfies Row;
  });

  const table = new CliTable3({
    style: { compact: true },
    head: [
      chalk.bold.grey('N°'),
      chalk.bold.magenta('Version'),
      chalk.bold.yellow('Kind'),
      chalk.bold.blue('Name'),
      chalk.bold.cyan('UID'),
    ],
  });

  table.push(...rows);

  return table.toString();
};

export const durationMs = (elapsedMs: number) => {
  const elapsedSeconds = (elapsedMs / timerConstants.ONE_SECOND_MS).toFixed(3);

  return `${elapsedSeconds}s`;
};