forge-sql-orm 1.0.13 → 1.0.16

package/scripts/cli.ts

@@ -0,0 +1,221 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import dotenv from "dotenv";
+import inquirer from "inquirer";
+import { generateModels } from "./actions/generate-models";
+import { createMigration } from "./actions/migrations-create";
+import { updateMigration } from "./actions/migrations-update";
+import {runPostInstallPatch} from "./actions/PatchPostinstall";
+
+// 🔄 Load environment variables from `.env` file
+dotenv.config();
+
+/**
+ * Prompts the user for missing parameters using Inquirer.js.
+ * @param config - The current configuration object.
+ * @param defaultOutput - Default output path.
+ * @param customAskMissingParams - Optional function for additional prompts.
+ * @returns Updated configuration with user input.
+ */
+const askMissingParams = async (
+  config: any,
+  defaultOutput: string,
+  customAskMissingParams?: (cfg: any, questions: unknown[]) => void,
+) => {
+  const questions: unknown[] = [];
+
+  if (!config.host)
+    questions.push({
+      type: "input",
+      name: "host",
+      message: "Enter database host:",
+      default: "localhost",
+    });
+
+  if (!config.port)
+    questions.push({
+      type: "input",
+      name: "port",
+      message: "Enter database port:",
+      default: "3306",
+      validate: (input: string) => !isNaN(parseInt(input, 10)),
+    });
+
+  if (!config.user)
+    questions.push({
+      type: "input",
+      name: "user",
+      message: "Enter database user:",
+      default: "root",
+    });
+
+  if (!config.password)
+    questions.push({
+      type: "password",
+      name: "password",
+      message: "Enter database password:",
+      mask: "*",
+    });
+
+  if (!config.dbName)
+    questions.push({
+      type: "input",
+      name: "dbName",
+      message: "Enter database name:",
+    });
+
+  if (!config.output)
+    questions.push({
+      type: "input",
+      name: "output",
+      message: "Enter output path:",
+      default: defaultOutput,
+    });
+
+  // Allow additional questions from the caller
+  if (customAskMissingParams) {
+    customAskMissingParams(config, questions);
+  }
+
+  // If there are missing parameters, prompt the user
+  if (questions.length > 0) {
+    // @ts-ignore - Ignore TypeScript warning for dynamic question type
+    const answers = await inquirer.prompt(questions);
+    return { ...config, ...answers, port: parseInt(answers.port, 10) };
+  }
+
+  return config;
+};
+
+/**
+ * Retrieves configuration parameters from command-line arguments and environment variables.
+ * If any required parameters are missing, prompts the user for input.
+ * @param cmd - The command object containing CLI options.
+ * @param defaultOutput - Default output directory.
+ * @param customConfig - Optional function for additional configuration parameters.
+ * @param customAskMissingParams - Optional function for additional prompts.
+ * @returns A fully resolved configuration object.
+ */
+const getConfig = async (
+  cmd: any,
+  defaultOutput: string,
+  customConfig?: () => any,
+  customAskMissingParams?: (cfg: any, questions: unknown[]) => void,
+) => {
+  let config = {
+    host: cmd.host || process.env.FORGE_SQL_ORM_HOST,
+    port: cmd.port
+      ? parseInt(cmd.port, 10)
+      : process.env.FORGE_SQL_ORM_PORT
+        ? parseInt(process.env.FORGE_SQL_ORM_PORT, 10)
+        : undefined,
+    user: cmd.user || process.env.FORGE_SQL_ORM_USER,
+    password: cmd.password || process.env.FORGE_SQL_ORM_PASSWORD,
+    dbName: cmd.dbName || process.env.FORGE_SQL_ORM_DBNAME,
+    output: cmd.output || process.env.FORGE_SQL_ORM_OUTPUT,
+  };
+
+  // Merge additional configurations if provided
+  if (customConfig) {
+    config = { ...config, ...customConfig() };
+  }
+
+  return await askMissingParams(config, defaultOutput, customAskMissingParams);
+};
+
+// 📌 Initialize CLI
+const program = new Command();
+program.version("1.0.0");
+
+// ✅ Command: Generate database models (Entities)
+program
+  .command("generate:model")
+  .description("Generate MikroORM models from the database.")
+  .option("--host <string>", "Database host")
+  .option("--port <number>", "Database port")
+  .option("--user <string>", "Database user")
+  .option("--password <string>", "Database password")
+  .option("--dbName <string>", "Database name")
+  .option("--output <string>", "Output path for entities")
+  .action(async (cmd) => {
+    const config = await getConfig(cmd, "./database/entities");
+    await generateModels(config);
+  });
+
+// ✅ Command: Create initial database migration
+program
+  .command("migrations:create")
+  .description("Generate an initial migration for the entire database.")
+  .option("--host <string>", "Database host")
+  .option("--port <number>", "Database port")
+  .option("--user <string>", "Database user")
+  .option("--password <string>", "Database password")
+  .option("--dbName <string>", "Database name")
+  .option("--output <string>", "Output path for migrations")
+  .option("--entitiesPath <string>", "Path to the folder containing entities")
+  .action(async (cmd) => {
+    const config = await getConfig(
+      cmd,
+      "./database/migration",
+      () => ({
+        entitiesPath: cmd.entitiesPath || process.env.FORGE_SQL_ORM_ENTITIES_PATH,
+      }),
+      (cfg, questions: unknown[]) => {
+        if (!cfg.entitiesPath)
+          questions.push({
+            type: "input",
+            name: "entitiesPath",
+            message: "Enter the path to entities:",
+            default: "./database/entities",
+          });
+      },
+    );
+    await createMigration(config);
+  });
+
+// ✅ Command: Update migration for schema changes
+program
+  .command("migrations:update")
+  .description("Generate a migration to update the database schema.")
+  .option("--host <string>", "Database host")
+  .option("--port <number>", "Database port")
+  .option("--user <string>", "Database user")
+  .option("--password <string>", "Database password")
+  .option("--dbName <string>", "Database name")
+  .option("--output <string>", "Output path for migrations")
+  .option("--entitiesPath <string>", "Path to the folder containing entities")
+  .action(async (cmd) => {
+    const config = await getConfig(
+      cmd,
+      "./database/migration",
+      () => ({
+        entitiesPath: cmd.entitiesPath || process.env.FORGE_SQL_ORM_ENTITIES_PATH,
+      }),
+      (cfg, questions: unknown[]) => {
+        if (!cfg.entitiesPath)
+          questions.push({
+            type: "input",
+            name: "entitiesPath",
+            message: "Enter the path to entities:",
+            default: "./database/entities",
+          });
+      },
+    );
+    await updateMigration(config);
+  });
+
+// Patch MikroORM and Knex
+program
+    .command("patch:mikroorm")
+    .description("Patch MikroORM and Knex dependencies to work properly with Forge")
+    .action(async () => {
+      console.log("Running MikroORM patch...");
+      await runPostInstallPatch();
+      await runPostInstallPatch();
+      await runPostInstallPatch();
+      console.log("✅ MikroORM patch applied successfully!");
+    });
+
+// 🔥 Execute CLI
+program.parse(process.argv);

