reduce scope, remove colocation stuff

README.md

@@ -6,6 +6,19 @@ This way, you get the ORM and the auto generation of DDL SQL from Prisma, while
 
 You can use Prisma to generate the migration SQL, but you never run the migrations with Prisma. Instead, from then on, the prisma-generated SQL DDL gets added into Knex migrations.
 
+## Setup
+1. **First, install the dependencies**: `npm install knex dotenv`
+    > Note: You can use other package managers, like yarn or pnpm.
+2. **Run the setup script**: `npx prisma-migration-migrator`  
+    This script will:
+    - Create a `knexfile.mjs` in the root of your project.
+    - Add the necessary tables to the prisma schema to ignore the knex migration history tables.
+    - Add a `create-migration` script to your `package.json` that will create a prisma migration and then convert it to a knex migration (the new flow of migration generation).
+    - Run the script to convert the existing prisma migrations to knex migrations for the first time.
+3. **Run the script**: `npx prisma-migration-migrator`  
+    This script will convert all the existing prisma migrations to knex migrations, and sync the knex migration history with the prisma migration history. This way, Prisma's migration history will be preserved when running knex migrations.
+
+
 ## Usage (after setting it up):
 
 You can do 2 things:

package.json

@@ -28,6 +28,7 @@
   "dependencies": {
     "chalk": "^5.4.1",
     "inquirer": "^12.3.0",
+    "prisma-diff-to-knex-migration": "^1.0.2",
     "sql-query-identifier": "^2.7.0"
   },
   "devDependencies": {

src/index.ts

@@ -46,7 +46,3 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
 
 export { migrator };
 export type { MigratorParameters as ConvertPrismaMigrationsToKnexMigrationsParameters };
-export {
-  knexFilePrismaAdapter,
-  KnexMigrationSourcePrismaStyle,
-} from './knexfilePrismaAdapter/index.mjs';

src/migrator/directories.ts

@@ -4,13 +4,20 @@ import path from 'node:path';
 import type { MigratorParameters } from './types.js';
 import { findKnexfile } from './knexfileFinder.js';
 
+function getInputDirectory(
+  params: MigratorParameters,
+  baseDir: string,
+): string {
+  return path.join(
+    path.resolve(baseDir, params?.prismaFolderPath || 'prisma'),
+    'migrations',
+  );
+}
+
 /**
- * ONLY USED for standalone migrations.
- * Get the migrations directory from the Knex configuration (`knexfile`) or the `knexfilePath` parameter
- *
- * For co-located migrations, the directory is the same as the Prisma migrations directory
+ * Gets the migrations directory from the Knex configuration (`knexfile`) or the `knexfilePath` parameter
  */
-async function getKnexStandaloneMigrationsDirectory(
+async function getOutputDirectory(
   params: MigratorParameters,
   baseDir: string,
 ): Promise<string | null> {
@@ -48,7 +55,8 @@ async function getKnexStandaloneMigrationsDirectory(
     if (!migrationsDir) {
       console.error(
         `Migrations property not found in the Knex configuration. 
-        BEWARE: You need to specify the migrations extension in the Knex configuration for mjs files. Maybe use the setup script included in this package?. 
+        BEWARE: You need to specify the migrations extension in the Knex configuration for mjs files. 
+        Maybe use the setup script included in this package? (npx prisma-migration-migrator --setup). 
         Otherwise, check the knexfile of this library for a working example.
         Using known default: <project-root>/migrations`,
       );
@@ -75,35 +83,22 @@ export function getBaseDirectory() {
 export async function resolveMigrationDirectories(params?: MigratorParameters) {
   const baseDir = getBaseDirectory();
 
-  let prismaMigrationsDir, knexMigrationsDir;
   try {
-    prismaMigrationsDir = path.join(
-      path.resolve(baseDir, params?.prismaFolderPath || 'prisma'),
-      'migrations',
-    );
+    const prismaMigrationsDir = getInputDirectory(params, baseDir);
     console.log(`> > Converting Prisma migrations from ${prismaMigrationsDir}`);
 
-    if (!params?.colocate) {
-      knexMigrationsDir = await getKnexStandaloneMigrationsDirectory(
-        params,
-        baseDir,
-      );
-      if (!knexMigrationsDir) {
-        throw new Error('Knex migrations directory not found');
-      }
-      console.log(
-        `> > Will locate converted migrations in the directory: ${knexMigrationsDir}`,
-      );
-      await mkdir(knexMigrationsDir, { recursive: true });
-    } else {
-      console.log(
-        `> > Will co-locate converted migrations with Prisma migrations in the same directory`,
-      );
+    const knexMigrationsDir = await getOutputDirectory(params, baseDir);
+    if (!knexMigrationsDir) {
+      throw new Error('Knex migrations directory not found');
     }
+    console.log(
+      `> > Will locate converted migrations in the directory: ${knexMigrationsDir}`,
+    );
+    await mkdir(knexMigrationsDir, { recursive: true });
+
+    return { prismaMigrationsDir, knexMigrationsDir };
   } catch (err) {
     console.error('> Error resolving migration directories:', err);
     throw err;
   }
-
-  return { prismaMigrationsDir, knexMigrationsDir };
 }

src/migrator/index.ts

@@ -6,5 +6,5 @@ import type { MigratorParameters } from './types.js';
 export async function migrator(params?: MigratorParameters): Promise<void> {
   const migrations = await getMigrationsToMigrate(params);
   await knexMigrationsWriter(migrations);
-  await syncMigrationTables(params);
+  await syncMigrationTables();
 }

src/migrator/knexMigrationsWriter.ts

@@ -1,4 +1,4 @@
-import { knexMigrationWriter } from '../knexMigrationWriter/knexMigrationsWriter.js';
+import { knexMigrationWriter } from 'prisma-diff-to-knex-migration';
 import type { MigrationData } from './types.js';
 
 export async function knexMigrationsWriter(

src/migrator/prismaMigrationsFetcher.ts

@@ -3,6 +3,7 @@ import { createHash } from 'node:crypto';
 import path from 'node:path';
 import type { MigrationData, MigratorParameters } from './types.js';
 import { resolveMigrationDirectories } from './directories.js';
+import { identify } from 'sql-query-identifier';
 
 export function calculateChecksum(data: string): string {
   return createHash('sha256').update(data, 'utf8').digest('hex');
@@ -33,9 +34,10 @@ export async function getMigrationsToMigrate(
                 'migration.sql',
               );
 
-              const finalMigrationPath = params?.colocate
-                ? path.join(prismaMigrationsDir, name, 'migration.mjs')
-                : path.join(knexMigrationsDir, `${name}.mjs`);
+              const finalMigrationPath = path.join(
+                knexMigrationsDir,
+                `${name}.mjs`,
+              );
 
               const alreadyExists = await access(finalMigrationPath)
                 .then(() => true)
@@ -70,7 +72,7 @@ export async function getMigrationsToMigrate(
             name,
             baseSqlPath,
             finalMigrationPath,
-            sql,
+            sql: identify(sql),
             checksum: calculateChecksum(sql),
           })),
       ),