@sebspark/spanner-migrate 0.1.0 → 0.1.1

package/README.md

@@ -1,3 +1,104 @@
-# `@sebspark/spanner-migrate`
+# @sebspark/spanner-migrate
 
-Migration tool for Spanner DB
+`spanner-migrate` is a CLI tool for managing schema migrations for Google Cloud Spanner. It simplifies schema evolution by allowing you to create, apply, rollback, and track migrations.
+
+---
+
+## Installation
+
+Install `@sebspark/spanner-migrate` as a global package:
+
+```zsh
+yarn add -D @sebspark/spanner-migrate
+```
+
+---
+
+## CLI Usage
+
+Run `spanner-migrate` from your project root. If no command is provided, the help message is displayed.
+
+```zsh
+spanner-migrate [command] [options]
+```
+
+### Commands
+
+#### `init`
+Initialize a Spanner migration configuration file (`.spanner-migrate.config.json`).
+
+**Usage:**
+
+```zsh
+spanner-migrate init
+```
+
+**Prompts:**
+- `Enter the path for your migrations`: Directory for migration files (default: `./migrations`).
+- `Enter Spanner instance name`: The name of the Spanner instance.
+- `Enter Spanner database name`: The name of the Spanner database.
+- `Enter Google Cloud project name`: (Optional) The Google Cloud project name.
+
+---
+
+#### `create <description>`
+Create a new migration file.
+
+**Usage:**
+
+```zsh
+spanner-migrate create add users table
+```
+
+#### `up`
+Apply pending migrations
+
+**Usage:**
+
+```zsh
+spanner-migrate up
+```
+
+If you don't want to apply all pending migrations, use the `--max` or `-m` flag
+
+```zsh
+spanner migrate up --max 1
+```
+
+#### `down`
+Rollback one migration
+
+**Usage:**
+
+```zsh
+spanner-migrate down
+```
+
+#### `status`
+Check migration status
+
+**Usage:**
+
+```zsh
+spanner-migrate status
+```
+Displays an overview of applied and peding migrations
+
+```text
+Migrations
+
+Applied
+--------------------------------------------------------------------------------
+20250122080434866_add_users_table
+20250122080444982_add_index_on_users
+
+New
+--------------------------------------------------------------------------------
+20250122080444982_add_index_on_users
+```
+
+---
+
+## License
+
+[Apache-2.0](LICENSE)

package/dist/cli.js

@@ -26,6 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 // src/cli.ts
 var import_promises2 = __toESM(require("fs/promises"));
 var import_node_path2 = require("path");
+var import_input = __toESM(require("@inquirer/input"));
 var import_yargs = __toESM(require("yargs"));
 var import_helpers = require("yargs/helpers");
 
@@ -314,36 +315,34 @@ async function loadConfig() {
     process.exit(1);
   }
 }
