stepwise-migrations 1.0.8 → 1.0.10

package/README.md

@@ -16,7 +16,7 @@ No subdirectories are read below the migration directory.
 
 ## Usage
 
-```
+```text
 Usage: stepwise-migrations [command] [options]
 
 Commands:
@@ -24,10 +24,16 @@ Commands:
     Migrate the database to the latest version
   down
     Rollback the database to the previous version
+  validate
+    Validate the migration files and the migration history table
+  audit
+    Show the audit history for the migrations in the database
   info
     Show information about the current state of the migrations in the database
   drop
     Drop all tables, schema and migration history table
+  get-script
+    Get the script for the last applied migration
 
 Options:
   --connection <connection>  The connection string to use to connect to the database
@@ -36,6 +42,7 @@ Options:
   --ssl true/false           Whether to use SSL for the connection (default: false)
   --nup                      Number of up migrations to apply (default: all)
   --ndown                    Number of down migrations to apply (default: 1)
+  --filename                 The filename to get the script for (default: last applied migration)
 
 Example:
   npx stepwise-migrations migrate \
@@ -48,7 +55,7 @@ Example:
 
 ### Migrate
 
-Command:
+If all files are in a valid state, runs all the "up" migrations that have not been applied yet.
 
 ```bash
 npx stepwise-migrations migrate \
@@ -57,25 +64,36 @@ npx stepwise-migrations migrate \
   --path=./db/migration/
 ```
 
-Outputs:
+<details>
 
-```
+<summary>Example output</summary>
+
+```text
 Creating schema myschema... done!
 Creating migration history table... done!
 Applying migration v1_connect_session_table.sql... done!
 Applying migration v2_auth.sql... done!
 All done! Applied 2 migrations
-New migration history:
-┌─────────┬────┬────────────────────────────────┬────────────────────────────────────────────────────────────────────┬────────────┬─────────────────────────────┐
-│ (index) │ id │ name                           │ hash                                                               │ applied_by │ applied_at                  │
-├─────────┼────┼────────────────────────────────┼────────────────────────────────────────────────────────────────────┼────────────┼─────────────────────────────┤
-│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'f08638e58139ae0e2dda24b1bdba29f3f2128597066a23d2bb382d448bbe9d7e' │ 'postgres' │ '2024-11-23 18:29:16.1616'  │
-│ 1       │ 2  │ 'v2_auth.sql'                  │ '0a4c5df39f03df85cb68ef0b297b913d7c15477fa9dcba13b6e0577d88258a8e' │ 'postgres' │ '2024-11-23 18:29:16.16533' │
-└─────────┴────┴────────────────────────────────┴────────────────────────────────────────────────────────────────────┴────────────┴─────────────────────────────┘
+Migration history:
+┌─────────┬────┬────────────────────────────────┬────────────┬──────────────────────────────┐
+│ (index) │ id │ name                           │ applied_by │ applied_at                   │
+├─────────┼────┼────────────────────────────────┼────────────┼──────────────────────────────┤
+│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'postgres' │ '2024-11-24 05:40:41.211617' │
+│ 1       │ 2  │ 'v2_auth.sql'                  │ 'postgres' │ '2024-11-24 05:40:41.214732' │
+└─────────┴────┴────────────────────────────────┴────────────┴──────────────────────────────┘
+Unapplied migrations:
+┌─────────┐
+│ (index) │
+├─────────┤
 ```
 
+</details>
+
 ### Down
 
+Runs a single down migration for the last applied migration.
+Can run multiple down migrations if the `--ndown` option is provided.
+
 Command:
 
 ```bash
