stepwise-migrations 1.0.26 → 1.0.28

package/README.md

@@ -62,7 +62,7 @@ There are three types of migrations:
 ## Usage
 
 ```text
-Usage: stepwise-migrations [command] [options]
+Usage: stepwise-migrations <command> [options]
 
 Commands:
   migrate

package/dist/src/index.js

@@ -14,12 +14,90 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
 const commands_1 = require("./commands");
 const utils_1 = require("./utils");
 const main = () => __awaiter(void 0, void 0, void 0, function* () {
-    const argv = (0, yargs_1.default)(process.argv.slice(2)).argv;
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .command("migrate", "Migrate the database to the latest version", (yargs) => {
+        return yargs.options({
+            napply: {
+                type: "number",
+                describe: "Number of migrations to apply, defaults to all",
+            },
+        });
+    })
+        .command("validate", "Validate the migration files and the stepwise_migration_events table")
+        .command("info", "Show information about the current state of the migrations in the database and in the migration files")
+        .command("status", "Only show the status of the migrations in the database, not the migration files")
+        .command("undo", "Rollback the database to the previous version", (yargs) => {
+        return yargs.options({
+            nundo: {
+                type: "number",
+                describe: "Number of migrations to undo, defaults to 1",
+            },
+        });
+    })
+        .command("get-applied-script", "Get the script for the last applied migration", (yargs) => {
+        return yargs.options({
+            filename: {
+                type: "string",
+                describe: "The filename to get the script for",
+            },
+        });
+    })
+        .command("drop", "Drop the tables, schema and migration history table")
+        .command("baseline", "Without applying any migrations, set the migration table state to a specific version", (yargs) => {
+        return yargs.options({
+            filename: {
+                type: "string",
+                describe: "The filename to baseline to",
+                default: null,
+            },
+        });
+    })
+        .options({
+        connection: {
+            type: "string",
+            demandOption: true,
+            alias: "c",
+            describe: "The connection string to use to connect to the database",
+        },
+        schema: {
+            type: "string",
+            default: "public",
+            alias: "s",
+            describe: "The schema to use for the migrations",
+        },
+        ssl: {
+            type: "boolean",
+            default: false,
+            describe: "Whether to use SSL for the connection",
+        },
+        path: {
+            type: "string",
+            default: "./",
+            alias: "p",
+            describe: "The path to the migrations directory",
+        },
+    })
+        .example([
+        [
+            `npx stepwise-migrations migrate \\
+      --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \\
+      --schema=myschema \\
+      --path=./test/migrations-template/`,
+            "Migrate the database to the latest version",
+        ],
+    ])
+        .wrap(yargs_1.default.terminalWidth())
+        .demandCommand(1)
+        .recommendCommands()
+        .strict()
+        .help()
+        .version(false)
+        .parse();
     const args = (0, utils_1.parseArgs)(argv);
-    (0, utils_1.validateArgs)(args);
     const command = args.command;
     if (command === "migrate") {
         yield (0, commands_1.migrateCommand)(args);

package/dist/test/index.test.js

@@ -12,7 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_test_1 = require("node:test");
 const utils_1 = require("./utils");
@@ -29,16 +28,18 @@ const executeCommand = (command, path = "", extraArgs = "") => (0, utils_1.execu
   `);
 (0, node_test_1.describe)("valid migrations", () => __awaiter(void 0, void 0, void 0, function* () {
     (0, node_test_1.beforeEach)(() => __awaiter(void 0, void 0, void 0, function* () {
-        const { output, error, exitCode } = yield executeCommand("drop", "");
-        node_assert_1.default.ok(output.includes("Dropping the tables, schema and migration history table... done!"));
-        node_assert_1.default.ok(exitCode === 0);
+        (0, utils_1.assertIncludesAll)(yield executeCommand("drop", ""), [
+            "Dropping the tables, schema and migration history table... done!",
+        ]);
         node_fs_1.default.rmSync(paths.valid, { recursive: true, force: true });
         node_fs_1.default.cpSync("./test/migrations-template", paths.valid, {
             recursive: true,
         });
     }));
     (0, node_test_1.it)("migrate without params", () => __awaiter(void 0, void 0, void 0, function* () {
-        (0, utils_1.assertIncludesAll)(yield (0, utils_1.execute)("npm exec stepwise-migrations"), ["Usage"]);
+        (0, utils_1.assertIncludesAll)(yield (0, utils_1.execute)("npm exec stepwise-migrations"), [
+            "stepwise-migrations <command>",
+        ]);
     }));
     (0, node_test_1.it)("baseline", () => __awaiter(void 0, void 0, void 0, function* () {
         (0, utils_1.assertIncludesAll)(yield executeCommand("baseline", paths.valid), [
@@ -106,22 +107,22 @@ const executeCommand = (command, path = "", extraArgs = "") => (0, utils_1.execu
         ]);
     }));
 }));
-(0, node_test_1.describe)("invalid migrations", () => __awaiter(void 0, void 0, void 0, function* () {
+node_test_1.describe.only("invalid migrations", () => __awaiter(void 0, void 0, void 0, function* () {
     (0, node_test_1.beforeEach)(() => __awaiter(void 0, void 0, void 0, function* () {
-        const { output, error, exitCode } = yield executeCommand("drop", "");
-        node_assert_1.default.ok(output.includes("Dropping the tables, schema and migration history table... done!"));
-        node_assert_1.default.ok(exitCode === 0);
+        (0, utils_1.assertIncludesAll)(yield executeCommand("drop", ""), [
+            "Dropping the tables, schema and migration history table... done!",
+        ]);
         node_fs_1.default.rmSync(paths.invalid, { recursive: true, force: true });
         node_fs_1.default.cpSync("./test/migrations-template", paths.invalid, {
             recursive: true,
         });
     }));
-    (0, node_test_1.it)("missing undo migration", () => __awaiter(void 0, void 0, void 0, function* () {
+    node_test_1.it.only("missing undo migration", () => __awaiter(void 0, void 0, void 0, function* () {
         (0, utils_1.assertIncludesAll)(yield executeCommand("migrate", paths.invalid), [
             "All done!",
         ]);
         node_fs_1.default.unlinkSync("./test/migrations-invalid/v3_third.undo.sql");
-        (0, utils_1.assertIncludesAll)(yield executeCommand("undo", paths.invalid, "--nundos=2"), ["Error: not enough sequential (from last) undo migrations to apply"]);
+        (0, utils_1.assertIncludesAll)(yield executeCommand("undo", paths.invalid, "--nundo=2"), ["Error: not enough sequential (from last) undo migrations to apply"]);
     }));
     (0, node_test_1.it)("alter migration", () => __awaiter(void 0, void 0, void 0, function* () {
         (0, utils_1.assertIncludesAll)(yield executeCommand("migrate", paths.invalid), [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stepwise-migrations",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "description": "A JavaScript CLI tool for managing Raw SQL migrations in a Postgres database. Loosely based on flyway.",
   "main": "./dist/src/index.js",
   "scripts": {

package/src/db/pg.ts

@@ -10,10 +10,9 @@ pg.types.setTypeParser(1082, function (stringValue) {
   return stringValue; //1082 for date type
 });
 
-export const _dbConnect = async ({ ssl, connection, schema }: Args) => {
+export const _dbConnect = async ({ connection, schema }: Args) => {
   const pool = new Pool({
     connectionString: connection,
-    ssl: ssl === "true",
   });
 
   let client: PoolClient | undefined;

package/src/index.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
 import {
   auditCommand,
   baselineCommand,
@@ -12,14 +13,109 @@ import {
   undoCommand,
   validateCommand,
 } from "./commands";
-import { parseArgs, usage, validateArgs } from "./utils";
-
+import { parseArgs, usage } from "./utils";
 const main = async () => {
-  const argv: any = yargs(process.argv.slice(2)).argv;
+  const argv = yargs(hideBin(process.argv))
+    .command(
+      "migrate",
+      "Migrate the database to the latest version",
+      (yargs) => {
+        return yargs.options({
+          napply: {
+            type: "number",
+            describe: "Number of migrations to apply, defaults to all",
+          },
+        });
+      }
+    )
+    .command(
+      "validate",
+      "Validate the migration files and the stepwise_migration_events table"
+    )
+    .command(
+      "info",
+      "Show information about the current state of the migrations in the database and in the migration files"
+    )
+    .command(
+      "status",
+      "Only show the status of the migrations in the database, not the migration files"
+    )
+    .command(
+      "undo",
+      "Rollback the database to the previous version",
+      (yargs) => {
+        return yargs.options({
+          nundo: {
+            type: "number",
+            describe: "Number of migrations to undo, defaults to 1",
+          },
+        });
+      }
+    )
+    .command(
+      "get-applied-script",
+      "Get the script for the last applied migration",
+      (yargs) => {
+        return yargs.options({
+          filename: {
+            type: "string",
+            describe: "The filename to get the script for",
+          },
+        });
+      }
+    )
+    .command("drop", "Drop the tables, schema and migration history table")
+    .command(
+      "baseline",
+      "Without applying any migrations, set the migration table state to a specific version",
+      (yargs) => {
+        return yargs.options({
+          filename: {
+            type: "string",
+            describe: "The filename to baseline to",
+            default: null,
+          },
+        });
+      }
+    )
+    .options({
+      connection: {
+        type: "string",
+        demandOption: true,
+        alias: "c",
+        describe: "The connection string to use to connect to the database",
+      },
+      schema: {
+        type: "string",
+        default: "public",
+        alias: "s",
+        describe: "The schema to use for the migrations",
+      },
+      path: {
+        type: "string",
+        default: "./",
+        alias: "p",
+        describe: "The path to the migrations directory",
+      },
+    })
+    .example([
+      [
+        `npx stepwise-migrations migrate \\
+      --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \\
+      --schema=myschema \\
+      --path=./test/migrations-template/`,
+        "Migrate the database to the latest version",
+      ],
+    ])
+    .wrap(yargs.terminalWidth())
+    .demandCommand(1)
+    .recommendCommands()
+    .strict()
+    .help()
+    .version(false)
+    .parse();
 
   const args = parseArgs(argv);
-  validateArgs(args);
-
   const command = args.command;
 
   if (command === "migrate") {

package/src/utils.ts

@@ -34,7 +34,6 @@ Options:
   --connection <connection>  The connection string to use to connect to the database
   --schema <schema>          The schema to use for the migrations (default: public)
   --path <path>              The path to the migrations directory
-  --ssl true/false           Whether to use SSL for the connection (default: false)
   --napply                   Number of up migrations to apply (default: all)
   --nundo                    Number of undo migrations to apply (default: 1)
   --filename                 (get-applied-script) The filename to get the script for (default: last applied migration)
@@ -42,7 +41,7 @@ Options:
 
 Example:
   npx stepwise-migrations migrate \
-    --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \
+    --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase\?sslmode=require \
     --schema=myschema \
     --path=./test/migrations-template/
 `;
@@ -55,7 +54,6 @@ export type Args = {
   filePath: string;
   connection: string;
   filename?: string;
-  ssl: string;
 };
 
 export const parseArgs = (argv: any): Args => {
@@ -65,7 +63,6 @@ export const parseArgs = (argv: any): Args => {
   const nundo = argv.nundo || 1;
   const filePath = argv.path;
   const connection = argv.connection;
-  const ssl = argv.ssl ?? "false";
   const filename = argv.filename;
 
   return {
@@ -75,7 +72,6 @@ export const parseArgs = (argv: any): Args => {
     nundo,
     filePath,
     connection,
-    ssl,
     filename,
   };
 };

package/test/index.test.ts

@@ -1,4 +1,3 @@
-import assert from "node:assert";
 import fs from "node:fs";
 import { beforeEach, describe, it } from "node:test";
 import { assertIncludesAll, assertIncludesExcludesAll, execute } from "./utils";
@@ -23,13 +22,9 @@ const executeCommand = (
 
 describe("valid migrations", async () => {
   beforeEach(async () => {
-    const { output, error, exitCode } = await executeCommand("drop", "");
-    assert.ok(
-      output.includes(
-        "Dropping the tables, schema and migration history table... done!"
-      )
-    );
-    assert.ok(exitCode === 0);
+    assertIncludesAll(await executeCommand("drop", ""), [
+      "Dropping the tables, schema and migration history table... done!",
+    ]);
 
     fs.rmSync(paths.valid, { recursive: true, force: true });
     fs.cpSync("./test/migrations-template", paths.valid, {
@@ -38,7 +33,9 @@ describe("valid migrations", async () => {
   });
 
   it("migrate without params", async () => {
-    assertIncludesAll(await execute("npm exec stepwise-migrations"), ["Usage"]);
+    assertIncludesAll(await execute("npm exec stepwise-migrations"), [
+      "stepwise-migrations <command>",
+    ]);
   });
 
   it("baseline", async () => {
@@ -131,15 +128,11 @@ describe("valid migrations", async () => {
   });
 });
 
-describe("invalid migrations", async () => {
+describe.only("invalid migrations", async () => {
   beforeEach(async () => {
-    const { output, error, exitCode } = await executeCommand("drop", "");
-    assert.ok(
-      output.includes(
-        "Dropping the tables, schema and migration history table... done!"
-      )
-    );
-    assert.ok(exitCode === 0);
+    assertIncludesAll(await executeCommand("drop", ""), [
+      "Dropping the tables, schema and migration history table... done!",
+    ]);
 
     fs.rmSync(paths.invalid, { recursive: true, force: true });
     fs.cpSync("./test/migrations-template", paths.invalid, {
@@ -147,7 +140,7 @@ describe("invalid migrations", async () => {
     });
   });
 
-  it("missing undo migration", async () => {
+  it.only("missing undo migration", async () => {
     assertIncludesAll(await executeCommand("migrate", paths.invalid), [
       "All done!",
     ]);
@@ -155,7 +148,7 @@ describe("invalid migrations", async () => {
     fs.unlinkSync("./test/migrations-invalid/v3_third.undo.sql");
 
     assertIncludesAll(
-      await executeCommand("undo", paths.invalid, "--nundos=2"),
+      await executeCommand("undo", paths.invalid, "--nundo=2"),
       ["Error: not enough sequential (from last) undo migrations to apply"]
     );
   });