@openworkflow/cli 0.4.3 → 0.4.5

package/dist/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkC,MAAM,aAAa,CAAC;AAiC3E,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoItE;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDxE;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/D;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAuEf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,YAAY,EAAE;QACZ,KAAK,EAAE,SAAS,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KACzB,CAAC;CACH,CAYA;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAavE;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8D7E;AAwOD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA4CV;AAiWD,UAAU,oBAAoB;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAsBD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkC,MAAM,aAAa,CAAC;AAiC3E,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwHtE;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDxE;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/D;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAuEf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,YAAY,EAAE;QACZ,KAAK,EAAE,SAAS,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KACzB,CAAC;CACH,CAYA;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAavE;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8D7E;AA8OD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA4CV;AAwVD,UAAU,oBAAoB;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAoCD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER"}

package/dist/commands.js

@@ -50,11 +50,8 @@ export async function init(options = {}) {
             message: `Config file already exists at ${configFile}. Override it?`,
             initialValue: false,
         });
-        if (!shouldOverride || p.isCancel(shouldOverride)) {
-            p.cancel("Setup canceled.");
-            // eslint-disable-next-line unicorn/no-process-exit
-            process.exit(0);
-        }
+        if (!shouldOverride || p.isCancel(shouldOverride))
+            cancelSetup();
         configFileToDelete = configFile;
     }
     const backendChoice = await p.select({
@@ -78,11 +75,8 @@ export async function init(options = {}) {
         ],
         initialValue: "sqlite",
     });
-    if (p.isCancel(backendChoice)) {
-        p.cancel("Setup canceled.");
-        // eslint-disable-next-line unicorn/no-process-exit
-        process.exit(0);
-    }
+    if (p.isCancel(backendChoice))
+        cancelSetup();
     const spinner = p.spinner();
     // detect package manager & install packages
     spinner.start("Detecting package manager...");
@@ -104,11 +98,8 @@ export async function init(options = {}) {
         message: "Install packages and set up project files?",
         initialValue: true,
     });
-    if (p.isCancel(shouldSetup)) {
-        p.cancel("Setup canceled.");
-        // eslint-disable-next-line unicorn/no-process-exit
-        process.exit(0);
-    }
+    if (p.isCancel(shouldSetup))
+        cancelSetup();
     if (!shouldSetup) {
         p.outro("Setup skipped.");
         return;
@@ -324,6 +315,14 @@ export async function dashboard(options = {}) {
     });
 }
 // -----------------------------------------------------------------------------
+/**
+ * Show a canceled-setup message and exit the process with status 0.
+ */
+function cancelSetup() {
+    p.cancel("Setup canceled.");
+    // eslint-disable-next-line unicorn/no-process-exit
+    process.exit(0);
+}
 /**
  * Get workflow directories from config.
  * @param config - The loaded config
@@ -390,10 +389,7 @@ function assertNoDuplicateWorkflows(workflows) {
 function warnAboutDuplicateWorkflows(workflows) {
     const duplicates = findDuplicateWorkflows(workflows);
     for (const duplicate of duplicates) {
-        const versionStr = duplicate.version
-            ? ` (version: ${duplicate.version})`
-            : "";
-        consola.warn(`Duplicate workflow detected: "${duplicate.name}"${versionStr}`);
+        consola.warn(`Duplicate workflow detected: ${formatWorkflowIdentity(duplicate.name, duplicate.version)}`);
         consola.warn("Multiple files export a workflow with the same name and version.");
     }
 }
@@ -561,9 +557,8 @@ async function importWorkflows(files) {
         // extract workflow exports (named and default)
         for (const [key, value] of Object.entries(module)) {
             if (isWorkflow(value)) {
-                const workflow = value;
-                workflows.push(workflow);
-                consola.debug(`Found workflow "${workflow.spec.name}" in ${file} (${key})`);
+                workflows.push(value);
+                consola.debug(`Found workflow "${value.spec.name}" in ${file} (${key})`);
             }
         }
     }
@@ -646,24 +641,36 @@ function createConfigFile(configFileName) {
     spinner.stop(`Config written to ${configDestPath}`);
 }
 /**
- * Create hello-world runner file.
- * @param runFileName - The runner filename to write
+ * Write a file under the `openworkflow/` project directory, skipping when a
+ * file with the same name already exists. Progress is surfaced via the clack
+ * spinner using the provided label (e.g. "client file").
+ * @param label - Lowercase label describing the file (used in spinner text)
+ * @param fileName - Filename to write inside `openworkflow/`
+ * @param content - File contents to write when the file does not exist
  */