@@ -85,21 +103,112 @@ npx stepwise-migrations down \
   --path=./db/migration/
 ```
 
-Outputs:
+<details>
 
-```
+<summary>Example output</summary>
+
+```text
 Applying down migration v2_auth.down.sql... done!
 All done! Applied 1 down migration
-New migration history:
-┌─────────┬────┬────────────────────────────────┬────────────────────────────────────────────────────────────────────┬────────────┬────────────────────────────┐
-│ (index) │ id │ name                           │ hash                                                               │ applied_by │ applied_at                 │
-├─────────┼────┼────────────────────────────────┼────────────────────────────────────────────────────────────────────┼────────────┼────────────────────────────┤
-│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'f08638e58139ae0e2dda24b1bdba29f3f2128597066a23d2bb382d448bbe9d7e' │ 'postgres' │ '2024-11-23 18:29:16.1616' │
-└─────────┴────┴────────────────────────────────┴────────────────────────────────────────────────────────────────────┴────────────┴────────────────────────────┘
+Migration history:
+┌─────────┬────┬────────────────────────────────┬────────────┬──────────────────────────────┐
+│ (index) │ id │ name                           │ applied_by │ applied_at                   │
+├─────────┼────┼────────────────────────────────┼────────────┼──────────────────────────────┤
+│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'postgres' │ '2024-11-24 05:40:41.211617' │
+└─────────┴────┴────────────────────────────────┴────────────┴──────────────────────────────┘
+Unapplied migrations:
+┌─────────┬───────────────┐
+│ (index) │ filename      │
+├─────────┼───────────────┤
+│ 0       │ 'v2_auth.sql' │
+└─────────┴───────────────┘
+```
+
+</details>
+
+### Validate
+
+Validates the migration files and the migration history table.
+
+```bash
+npx stepwise-migrations validate \
+  --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydb \
+  --schema=myschema \
+  --path=./db/migration/
+```
+
+<details>
+
+<summary>Example output - validation passed</summary>
+
+```text
+Validation passed
+Migration history:
+┌─────────┬────┬────────────────────────────────┬────────────┬──────────────────────────────┐
+│ (index) │ id │ name                           │ applied_by │ applied_at                   │
+├─────────┼────┼────────────────────────────────┼────────────┼──────────────────────────────┤
+│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'postgres' │ '2024-11-24 05:40:41.211617' │
+└─────────┴────┴────────────────────────────────┴────────────┴──────────────────────────────┘
+Unapplied migrations:
+┌─────────┬───────────────┐
+│ (index) │ filename      │
+├─────────┼───────────────┤
+│ 0       │ 'v2_auth.sql' │
+└─────────┴───────────────┘
+```
+
+</details>
+
+<details>
+
+<summary>Example output - script changed error</summary>
+
+```sql
+Error: migration v1_connect_session_table.sql has been modified, aborting.
+ 	"expire" timestamp(6) NOT NULL
+ )
+ WITH (OIDS=FALSE);
+-ALTER TABLE "session" ADD CONSTRAINT "session_pkey" PRIMARY KEY ("sid") NOT DEFERRABLE INITIALLY IMMEDIATE;
+
++ALTER TABLE "session" ADD CONSTRAINT "session_pkey" PRIMARY KEY ("sid") NOT DEFERRABLE INITIALLY IMMEDIATE;
++
++ALTER TABLE "session" ADD INDEX "session_sid" ON "session" (sid);
+```
+
+</details>
+
+### Audit
+
+Shows the audit history for the migrations in the database.
+
+```bash
+npx stepwise-migrations audit \
+  --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydb \
+  --schema=myschema \
+  --path=./db/migration/
+```
+
+<details>
+
+<summary>Example output</summary>
+
+```text
+Audit history:
+┌─────────┬────┬────────┬────────────────────────────────┬────────────┬──────────────────────────────┐
+│ (index) │ id │ type   │ name                           │ applied_by │ applied_at                   │
+├─────────┼────┼────────┼────────────────────────────────┼────────────┼──────────────────────────────┤
+│ 0       │ 1  │ 'up'   │ 'v1_connect_session_table.sql' │ 'postgres' │ '2024-11-24 05:40:41.211617' │
+│ 1       │ 2  │ 'up'   │ 'v2_auth.sql'                  │ 'postgres' │ '2024-11-24 05:40:41.214732' │
+│ 2       │ 3  │ 'down' │ 'v2_auth.down.sql'             │ 'postgres' │ '2024-11-24 05:41:34.541462' │
+└─────────┴────┴────────┴────────────────────────────────┴────────────┴──────────────────────────────┘
 ```
 
+</details>
+
 ### Info
 
+Shows the current state of the migrations in the database.
+
 Command:
 
 ```bash
@@ -109,19 +218,55 @@ npx stepwise-migrations info \
   --path=./db/migration/
 ```
 
-Outputs:
+<details>
 
-```
+<summary>Example output</summary>
+
+```text
 Migration history:
-┌─────────┬────┬────────────────────────────────┬────────────────────────────────────────────────────────────────────┬────────────┬────────────────────────────┐
-│ (index) │ id │ name                           │ hash                                                               │ applied_by │ applied_at                 │
-├─────────┼────┼────────────────────────────────┼────────────────────────────────────────────────────────────────────┼────────────┼────────────────────────────┤
-│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'f08638e58139ae0e2dda24b1bdba29f3f2128597066a23d2bb382d448bbe9d7e' │ 'postgres' │ '2024-11-23 18:29:16.1616' │
-└─────────┴────┴────────────────────────────────┴────────────────────────────────────────────────────────────────────┴────────────┴────────────────────────────┘
+┌─────────┬────┬────────────────────────────────┬────────────┬──────────────────────────────┐
+│ (index) │ id │ name                           │ applied_by │ applied_at                   │
+├─────────┼────┼────────────────────────────────┼────────────┼──────────────────────────────┤
+│ 0       │ 1  │ 'v1_connect_session_table.sql' │ 'postgres' │ '2024-11-24 05:40:41.211617' │
+└─────────┴────┴────────────────────────────────┴────────────┴──────────────────────────────┘
+```
+
+</details>
+
+### Get Script
+
+Gets the script for the last applied migration.
+Can get the script for a specific migration if the `--filename` option is provided.
+
+Command:
+
+```bash
+npx stepwise-migrations get-script --filename v2_auth.sql \
+  --connection=postgresql://postgres:postgres@127.0.0.1:5432/colliedb \
+  --schema=collie \
+  --path=./db/migration/
+```
+
+<details>
+
+<summary>Example output</summary>
+
+```sql
+CREATE TABLE "users" (
+	id bigserial primary key,
+	email text unique not null,
+	first_name text not null,
+	last_name text not null,
+	created_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
+);
 ```
 
+</details>
+
 ### Drop
 
+Drops the tables, schema and migration history table.
+
 Command:
 
 ```bash
