feat(remove): implement the "remove" command for removing migrations from the history

packages/cli/src/commands/remove.ts

@@ -0,0 +1,110 @@
+import process from 'node:process';
+import { getOrLoadReporter, getOrLoadStorage } from '@emigrate/plugin-tools';
+import { type MigrationHistoryEntry, type MigrationMetadataFinished } from '@emigrate/plugin-tools/types';
+import {
+  BadOptionError,
+  MigrationNotRunError,
+  MissingArgumentsError,
+  MissingOptionError,
+  OptionNeededError,
+} from '../errors.js';
+import { type Config } from '../types.js';
+import { getMigration } from '../get-migration.js';
+import { getDuration } from '../get-duration.js';
+
+type ExtraFlags = {
+  force?: boolean;
+};
+
+const lazyDefaultReporter = async () => import('../reporters/default.js');
+
+export default async function removeCommand(
+  { directory, reporter: reporterConfig, storage: storageConfig, force }: Config & ExtraFlags,
+  name: string,
+) {
+  if (!directory) {
+    throw new MissingOptionError('directory');
+  }
+
+  if (!name) {
+    throw new MissingArgumentsError('name');
+  }
+
+  const cwd = process.cwd();
+  const storagePlugin = await getOrLoadStorage([storageConfig]);
+
+  if (!storagePlugin) {
+    throw new BadOptionError('storage', 'No storage found, please specify a storage using the storage option');
+  }
+
+  const storage = await storagePlugin.initializeStorage();
+  const reporter = await getOrLoadReporter([reporterConfig ?? lazyDefaultReporter]);
+
+  if (!reporter) {
+    throw new BadOptionError(
+      'reporter',
+      'No reporter found, please specify an existing reporter using the reporter option',
+    );
+  }
+
+  const migrationFile = await getMigration(cwd, directory, name, !force);
+
+  const finishedMigrations: MigrationMetadataFinished[] = [];
+  let historyEntry: MigrationHistoryEntry | undefined;
+  let removalError: Error | undefined;
+
+  for await (const migrationHistoryEntry of storage.getHistory()) {
+    if (migrationHistoryEntry.name !== migrationFile.name) {
+      continue;
+    }
+
+    if (migrationHistoryEntry.status === 'done' && !force) {
+      throw new OptionNeededError(
+        'force',
+        `The migration "${migrationFile.name}" is not in a failed state. Use the "force" option to force its removal`,
+      );
+    }
+
+    historyEntry = migrationHistoryEntry;
+  }
+
+  await reporter.onInit?.({ command: 'remove', cwd, dry: false, directory });
+
+  await reporter.onMigrationRemoveStart?.(migrationFile);
+
+  const start = process.hrtime();
+
+  if (historyEntry) {
+    try {
+      await storage.remove(migrationFile);
+
+      const duration = getDuration(start);
+      const finishedMigration: MigrationMetadataFinished = { ...migrationFile, status: 'done', duration };
+
+      await reporter.onMigrationRemoveSuccess?.(finishedMigration);
+
+      finishedMigrations.push(finishedMigration);
+    } catch (error) {
+      removalError = error instanceof Error ? error : new Error(String(error));
+    }
+  } else if (!removalError) {
+    removalError = new MigrationNotRunError(
+      `Migration "${migrationFile.name}" is not in the migration history`,
+      migrationFile,
+    );
+  }
+
+  if (removalError) {
+    const duration = getDuration(start);
+    const finishedMigration: MigrationMetadataFinished = {
+      ...migrationFile,
+      status: 'failed',
+      error: removalError,
+      duration,
+    };
+    await reporter.onMigrationRemoveError?.(finishedMigration, removalError);
+    finishedMigrations.push(finishedMigration);
+  }
+
+  await reporter.onFinished?.(finishedMigrations, removalError);
+}

packages/cli/src/commands/up.ts

@@ -18,16 +18,12 @@ import {
 import { type Config } from '../types.js';
 import { withLeadingPeriod } from '../with-leading-period.js';
 import { getMigrations } from '../get-migrations.js';
+import { getDuration } from '../get-duration.js';
 
 type ExtraFlags = {
   dry?: boolean;
 };
 
-const getDuration = (start: [number, number]) => {
-  const [seconds, nanoseconds] = process.hrtime(start);
-  return seconds * 1000 + nanoseconds / 1_000_000;
-};
-
 const lazyDefaultReporter = async () => import('../reporters/default.js');
 const lazyPluginLoaderJs = async () => import('../plugin-loader-js.js');
 
@@ -81,7 +77,7 @@ export default async function upCommand({
         relativeFilePath: path.relative(cwd, filePath),
         extension: withLeadingPeriod(path.extname(migrationHistoryEntry.name)),
         error: new MigrationHistoryError(
-          `Migration ${migrationHistoryEntry.name} is in a failed state, please fix it first`,
+          `Migration ${migrationHistoryEntry.name} is in a failed state, please fix and remove it first`,
           migrationHistoryEntry,
         ),
         directory,