package/{dist-cli → scripts}/forgeSqlCLI.js

@@ -8,10 +8,7 @@ const os = require("os");
 const args = process.argv.slice(2).join(" ");
 
 // Resolve the path to cli.ts (your TypeScript entry file)
-const cliPath = path.resolve(__dirname, "cli.js");
-
-// Detect platform-specific `ts-node` binary paths
-const localTsNode = path.resolve(__dirname, "../node_modules/.bin/ts-node") + (os.platform() === "win32" ? ".cmd" : "");
+const cliPath = path.resolve(__dirname, "cli.ts");
 
 // Function to run a command
 const runCommand = (cmd) => {
@@ -19,7 +16,6 @@ const runCommand = (cmd) => {
         execSync(cmd, { stdio: "inherit", shell: true });
         process.exit(0);
     } catch (e) {
-        console.error("⚠️  Command execution failed:", e.message);
         process.exit(1);
     }
 };
@@ -36,15 +32,9 @@ const isGlobalTsNodeInstalled = (() => {
 
 if (isGlobalTsNodeInstalled) {
     console.log("✅ Using global ts-node");
-    runCommand(`ts-node ${cliPath} ${args}`);
-}
-
-// **2. If not, check for local ts-node**
-if (fs.existsSync(localTsNode)) {
-    console.log("✅ Using local ts-node");
-    runCommand(`"${localTsNode}" ${cliPath} ${args}`);
+    runCommand(`node -r ts-node/register ${cliPath} ${args}`);
 }
 
-// **3. If neither found, fallback to npx**
+// **3. fallback to npx**
 console.warn("⚠️  Neither global nor local ts-node found, using npx...");
-runCommand(`node -r ts-node/register ${cliPath} ${args}`);
+runCommand(`npx node -r ts-node/register ${cliPath} ${args}`);