-function createRunFile(runFileName) {
+function writeWorkflowFileIfMissing(label, fileName, content) {
     const spinner = p.spinner();
     const workflowsDir = path.join(process.cwd(), "openworkflow");
     if (!existsSync(workflowsDir)) {
         mkdirSync(workflowsDir, { recursive: true });
     }
-    const runDestPath = path.join(workflowsDir, runFileName);
-    if (existsSync(runDestPath)) {
-        spinner.start("Checking hello-world runner...");
-        spinner.stop(`Hello-world runner already exists at ${runDestPath}`);
+    const destPath = path.join(workflowsDir, fileName);
+    if (existsSync(destPath)) {
+        spinner.start(`Checking ${label}...`);
+        const capitalized = label.charAt(0).toUpperCase() + label.slice(1);
+        spinner.stop(`${capitalized} already exists at ${destPath}`);
         return;
     }
-    spinner.start("Creating hello-world runner...");
-    writeFileSync(runDestPath, HELLO_WORLD_RUNNER, "utf8");
-    spinner.stop(`Created hello-world runner at ${runDestPath}`);
+    spinner.start(`Creating ${label}...`);
+    writeFileSync(destPath, content, "utf8");
+    spinner.stop(`Created ${label} at ${destPath}`);
+}
+/**
+ * Create hello-world runner file.
+ * @param runFileName - The runner filename to write
+ */
+function createRunFile(runFileName) {
+    writeWorkflowFileIfMissing("hello-world runner", runFileName, HELLO_WORLD_RUNNER);
 }
 /**
  * Create client file.
@@ -671,41 +678,14 @@ function createRunFile(runFileName) {
  * @param clientFileName - The client filename to write
  */
 function createClientFile(backendChoice, clientFileName) {
-    const spinner = p.spinner();
-    const workflowsDir = path.join(process.cwd(), "openworkflow");
-    if (!existsSync(workflowsDir)) {
-        mkdirSync(workflowsDir, { recursive: true });
-    }
-    const clientDestPath = path.join(workflowsDir, clientFileName);
-    if (existsSync(clientDestPath)) {
-        spinner.start("Checking client file...");
-        spinner.stop(`Client file already exists at ${clientDestPath}`);
-        return;
-    }
-    spinner.start("Creating client file...");
-    const clientTemplate = getClientTemplate(backendChoice);
-    writeFileSync(clientDestPath, clientTemplate, "utf8");
-    spinner.stop(`Created client file at ${clientDestPath}`);
+    writeWorkflowFileIfMissing("client file", clientFileName, getClientTemplate(backendChoice));
 }
 /**
  * Create example workflow.
  * @param exampleWorkflowFileName - The example workflow filename to write
  */
 function createExampleWorkflow(exampleWorkflowFileName) {
-    const spinner = p.spinner();
-    const workflowsDir = path.join(process.cwd(), "openworkflow");
-    if (!existsSync(workflowsDir)) {
-        mkdirSync(workflowsDir, { recursive: true });
-    }
-    const helloWorldDestPath = path.join(workflowsDir, exampleWorkflowFileName);
-    if (existsSync(helloWorldDestPath)) {
-        spinner.start("Checking example (hello-world) workflow...");
-        spinner.stop(`Example (hello-world) workflow already exists at ${helloWorldDestPath}`);
-        return;
-    }
-    spinner.start("Creating example (hello-world) workflow...");
-    writeFileSync(helloWorldDestPath, HELLO_WORLD_WORKFLOW, "utf8");
-    spinner.stop(`Created example (hello-world) workflow at ${helloWorldDestPath}`);
+    writeWorkflowFileIfMissing("example (hello-world) workflow", exampleWorkflowFileName, HELLO_WORLD_WORKFLOW);
 }
 /**
  * Update .gitignore for SQLite.
@@ -718,8 +698,8 @@ function updateGitignoreForSqlite() {
     const gitignorePath = path.join(process.cwd(), ".gitignore");
     const spinner = p.spinner();
     spinner.start("Updating .gitignore...");
-    const result = ensureGitignoreEntry(gitignorePath, "openworkflow/backend.db*");
-    spinner.stop(result.added
+    const added = ensureGitignoreEntry(gitignorePath, "openworkflow/backend.db*");
+    spinner.stop(added
         ? "Added openworkflow/backend.db* to .gitignore"
         : "openworkflow/backend.db* already in .gitignore");
 }
@@ -745,38 +725,33 @@ function addWorkerScriptToPackageJson() {
         consola.warn("Could not add worker script to package.json");
     }
 }
+/**
+ * Append a line to a file if no existing line matches. Creates the file if it
+ * doesn't exist.
+ * @param filePath - Path to the file
+ * @param line - Line to append (without a trailing newline)
+ * @param matchesExisting - Predicate that returns true when an existing line
+ * should be treated as already representing `line`
+ * @returns Whether the line was appended
+ */
+function appendLineIfMissing(filePath, line, matchesExisting) {
+    const content = existsSync(filePath) ? readFileSync(filePath, "utf8") : "";
+    if (content.split("\n").some((existing) => matchesExisting(existing))) {
+        return false;
+    }
+    const separator = content === "" || content.endsWith("\n") ? "" : "\n";
+    writeFileSync(filePath, `${content}${separator}${line}\n`, "utf8");
+    return true;
+}
 /**
  * Ensure a specific entry exists in a .gitignore file. Creates the file if it
  * doesn't exist, appends the entry if not present.
  * @param gitignorePath - Path to the .gitignore file
  * @param entry - The entry to add (e.g. "openworkflow/backend.db*")
- * @returns Object indicating whether the entry was added or already existed
+ * @returns Whether the entry was appended
  */
 function ensureGitignoreEntry(gitignorePath, entry) {
-    const fileExists = existsSync(gitignorePath);
-    let content = "";
-    if (fileExists) {
-        content = readFileSync(gitignorePath, "utf8");
-    }
-    // check if entry already exists
-    const lines = content.split("\n");
-    const hasEntry = lines.some((line) => line.trim() === entry);
-    if (hasEntry) {
-        return { added: false, created: false };
-    }
-    // add entry to .gitignore
-    let newContent;
-    if (content === "") {
-        newContent = `${entry}\n`;
-    }
-    else if (content.endsWith("\n")) {
-        newContent = `${content}${entry}\n`;
-    }
-    else {
-        newContent = `${content}\n${entry}\n`;
-    }
-    writeFileSync(gitignorePath, newContent, "utf8");
-    return { added: true, created: !fileExists };
+    return appendLineIfMissing(gitignorePath, entry, (line) => line.trim() === entry);
 }
 /**
  * Add OPENWORKFLOW_POSTGRES_URL to .env file.
@@ -785,8 +760,8 @@ function updateEnvForPostgres() {
     const envPath = path.join(process.cwd(), ".env");
     const spinner = p.spinner();
     spinner.start("Updating .env...");
-    const result = ensureEnvEntry(envPath, "OPENWORKFLOW_POSTGRES_URL", "postgresql://user:password@localhost:5432/openworkflow");
-    spinner.stop(result.added
+    const added = ensureEnvEntry(envPath, "OPENWORKFLOW_POSTGRES_URL", "postgresql://user:password@localhost:5432/openworkflow");
+    spinner.stop(added
         ? "Added OPENWORKFLOW_POSTGRES_URL to .env"
         : "OPENWORKFLOW_POSTGRES_URL already in .env");
 }
@@ -824,16 +799,24 @@ function readPackageJsonForDoctor() {
         return null;
     }
 }
+/**
+ * Pick the script file extension for generated files based on whether the
+ * project uses TypeScript.
+ * @param packageJson - Parsed package.json (or null if missing)
+ * @returns ".ts" when TypeScript is a dependency, otherwise ".js"
+ */
+function getScriptExtension(packageJson) {
+    return packageJson && hasDependency(packageJson, "typescript")
+        ? ".ts"
+        : ".js";
+}
 /**
  * Determine the config filename to write during init.
  * @param packageJson - Parsed package.json (or null if missing)
  * @returns The config file name to create
  */
 export function getConfigFileName(packageJson) {
-    if (packageJson && hasDependency(packageJson, "typescript")) {
-        return "openworkflow.config.ts";
-    }
-    return "openworkflow.config.js";
+    return `openworkflow.config${getScriptExtension(packageJson)}`;
 }
 /**
  * Determine the example workflow filename to write during init.
@@ -841,9 +824,7 @@ export function getConfigFileName(packageJson) {
  * @returns The example workflow file name to create
  */
 export function getExampleWorkflowFileName(packageJson) {
-    const configFileName = getConfigFileName(packageJson);
-    const extension = path.extname(configFileName) || ".js";
-    return `hello-world${extension}`;
+    return `hello-world${getScriptExtension(packageJson)}`;
 }
 /**
  * Determine the hello-world runner filename to write during init.
@@ -851,9 +832,7 @@ export function getExampleWorkflowFileName(packageJson) {
  * @returns The runner file name to create
  */
 export function getRunFileName(packageJson) {
-    const configFileName = getConfigFileName(packageJson);
-    const extension = path.extname(configFileName) || ".js";
-    return `hello-world.run${extension}`;
+    return `hello-world.run${getScriptExtension(packageJson)}`;
 }
 /**
  * Determine the client filename to write during init.
@@ -861,9 +840,7 @@ export function getRunFileName(packageJson) {
  * @returns The client file name to create
  */
 export function getClientFileName(packageJson) {
-    const configFileName = getConfigFileName(packageJson);
-    const extension = path.extname(configFileName) || ".js";
-    return `client${extension}`;
+    return `client${getScriptExtension(packageJson)}`;
 }
 /**
  * Check whether a dependency is declared in package.json.
@@ -904,42 +881,18 @@ function warnIfMissingTsconfig(packageJson) {
     }
 }
 /**
- * Ensure a specific environment variable exists in a .env file. Creates the file if it
- * doesn't exist, appends the variable if not present.
+ * Ensure a specific environment variable exists in a .env file. Creates the
+ * file if it doesn't exist, appends the variable if not present.
  * @param envPath - Path to the .env file
  * @param key - The environment variable key (e.g. "OPENWORKFLOW_POSTGRES_URL")
  * @param value - The default value for the environment variable
- * @returns Object indicating whether the entry was added or already existed
+ * @returns Whether the entry was appended
  */
 function ensureEnvEntry(envPath, key, value) {
-    const fileExists = existsSync(envPath);
-    let content = "";
-    if (fileExists) {
-        content = readFileSync(envPath, "utf8");
-    }
-    // check if key already exists (looking for KEY= at start of line)
-    const lines = content.split("\n");
-    const hasKey = lines.some((line) => {
+    return appendLineIfMissing(envPath, `${key}=${value}`, (line) => {
         const trimmed = line.trim();
         return trimmed.startsWith(`${key}=`) || trimmed.startsWith(`${key} =`);
     });
-    if (hasKey) {
-        return { added: false, created: false };
-    }
-    // add entry to .env
-    let newContent;
-    const envEntry = `${key}=${value}`;
-    if (content === "") {
-        newContent = `${envEntry}\n`;
-    }
-    else if (content.endsWith("\n")) {
-        newContent = `${content}${envEntry}\n`;
-    }
-    else {
-        newContent = `${content}\n${envEntry}\n`;
-    }
-    writeFileSync(envPath, newContent, "utf8");
-    return { added: true, created: !fileExists };
 }
 /**
  * Validate a numeric option is a positive integer.

package/dist/config.js

@@ -12,7 +12,7 @@ export function defineConfig(config) {
 }
 const CONFIG_NAME = "openworkflow.config";
 const CONFIG_EXTENSIONS = ["ts", "mts", "cts", "js", "mjs", "cjs"];
-const jiti = createJiti(import.meta.url);
+const jiti = createJiti(import.meta.url, { tryNative: false }); // bun compatibility
 /**
  * Load OpenWorkflow config from an explicit path.
  * @param configPath - Explicit config file path

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkflow/cli",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "type": "module",
   "exports": {
     ".": {
@@ -27,18 +27,18 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@clack/prompts": "^1.0.1",
-    "commander": "^14.0.3",
+    "@clack/prompts": "^1.7.0",
+    "commander": "^15.0.0",
     "consola": "^3.4.2",
-    "dotenv": "^17.3.1",
-    "jiti": "^2.6.1",
-    "nypm": "^0.6.5"
+    "dotenv": "^17.4.2",
+    "jiti": "^2.7.0",
+    "nypm": "^0.6.8"
   },
   "devDependencies": {
     "openworkflow": "*",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "openworkflow": "^0.6.0 || ^0.7.0 || ^0.8.0"
+    "openworkflow": "^0.6.0 || ^0.7.0 || ^0.8.0 || ^0.9.0"
   }
 }