fix: add missing migrate diff command

Author: elliots

packages/cli/src/actions/migrate.ts

@@ -29,6 +29,21 @@ type ResolveOptions = CommonOptions & {
     rolledBack?: string;
 };
 
+type DiffOptions = CommonOptions & {
+    fromEmpty?: boolean;
+    toEmpty?: boolean;
+    fromSchemaDatamodel?: boolean;
+    toSchemaDatamodel?: boolean;
+    fromMigrationsDirectory?: string;
+    toMigrationsDirectory?: string;
+    fromUrl?: string;
+    toUrl?: string;
+    shadowDatabaseUrl?: string;
+    script?: boolean;
+    exitCode?: boolean;
+    extraArgs?: string[];
+};
+
 /**
  * CLI action for migration-related commands
  */
@@ -62,6 +77,10 @@ export async function run(command: string, options: CommonOptions) {
             case 'resolve':
                 await runResolve(prismaSchemaFile, options as ResolveOptions);
                 break;
+
+            case 'diff':
+                runDiff(prismaSchemaFile, options as DiffOptions);
+                break;
         }
     } finally {
         if (fs.existsSync(prismaSchemaFile)) {
@@ -140,6 +159,55 @@ function runResolve(prismaSchemaFile: string, options: ResolveOptions) {
     }
 }
 
+function runDiff(prismaSchemaFile: string, options: DiffOptions) {
+    try {
+        const parts = ['migrate diff'];
+
+        if (options.fromEmpty) {
+            parts.push('--from-empty');
+        }
+        if (options.toEmpty) {
+            parts.push('--to-empty');
+        }
+        if (options.fromSchemaDatamodel) {
+            parts.push(`--from-schema-datamodel "${prismaSchemaFile}"`);
+        }
+        if (options.toSchemaDatamodel) {
+            parts.push(`--to-schema-datamodel "${prismaSchemaFile}"`);
+        }
+        if (options.fromMigrationsDirectory) {
+            parts.push(`--from-migrations-directory "${options.fromMigrationsDirectory}"`);
+        }
+        if (options.toMigrationsDirectory) {
+            parts.push(`--to-migrations-directory "${options.toMigrationsDirectory}"`);
+        }
+        if (options.fromUrl) {
+            parts.push(`--from-url "${options.fromUrl}"`);
+        }
+        if (options.toUrl) {
+            parts.push(`--to-url "${options.toUrl}"`);
+        }
+        if (options.shadowDatabaseUrl) {
+            parts.push(`--shadow-database-url "${options.shadowDatabaseUrl}"`);
+        }
+        if (options.script) {
+            parts.push('--script');
+        }
+        if (options.exitCode) {
+            parts.push('--exit-code');
+        }
+
+        // pass through any extra args
+        if (options.extraArgs?.length) {
+            parts.push(...options.extraArgs);
+        }
+
+        execPrisma(parts.join(' '));
+    } catch (err) {
+        handleSubProcessError(err);
+    }
+}
+
 function handleSubProcessError(err: unknown) {
     if (err instanceof Error && 'status' in err && typeof err.status === 'number') {
         process.exit(err.status);

packages/cli/src/index.ts

@@ -154,6 +154,35 @@ function createProgram() {
         .description('Resolve issues with database migrations in deployment databases')
         .action((options) => migrateAction('resolve', options));
 
+    migrateCommand
+        .command('diff')
+        .addOption(schemaOption)
+        .addOption(noVersionCheckOption)
+        .addOption(new Option('--from-empty', 'assume the "from" state is an empty schema'))
+        .addOption(new Option('--to-empty', 'assume the "to" state is an empty schema'))
+        .addOption(
+            new Option(
+                '--from-schema-datamodel',
+                'use the ZModel schema as the "from" source (auto-generates Prisma schema)',
+            ),
+        )
+        .addOption(
+            new Option(
+                '--to-schema-datamodel',
+                'use the ZModel schema as the "to" source (auto-generates Prisma schema)',
+            ),
+        )
+        .addOption(new Option('--from-migrations-directory <path>', 'path to the "from" migrations directory'))
+        .addOption(new Option('--to-migrations-directory <path>', 'path to the "to" migrations directory'))
+        .addOption(new Option('--from-url <url>', 'database URL as the "from" source'))
+        .addOption(new Option('--to-url <url>', 'database URL as the "to" source'))
+        .addOption(new Option('--shadow-database-url <url>', 'shadow database URL for migrations'))
+        .addOption(new Option('--script', 'output a SQL script instead of human-readable diff'))
+        .addOption(new Option('--exit-code', 'exit with non-zero code if diff is not empty'))
+        .allowExcessArguments(true)
+        .description('Compare database schemas from two sources and output the differences')
+        .action((options, command) => migrateAction('diff', { ...options, extraArgs: command.args }));
+
     const dbCommand = program.command('db').description('Manage your database schema during development');
 
     dbCommand

packages/cli/test/migrate.test.ts

@@ -69,4 +69,9 @@ describe('CLI migrate commands test', () => {
         const { workDir } = await createProject(model, { provider: 'sqlite' });
         expect(() => runCli('migrate resolve', workDir)).toThrow();
     });
+
+    it('supports migrate diff with --from-empty and --to-schema-datamodel', async () => {
+        const { workDir } = await createProject(model, { provider: 'sqlite' });
+        runCli('migrate diff --from-empty --to-schema-datamodel --script', workDir);
+    });
 });