-(0, import_yargs.default)((0, import_helpers.hideBin)(process.argv)).scriptName("spanner-migrate").usage("$0 <command> [options]").command(
+(0, import_yargs.default)((0, import_helpers.hideBin)(process.argv)).scriptName("spanner-migrate").usage("$0 <command>").command(
   "init",
   "Initialize a .spanner-migrate.config.json file",
-  (yargs2) => {
-    yargs2.option("migrationsPath", {
-      type: "string",
-      describe: "Path to the migrations folder",
-      default: "./spanner-migrations"
+  async () => {
+    const migrationsPath = await (0, import_input.default)({
+      message: "Enter the path for your migrations",
+      required: true,
+      default: "./migrations"
     });
-    yargs2.option("instanceName", {
-      type: "string",
-      describe: "Spanner instance name",
-      demandOption: true
+    const instanceName = await (0, import_input.default)({
+      message: "Enter Spanner instance name",
+      required: true
     });
-    yargs2.option("databaseName", {
-      type: "string",
-      describe: "Spanner database name",
-      demandOption: true
+    const databaseName = await (0, import_input.default)({
+      message: "Enter Spanner database name",
+      required: true
     });
-    yargs2.option("projectName", {
-      type: "string",
-      describe: "Google Cloud project name (optional)"
+    const projectId = await (0, import_input.default)({
+      message: "Enter Google Cloud project name",
+      required: false
     });
-  },
-  async (args) => {
-    await init(args, CONFIG_FILE);
+    const config = { instanceName, databaseName, migrationsPath };
+    if (projectId) config.projectId = projectId;
+    await init(config, CONFIG_FILE);
     console.log(`Configuration written to ${CONFIG_FILE}`);
   }
 ).command(
-  "create <description>",
+  "create <description ...>",
   "Create a new migration file",
   (yargs2) => {
     yargs2.positional("description", {
@@ -354,9 +353,10 @@ async function loadConfig() {
   },
   async (args) => {
     const config = await loadConfig();
-    await create(config, args.description);
+    const fullDescription = args.description.join(" ");
+    await create(config, fullDescription);
     console.log(
-      `Migration file created: '${(0, import_node_path2.join)(config.migrationsPath, args.description)}'`
+      `Migration file created: '${(0, import_node_path2.join)(config.migrationsPath, args.description.join("_"))}.ts'`
     );
   }
 ).command(
@@ -383,4 +383,4 @@ async function loadConfig() {
   const config = await loadConfig();
   const migrationStatus = await status(config);
   console.log(migrationStatus);
-}).help().strict().parse();
+}).demandCommand().help().parse();

package/dist/cli.mjs

@@ -10,6 +10,7 @@ import {
 // src/cli.ts
 import fs from "node:fs/promises";
 import { join } from "node:path";
+import input from "@inquirer/input";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 var CONFIG_FILE = "./.spanner-migrate.config.json";
@@ -22,36 +23,34 @@ async function loadConfig() {
     process.exit(1);
   }
 }
-yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command> [options]").command(
+yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command>").command(
   "init",
   "Initialize a .spanner-migrate.config.json file",
-  (yargs2) => {
-    yargs2.option("migrationsPath", {
-      type: "string",
-      describe: "Path to the migrations folder",
-      default: "./spanner-migrations"
+  async () => {
+    const migrationsPath = await input({
+      message: "Enter the path for your migrations",
+      required: true,
+      default: "./migrations"
     });
-    yargs2.option("instanceName", {
-      type: "string",
-      describe: "Spanner instance name",
-      demandOption: true
+    const instanceName = await input({
+      message: "Enter Spanner instance name",
+      required: true
     });
-    yargs2.option("databaseName", {
-      type: "string",
-      describe: "Spanner database name",
-      demandOption: true
+    const databaseName = await input({
+      message: "Enter Spanner database name",
+      required: true
     });
-    yargs2.option("projectName", {
-      type: "string",
-      describe: "Google Cloud project name (optional)"
+    const projectId = await input({
+      message: "Enter Google Cloud project name",
+      required: false
     });
-  },
-  async (args) => {
-    await init(args, CONFIG_FILE);
+    const config = { instanceName, databaseName, migrationsPath };
+    if (projectId) config.projectId = projectId;
+    await init(config, CONFIG_FILE);
     console.log(`Configuration written to ${CONFIG_FILE}`);
   }
 ).command(
-  "create <description>",
+  "create <description ...>",
   "Create a new migration file",
   (yargs2) => {
     yargs2.positional("description", {
@@ -62,9 +61,10 @@ yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command> [
   },
   async (args) => {
     const config = await loadConfig();
-    await create(config, args.description);
+    const fullDescription = args.description.join(" ");
+    await create(config, fullDescription);
     console.log(
-      `Migration file created: '${join(config.migrationsPath, args.description)}'`
+      `Migration file created: '${join(config.migrationsPath, args.description.join("_"))}.ts'`
     );
   }
 ).command(
@@ -91,4 +91,4 @@ yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command> [
   const config = await loadConfig();
   const migrationStatus = await status(config);
   console.log(migrationStatus);
-}).help().strict().parse();
+}).demandCommand().help().parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/spanner-migrate",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -31,6 +31,7 @@
     "@google-cloud/spanner": "*"
   },
   "dependencies": {
+    "@inquirer/input": "4.1.3",
     "yargs": "17.7.2"
   }
 }