@@ -130,8 +275,12 @@ npx stepwise-migrations drop \
   --schema=myschema
 ```
 
-Outputs:
+<details>
 
-```
+<summary>Example output</summary>
+
+```text
 Dropping the tables, schema and migration history table... done!
 ```
+
+</details>

package/dist/db.js

@@ -42,7 +42,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dbCreateHistoryTable = exports.dbCreateSchema = exports.dbMigrationHistory = exports.dbTableExists = exports.dbHistorySchemaExists = exports.dbConnect = void 0;
+exports.dbGetScript = exports.dbCreateHistoryTable = exports.dbAuditHistory = exports.dbCreateSchema = exports.dbMigrationHistory = exports.dbTableExists = exports.dbHistorySchemaExists = exports.dbConnect = void 0;
 const pg_1 = __importStar(require("pg"));
 pg_1.default.types.setTypeParser(1114, function (stringValue) {
     return stringValue; //1114 for time without timezone type
@@ -88,15 +88,35 @@ const dbCreateSchema = (client, schema) => __awaiter(void 0, void 0, void 0, fun
     console.log(`done!`);
 });
 exports.dbCreateSchema = dbCreateSchema;
+const dbAuditHistory = (client, schema) => __awaiter(void 0, void 0, void 0, function* () {
+    const auditQuery = yield client.query(`SELECT * FROM ${schema}.stepwise_audit`);
+    return auditQuery.rows;
+});
+exports.dbAuditHistory = dbAuditHistory;
 const dbCreateHistoryTable = (client, schema) => __awaiter(void 0, void 0, void 0, function* () {
     process.stdout.write(`Creating migration history table... `);
-    yield client.query(`CREATE TABLE IF NOT EXISTS ${schema}.stepwise_migrations (
-    id SERIAL PRIMARY KEY,
-    name TEXT UNIQUE NOT NULL,
-    hash TEXT NOT NULL,
-    applied_by TEXT NOT NULL DEFAULT current_user,
-    applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
-    )`);
+    yield client.query(`
+CREATE TABLE IF NOT EXISTS ${schema}.stepwise_migrations (
+  id SERIAL PRIMARY KEY,
+  name TEXT UNIQUE NOT NULL,
+  script TEXT NOT NULL,
+  applied_by TEXT NOT NULL DEFAULT current_user,
+  applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+CREATE TABLE IF NOT EXISTS ${schema}.stepwise_audit (
+  id SERIAL PRIMARY KEY,
+  type TEXT NOT NULL,
+  name TEXT UNIQUE NOT NULL,
+  script TEXT NOT NULL,
+  applied_by TEXT NOT NULL DEFAULT current_user,
+  applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+    `);
     console.log(`done!`);
 });
 exports.dbCreateHistoryTable = dbCreateHistoryTable;
+const dbGetScript = (client, schema, filename) => __awaiter(void 0, void 0, void 0, function* () {
+    const script = yield client.query(`SELECT script FROM ${schema}.stepwise_audit WHERE name = $1`, [filename]);
+    return script.rows[0].script;
+});
+exports.dbGetScript = dbGetScript;

package/dist/index.js

@@ -36,13 +36,16 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
         const migrationHistory = yield (0, db_1.dbMigrationHistory)(client, schema);
         const migrationFiles = yield (0, utils_1.readMigrationFiles)(argv.path);
         (0, migrate_1.validateMigrationFiles)(migrationFiles, migrationHistory);
+        if (migrationFiles.length === migrationHistory.length) {
+            console.log("All migrations are already applied");
+            process.exit(0);
+        }
         const migrationsToApply = migrationFiles.slice(migrationHistory.length, migrationHistory.length + nUp);
-        for (const { filename, contents, hash } of migrationsToApply) {
-            yield (0, migrate_1.applyMigration)(client, schema, filename, contents, hash);
+        for (const { filename, script } of migrationsToApply) {
+            yield (0, migrate_1.applyMigration)(client, schema, filename, script);
         }
         console.log(`All done! Applied ${migrationsToApply.length} migrations`);
-        console.log("New migration history:");
-        console.table(yield (0, db_1.dbMigrationHistory)(client, schema));
+        (0, utils_1.printMigrationHistoryAndUnappliedMigrations)(yield (0, utils_1.readMigrationFiles)(argv.path), yield (0, db_1.dbMigrationHistory)(client, schema));
     }
     else if (command === "info") {
         if (!historySchemaExists) {
@@ -52,10 +55,22 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
             console.log("Migration history table does not exist");
         }
         if (historySchemaExists && tableExists) {
-            console.log("Migration history:");
-            console.table(yield (0, db_1.dbMigrationHistory)(client, schema));
+            (0, utils_1.printMigrationHistory)(yield (0, db_1.dbMigrationHistory)(client, schema));
         }
     }
+    else if (command === "validate") {
+        if (!historySchemaExists) {
+            console.log("Schema does not exist");
+        }
+        if (!tableExists) {
+            console.log("Migration history table does not exist");
+        }
+        if (historySchemaExists && tableExists) {
+            (0, migrate_1.validateMigrationFiles)(yield (0, utils_1.readMigrationFiles)(argv.path), yield (0, db_1.dbMigrationHistory)(client, schema));
+        }
+        console.log("Validation passed");
+        (0, utils_1.printMigrationHistoryAndUnappliedMigrations)(yield (0, utils_1.readMigrationFiles)(argv.path), yield (0, db_1.dbMigrationHistory)(client, schema));
+    }
     else if (command === "drop") {
         process.stdout.write(`Dropping the tables, schema and migration history table... `);
         yield client.query(`DROP SCHEMA IF EXISTS ${schema} CASCADE`);
@@ -68,12 +83,31 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
         const reverseMigrationHistory = migrationHistory.reverse().slice(0, nDown);
         const downMigrationFilesToApply = yield (0, utils_1.readDownMigrationFiles)(argv.path, reverseMigrationHistory);
         (0, migrate_1.validateDownMigrationFiles)(downMigrationFilesToApply, reverseMigrationHistory);
-        for (const { filename, contents, upFilename, } of downMigrationFilesToApply) {
-            yield (0, migrate_1.applyDownMigration)(client, schema, filename, contents, upFilename);
+        for (const { filename, script, upFilename } of downMigrationFilesToApply) {
+            yield (0, migrate_1.applyDownMigration)(client, schema, filename, script, upFilename);
         }
-        console.log(`All done! Applied ${downMigrationFilesToApply.length} down migrations`);
-        console.log("New migration history:");
-        console.table(yield (0, db_1.dbMigrationHistory)(client, schema));
+        console.log(`All done! Applied ${downMigrationFilesToApply.length} down migration${downMigrationFilesToApply.length === 1 ? "" : "s"}`);
+        (0, utils_1.printMigrationHistoryAndUnappliedMigrations)(yield (0, utils_1.readMigrationFiles)(argv.path), yield (0, db_1.dbMigrationHistory)(client, schema));
+    }
+    else if (command === "audit") {
+        const auditHistory = yield (0, db_1.dbAuditHistory)(client, schema);
+        console.log("Audit history:");
+        console.table(auditHistory.map((row) => ({
+            id: row.id,
+            type: row.type,
+            name: row.name,
+            applied_by: row.applied_by,
+            applied_at: row.applied_at,
+        })));
+    }
+    else if (command === "get-script") {
+        const script = yield (0, db_1.dbGetScript)(client, schema, argv.filename);
+        console.log(script);
+    }
+    else {
+        console.error(`Invalid command: ${argv._[0]}`);
+        console.log(utils_1.usage);
+        process.exit(1);
     }
     client.release();
     process.exit(0);

package/dist/migrate.js

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyDownMigration = exports.validateDownMigrationFiles = exports.applyMigration = exports.validateMigrationFiles = void 0;
+const git_diff_1 = __importDefault(require("git-diff"));
 const validateMigrationFiles = (migrationFiles, migrationHistory, isUp = true) => {
     if (migrationFiles.length === 0) {
         console.log("No migrations found");
@@ -19,12 +23,8 @@ const validateMigrationFiles = (migrationFiles, migrationHistory, isUp = true) =
         console.error("Error: migration history is longer than the number of migration files, aborting.");
         process.exit(1);
     }
-    if (migrationFiles.length === migrationHistory.length && isUp) {
-        console.log("All migrations are already applied");
-        process.exit(0);
-    }
     for (let i = 0; i < migrationFiles.length; i++) {
-        const { filename, hash: migrationHash } = migrationFiles[i];
+        const { filename, script: migrationScript } = migrationFiles[i];
         if (i >= migrationHistory.length) {
             continue;
         }
@@ -32,20 +32,25 @@ const validateMigrationFiles = (migrationFiles, migrationHistory, isUp = true) =
             console.error(`Error: migration ${filename} has been renamed, aborting.`);
             process.exit(1);
         }
-        if (migrationHistory[i].hash !== migrationHash) {
+        if (migrationHistory[i].script !== migrationScript) {
             console.error(`Error: migration ${filename} has been modified, aborting.`);
+            console.log((0, git_diff_1.default)(migrationHistory[i].script, migrationScript, {
+                color: true,
+                noHeaders: true,
+            }));
             process.exit(1);
         }
     }
 };
 exports.validateMigrationFiles = validateMigrationFiles;
-const applyMigration = (client, schema, filename, contents, hash) => __awaiter(void 0, void 0, void 0, function* () {
+const applyMigration = (client, schema, filename, script) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         process.stdout.write(`Applying migration ${filename}... `);
         yield client.query("BEGIN");
         yield client.query(`SET search_path TO ${schema};
-    ${contents.toString()}`);
-        yield client.query(`INSERT INTO ${schema}.stepwise_migrations (name, hash) VALUES ($1, $2)`, [filename, hash]);
+    ${script.toString()}`);
+        yield client.query(`INSERT INTO ${schema}.stepwise_migrations (name, script) VALUES ($1, $2)`, [filename, script]);
+        yield client.query(`INSERT INTO ${schema}.stepwise_audit (type, name, script) VALUES ($1, $2, $3)`, ["up", filename, script]);
         yield client.query("COMMIT");
         console.log(`done!`);
     }
@@ -72,13 +77,14 @@ const validateDownMigrationFiles = (downMigrationFilesToApply, reverseMigrationH
     }
 };
 exports.validateDownMigrationFiles = validateDownMigrationFiles;
-const applyDownMigration = (client, schema, filename, contents, upFilename) => __awaiter(void 0, void 0, void 0, function* () {
+const applyDownMigration = (client, schema, filename, script, upFilename) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         process.stdout.write(`Applying down migration ${filename}... `);
         yield client.query("BEGIN");
         yield client.query(`SET search_path TO ${schema};
-    ${contents.toString()}`);
+    ${script.toString()}`);
         yield client.query(`DELETE FROM ${schema}.stepwise_migrations WHERE name = $1`, [upFilename]);
+        yield client.query(`INSERT INTO ${schema}.stepwise_audit (type, name, script) VALUES ($1, $2, $3)`, ["down", filename, script]);
         yield client.query("COMMIT");
         console.log(`done!`);
     }

package/dist/utils.js

@@ -12,14 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readDownMigrationFiles = exports.fileExists = exports.readMigrationFiles = exports.validateArgs = exports.usage = exports.calculateHash = void 0;
-const crypto_1 = __importDefault(require("crypto"));
+exports.readDownMigrationFiles = exports.fileExists = exports.printMigrationHistory = exports.printMigrationHistoryAndUnappliedMigrations = exports.readMigrationFiles = exports.validateArgs = exports.usage = void 0;
 const promises_1 = __importDefault(require("fs/promises"));
 const path_1 = __importDefault(require("path"));
-const calculateHash = (contents) => {
-    return crypto_1.default.createHash("sha256").update(contents).digest("hex");
-};
-exports.calculateHash = calculateHash;
 exports.usage = `
 Usage: stepwise-migrations [command] [options]
 
@@ -59,14 +54,6 @@ const validateArgs = (argv) => {
         console.log(exports.usage);
         process.exit(1);
     }
-    if (argv._[0] !== "migrate" &&
-        argv._[0] !== "info" &&
-        argv._[0] !== "drop" &&
-        argv._[0] !== "down") {
-        console.error(`Invalid command: ${argv._[0]}`);
-        console.log(exports.usage);
-        process.exit(1);
-    }
 };
 exports.validateArgs = validateArgs;
 const readMigrationFiles = (directory) => __awaiter(void 0, void 0, void 0, function* () {
@@ -79,18 +66,41 @@ const readMigrationFiles = (directory) => __awaiter(void 0, void 0, void 0, func
     migrationFiles.sort();
     const results = [];
     for (const fullFilePath of migrationFiles) {
-        const contents = yield promises_1.default.readFile(fullFilePath, "utf8");
+        const script = yield promises_1.default.readFile(fullFilePath, "utf8");
         results.push({
             type: "up",
             fullFilePath,
             filename: path_1.default.basename(fullFilePath),
-            hash: (0, exports.calculateHash)(contents),
-            contents,
+            script,
         });
     }
     return results;
 });
 exports.readMigrationFiles = readMigrationFiles;
+const printMigrationHistoryAndUnappliedMigrations = (migrationFiles, migrationHistory) => {
+    console.log("Migration history:");
+    console.table(migrationHistory.map((h) => ({
+        id: h.id,
+        name: h.name,
+        applied_by: h.applied_by,
+        applied_at: h.applied_at,
+    })));
+    console.log("Unapplied migrations:");
+    console.table(migrationFiles.slice(migrationHistory.length).map((m) => ({
+        filename: m.filename,
+    })));
+};
+exports.printMigrationHistoryAndUnappliedMigrations = printMigrationHistoryAndUnappliedMigrations;
+const printMigrationHistory = (migrationHistory) => {
+    console.log("Migration history:");
+    console.table(migrationHistory.map((h) => ({
+        id: h.id,
+        name: h.name,
+        applied_by: h.applied_by,
+        applied_at: h.applied_at,
+    })));
+};
+exports.printMigrationHistory = printMigrationHistory;
 const fileExists = (path) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         return (yield promises_1.default.stat(path)).isFile();
@@ -108,13 +118,13 @@ const readDownMigrationFiles = (directory, migrationHistory) => __awaiter(void 0
             console.error(`Down migration file not found: ${fullFilePath}`);
             process.exit(1);
         }
-        const contents = yield promises_1.default.readFile(fullFilePath, "utf8");
+        const script = yield promises_1.default.readFile(fullFilePath, "utf8");
         results.push({
             type: "down",
             fullFilePath,
             filename: path_1.default.basename(fullFilePath),
             upFilename: migration.name,
-            contents,
+            script,
         });
     }
     return results;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stepwise-migrations",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -15,6 +15,7 @@
   "author": "github.com/mj1618",
   "license": "MIT",
   "devDependencies": {
+    "@types/git-diff": "^2.0.7",
     "@types/pg": "^8.11.10",
     "@types/yargs": "^17.0.33"
   },
@@ -22,6 +23,7 @@
     "stepwise-migrations": "dist/index.js"
   },
   "dependencies": {
+    "git-diff": "^2.0.6",
     "pg": "^8.13.1",
     "yargs": "^17.7.2"
   }

package/src/db.ts

@@ -1,5 +1,5 @@
 import pg, { Pool, PoolClient } from "pg";
-import { MigrationRow } from "./types";
+import { AuditRow, MigrationRow } from "./types";
 
 pg.types.setTypeParser(1114, function (stringValue) {
   return stringValue; //1114 for time without timezone type
@@ -61,19 +61,48 @@ export const dbCreateSchema = async (client: PoolClient, schema: string) => {
   console.log(`done!`);
 };
 
+export const dbAuditHistory = async (client: PoolClient, schema: string) => {
+  const auditQuery = await client.query(
+    `SELECT * FROM ${schema}.stepwise_audit`
+  );
+  return auditQuery.rows as AuditRow[];
+};
+
 export const dbCreateHistoryTable = async (
   client: PoolClient,
   schema: string
 ) => {
   process.stdout.write(`Creating migration history table... `);
   await client.query(
-    `CREATE TABLE IF NOT EXISTS ${schema}.stepwise_migrations (
-    id SERIAL PRIMARY KEY,
-    name TEXT UNIQUE NOT NULL,
-    hash TEXT NOT NULL,
-    applied_by TEXT NOT NULL DEFAULT current_user,
-    applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
-    )`
+    `
+CREATE TABLE IF NOT EXISTS ${schema}.stepwise_migrations (
+  id SERIAL PRIMARY KEY,
+  name TEXT UNIQUE NOT NULL,
+  script TEXT NOT NULL,
+  applied_by TEXT NOT NULL DEFAULT current_user,
+  applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+CREATE TABLE IF NOT EXISTS ${schema}.stepwise_audit (
+  id SERIAL PRIMARY KEY,
+  type TEXT NOT NULL,
+  name TEXT UNIQUE NOT NULL,
+  script TEXT NOT NULL,
+  applied_by TEXT NOT NULL DEFAULT current_user,
+  applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+    `
   );
   console.log(`done!`);
 };
+
+export const dbGetScript = async (
+  client: PoolClient,
+  schema: string,
+  filename: string
+) => {
+  const script = await client.query(
+    `SELECT script FROM ${schema}.stepwise_audit WHERE name = $1`,
+    [filename]
+  );
+  return script.rows[0].script;
+};

package/src/index.ts

@@ -2,9 +2,11 @@
 
 import yargs from "yargs";
 import {
+  dbAuditHistory,
   dbConnect,
   dbCreateHistoryTable,
   dbCreateSchema,
+  dbGetScript,
   dbHistorySchemaExists,
   dbMigrationHistory,
   dbTableExists,
@@ -16,8 +18,11 @@ import {
   validateMigrationFiles,
 } from "./migrate";
 import {
+  printMigrationHistory,
+  printMigrationHistoryAndUnappliedMigrations,
   readDownMigrationFiles,
   readMigrationFiles,
+  usage,
   validateArgs,
 } from "./utils";
 
@@ -47,18 +52,26 @@ const main = async () => {
 
     validateMigrationFiles(migrationFiles, migrationHistory);
 
+    if (migrationFiles.length === migrationHistory.length) {
+      console.log("All migrations are already applied");
+      process.exit(0);
+    }
+
     const migrationsToApply = migrationFiles.slice(
       migrationHistory.length,
       migrationHistory.length + nUp
     );
 
-    for (const { filename, contents, hash } of migrationsToApply) {
-      await applyMigration(client, schema, filename, contents, hash);
+    for (const { filename, script } of migrationsToApply) {
+      await applyMigration(client, schema, filename, script);
     }
 
     console.log(`All done! Applied ${migrationsToApply.length} migrations`);
-    console.log("New migration history:");
-    console.table(await dbMigrationHistory(client, schema));
+
+    printMigrationHistoryAndUnappliedMigrations(
+      await readMigrationFiles(argv.path),
+      await dbMigrationHistory(client, schema)
+    );
   } else if (command === "info") {
     if (!historySchemaExists) {
       console.log("Schema does not exist");
@@ -69,9 +82,29 @@ const main = async () => {
     }
 
     if (historySchemaExists && tableExists) {
-      console.log("Migration history:");
-      console.table(await dbMigrationHistory(client, schema));
+      printMigrationHistory(await dbMigrationHistory(client, schema));
+    }
+  } else if (command === "validate") {
+    if (!historySchemaExists) {
+      console.log("Schema does not exist");
+    }
+
+    if (!tableExists) {
+      console.log("Migration history table does not exist");
+    }
+
+    if (historySchemaExists && tableExists) {
+      validateMigrationFiles(
+        await readMigrationFiles(argv.path),
+        await dbMigrationHistory(client, schema)
+      );
     }
+    console.log("Validation passed");
+
+    printMigrationHistoryAndUnappliedMigrations(
+      await readMigrationFiles(argv.path),
+      await dbMigrationHistory(client, schema)
+    );
   } else if (command === "drop") {
     process.stdout.write(
       `Dropping the tables, schema and migration history table... `
@@ -98,18 +131,38 @@ const main = async () => {
       downMigrationFilesToApply,
       reverseMigrationHistory
     );
-    for (const {
-      filename,
-      contents,
-      upFilename,
-    } of downMigrationFilesToApply) {
-      await applyDownMigration(client, schema, filename, contents, upFilename);
+    for (const { filename, script, upFilename } of downMigrationFilesToApply) {
+      await applyDownMigration(client, schema, filename, script, upFilename);
     }
     console.log(
-      `All done! Applied ${downMigrationFilesToApply.length} down migrations`
+      `All done! Applied ${downMigrationFilesToApply.length} down migration${
+        downMigrationFilesToApply.length === 1 ? "" : "s"
+      }`
+    );
+
+    printMigrationHistoryAndUnappliedMigrations(
+      await readMigrationFiles(argv.path),
+      await dbMigrationHistory(client, schema)
+    );
+  } else if (command === "audit") {
+    const auditHistory = await dbAuditHistory(client, schema);
+    console.log("Audit history:");
+    console.table(
+      auditHistory.map((row) => ({
+        id: row.id,
+        type: row.type,
+        name: row.name,
+        applied_by: row.applied_by,
+        applied_at: row.applied_at,
+      }))
     );
-    console.log("New migration history:");
-    console.table(await dbMigrationHistory(client, schema));
+  } else if (command === "get-script") {
+    const script = await dbGetScript(client, schema, argv.filename);
+    console.log(script);
+  } else {
+    console.error(`Invalid command: ${argv._[0]}`);
+    console.log(usage);
+    process.exit(1);
   }
 
   client.release();

package/src/migrate.ts

@@ -1,8 +1,9 @@
+import gitDiff from "git-diff";
 import { PoolClient } from "pg";
 import { MigrationRow } from "./types";
 
 export const validateMigrationFiles = (
-  migrationFiles: { fullFilePath: string; filename: string; hash: string }[],
+  migrationFiles: { fullFilePath: string; filename: string; script: string }[],
   migrationHistory: MigrationRow[],
   isUp: boolean = true
 ) => {
@@ -18,13 +19,8 @@ export const validateMigrationFiles = (
     process.exit(1);
   }
 
-  if (migrationFiles.length === migrationHistory.length && isUp) {
-    console.log("All migrations are already applied");
-    process.exit(0);
-  }
-
   for (let i = 0; i < migrationFiles.length; i++) {
-    const { filename, hash: migrationHash } = migrationFiles[i];
+    const { filename, script: migrationScript } = migrationFiles[i];
     if (i >= migrationHistory.length) {
       continue;
     }
@@ -32,10 +28,18 @@ export const validateMigrationFiles = (
       console.error(`Error: migration ${filename} has been renamed, aborting.`);
       process.exit(1);
     }
-    if (migrationHistory[i].hash !== migrationHash) {
+    if (migrationHistory[i].script !== migrationScript) {
       console.error(
         `Error: migration ${filename} has been modified, aborting.`
       );
+
+      console.log(
+        gitDiff(migrationHistory[i].script, migrationScript, {
+          color: true,
+          noHeaders: true,
+        })
+      );
+
       process.exit(1);
     }
   }
@@ -45,8 +49,7 @@ export const applyMigration = async (
   client: PoolClient,
   schema: string,
   filename: string,
-  contents: string,
-  hash: string
+  script: string
 ) => {
   try {
     process.stdout.write(`Applying migration ${filename}... `);
@@ -54,12 +57,17 @@ export const applyMigration = async (
 
     await client.query(
       `SET search_path TO ${schema};
-    ${contents.toString()}`
+    ${script.toString()}`
     );
 
     await client.query(
-      `INSERT INTO ${schema}.stepwise_migrations (name, hash) VALUES ($1, $2)`,
-      [filename, hash]
+      `INSERT INTO ${schema}.stepwise_migrations (name, script) VALUES ($1, $2)`,
+      [filename, script]
+    );
+
+    await client.query(
+      `INSERT INTO ${schema}.stepwise_audit (type, name, script) VALUES ($1, $2, $3)`,
+      ["up", filename, script]
     );
 
     await client.query("COMMIT");
@@ -98,7 +106,7 @@ export const applyDownMigration = async (
   client: PoolClient,
   schema: string,
   filename: string,
-  contents: string,
+  script: string,
   upFilename: string
 ) => {
   try {
@@ -107,7 +115,7 @@ export const applyDownMigration = async (
 
     await client.query(
       `SET search_path TO ${schema};
-    ${contents.toString()}`
+    ${script.toString()}`
     );
 
     await client.query(
@@ -115,6 +123,11 @@ export const applyDownMigration = async (
       [upFilename]
     );
 
+    await client.query(
+      `INSERT INTO ${schema}.stepwise_audit (type, name, script) VALUES ($1, $2, $3)`,
+      ["down", filename, script]
+    );
+
     await client.query("COMMIT");
 
     console.log(`done!`);

package/src/types.ts

@@ -1,7 +1,9 @@
 export interface MigrationRow {
   id: string;
   name: string;
-  hash: string;
+  script: string;
   applied_by: string;
   applied_at: string;
 }
+
+export type AuditRow = MigrationRow & { type: "up" | "down" };

package/src/utils.ts

@@ -1,12 +1,7 @@
-import crypto from "crypto";
 import fs from "fs/promises";
 import path from "path";
 import { MigrationRow } from "./types";
 
-export const calculateHash = (contents: string) => {
-  return crypto.createHash("sha256").update(contents).digest("hex");
-};
-
 export const usage = `
 Usage: stepwise-migrations [command] [options]
 
@@ -50,16 +45,6 @@ export const validateArgs = (argv: any) => {
     console.log(usage);
     process.exit(1);
   }
-  if (
-    argv._[0] !== "migrate" &&
-    argv._[0] !== "info" &&
-    argv._[0] !== "drop" &&
-    argv._[0] !== "down"
-  ) {
-    console.error(`Invalid command: ${argv._[0]}`);
-    console.log(usage);
-    process.exit(1);
-  }
 };
 
 export const readMigrationFiles = async (directory: string) => {
@@ -77,23 +62,54 @@ export const readMigrationFiles = async (directory: string) => {
     type: "up";
     fullFilePath: string;
     filename: string;
-    hash: string;
-    contents: string;
+    script: string;
   }[] = [];
   for (const fullFilePath of migrationFiles) {
-    const contents = await fs.readFile(fullFilePath, "utf8");
+    const script = await fs.readFile(fullFilePath, "utf8");
 
     results.push({
       type: "up",
       fullFilePath,
       filename: path.basename(fullFilePath),
-      hash: calculateHash(contents),
-      contents,
+      script,
     });
   }
   return results;
 };
 
+export const printMigrationHistoryAndUnappliedMigrations = (
+  migrationFiles: { filename: string }[],
+  migrationHistory: MigrationRow[]
+) => {
+  console.log("Migration history:");
+  console.table(
+    migrationHistory.map((h) => ({
+      id: h.id,
+      name: h.name,
+      applied_by: h.applied_by,
+      applied_at: h.applied_at,
+    }))
+  );
+  console.log("Unapplied migrations:");
+  console.table(
+    migrationFiles.slice(migrationHistory.length).map((m) => ({
+      filename: m.filename,
+    }))
+  );
+};
+
+export const printMigrationHistory = (migrationHistory: MigrationRow[]) => {
+  console.log("Migration history:");
+  console.table(
+    migrationHistory.map((h) => ({
+      id: h.id,
+      name: h.name,
+      applied_by: h.applied_by,
+      applied_at: h.applied_at,
+    }))
+  );
+};
+
 export const fileExists = async (path: string) => {
   try {
     return (await fs.stat(path)).isFile();
@@ -112,7 +128,7 @@ export const readDownMigrationFiles = async (
     filename: string;
     upFilename: string;
 
-    contents: string;
+    script: string;
   }[] = [];
   for (const migration of migrationHistory) {
     const fullFilePath = path.join(
@@ -123,13 +139,13 @@ export const readDownMigrationFiles = async (
       console.error(`Down migration file not found: ${fullFilePath}`);
       process.exit(1);
     }
-    const contents = await fs.readFile(fullFilePath, "utf8");
+    const script = await fs.readFile(fullFilePath, "utf8");
     results.push({
       type: "down",
       fullFilePath,
       filename: path.basename(fullFilePath),
       upFilename: migration.name,
-      contents,
+      script,
     });
   }
   return results;