@openworkflow/cli 0.5.1 → 0.5.2

package/dist/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAC;AAyCrB,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;AAEpD,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,WAAY,SAAQ,cAAc;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;;GAIG;AAEH,wBAAsB,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsJnE;AA8BD;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DxE;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,CA8Ef;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,CA6D7E;AA4PD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA8CV;AA+WD,UAAU,oBAAoB;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,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"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAC;AAyCrB,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;AAEpD,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,WAAY,SAAQ,cAAc;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;;GAIG;AAEH,wBAAsB,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA0JnE;AAkCD;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DxE;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,CA8Ef;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,CA6D7E;AA4PD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA8CV;AAuXD,UAAU,oBAAoB;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,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

@@ -2,10 +2,10 @@ import { findConfigFile, loadConfigFromPath, } from "./config.js";
 import { CLIError, exit } from "./errors.js";
 import { createModuleLoader } from "./module-loader.js";
 import { trackCommand } from "./telemetry.js";
-import { CONFIG, HELLO_WORLD_RUNNER, HELLO_WORLD_WORKFLOW, POSTGRES_CLIENT, POSTGRES_PROD_SQLITE_DEV_CLIENT, SQLITE_CLIENT, } from "./templates.js";
+import { getConfigTemplate, HELLO_WORLD_RUNNER, HELLO_WORLD_WORKFLOW, POSTGRES_CLIENT, POSTGRES_PROD_SQLITE_DEV_CLIENT, SQLITE_CLIENT, } from "./templates.js";
 import * as p from "@clack/prompts";
 import { consola } from "consola";
-import { config as loadDotenv } from "dotenv";
+import { config as loadDotenv, parse as parseDotenv } from "dotenv";
 import { spawn } from "node:child_process";
 import { existsSync, mkdirSync, readdirSync, readFileSync, unlinkSync, writeFileSync, } from "node:fs";
 import path from "node:path";
@@ -101,7 +101,11 @@ export async function init(options = {}) {
     if (!packageJson) {
         throw new CLIError("No package.json found.", "Please create a package.json file first by running `npm init` or `npm init -y`.");
     }
-    validateInitManifest(packageJson);
+    const configArg = options.config
+        ? ` --config '${options.config.replaceAll("'", String.raw `'\''`)}'`
+        : "";
+    const workerCommand = `npx @openworkflow/cli worker start${configArg}`;
+    validateInitManifest(packageJson, workerCommand);
     const configFileName = options.config ?? getConfigFileName(packageJson);
     const clientFileName = getClientFileName(packageJson);
     const exampleWorkflowFileName = getExampleWorkflowFileName(packageJson);
@@ -154,16 +158,16 @@ export async function init(options = {}) {
     if (backendChoice === "postgres" || backendChoice === "both") {
         updateEnvForPostgres();
     }
-    addWorkerScriptToPackageJson();
+    addWorkerScriptToPackageJson(workerCommand);
     // write config file last, so canceling earlier doesn't leave a config file
     // which would prevent re-running init
     createConfigFile(configFileName);
     // wrap up
-    p.note(`➡️ Start a worker:\n$ npx @openworkflow/cli worker start\n\n➡️ Run the example workflow:\n$ ${runCommand}\n\n➡️ View the dashboard:\n$ npx @openworkflow/cli dashboard`, "Next steps");
+    p.note(`➡️ Start a worker:\n$ ${workerCommand}\n\n➡️ Run the example workflow:\n$ ${runCommand}\n\n➡️ View the dashboard:\n$ npx @openworkflow/cli dashboard${configArg}`, "Next steps");
     p.outro("✅ Setup complete!");
 }
 // Validate the manifest fields that init reads or updates.
-function validateInitManifest(manifest) {
+function validateInitManifest(manifest, workerCommand) {
     if (!manifest || typeof manifest !== "object" || Array.isArray(manifest)) {
         throw new CLIError("Invalid package.json: expected an object.");
     }
@@ -180,7 +184,9 @@ function validateInitManifest(manifest) {
     }
     const { scripts } = manifest;
     const worker = scripts?.["worker"];
-    if (worker !== undefined && worker !== "npx @openworkflow/cli worker start") {
+    if (worker !== undefined &&
+        worker !== "npx @openworkflow/cli worker start" &&
+        worker !== workerCommand) {
         throw new CLIError("Setup would overwrite package.json scripts.worker.");
     }
 }
@@ -710,9 +716,15 @@ function createConfigFile(configFileName) {
     const spinner = p.spinner();
     spinner.start("Writing config...");
     const configDestPath = path.resolve(process.cwd(), configFileName);
+    const relativeClientPath = path
+        .relative(path.dirname(configDestPath), path.join(process.cwd(), "openworkflow/client.js"))
+        .replaceAll(path.sep, "/");
+    const clientImport = relativeClientPath.startsWith("../")
+        ? relativeClientPath
+        : `./${relativeClientPath}`;
     // mkdir if the user specified a config file, and they want it in a dir
     mkdirSync(path.dirname(configDestPath), { recursive: true });
-    writeFileSync(configDestPath, CONFIG, "utf8");
+    writeFileSync(configDestPath, getConfigTemplate(clientImport), "utf8");
     spinner.stop(`Config written to ${configDestPath}`);
 }
 /**
@@ -780,8 +792,9 @@ function updateGitignoreForSqlite() {
 }
 /**
  * Add worker script to package.json.
+ * @param workerCommand - Worker command including any custom config path.
  */
-function addWorkerScriptToPackageJson() {
+function addWorkerScriptToPackageJson(workerCommand) {
     const packageJsonPath = path.join(process.cwd(), "package.json");
     if (!existsSync(packageJsonPath)) {
         return;
@@ -791,7 +804,7 @@ function addWorkerScriptToPackageJson() {
     try {
         const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
         packageJson.scripts ??= {};
-        packageJson.scripts["worker"] = "npx @openworkflow/cli worker start";
+        packageJson.scripts["worker"] = workerCommand;
         writeFileSync(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`, "utf8");
         spinner.stop('Added "worker" script to package.json');
     }
@@ -801,17 +814,17 @@ function addWorkerScriptToPackageJson() {
     }
 }
 /**
- * Append a line to a file if no existing line matches. Creates the file if it
- * doesn't exist.
+ * Append a line if the file does not already contain the desired entry.
+ * 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`
+ * @param matchesExisting - Predicate that checks whether the file contents
+ * already contain the desired entry
  * @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))) {
+    if (matchesExisting(content)) {
         return false;
     }
     const separator = content === "" || content.endsWith("\n") ? "" : "\n";
@@ -826,7 +839,7 @@ function appendLineIfMissing(filePath, line, matchesExisting) {
  * @returns Whether the entry was appended
  */
 function ensureGitignoreEntry(gitignorePath, entry) {
-    return appendLineIfMissing(gitignorePath, entry, (line) => line.trim() === entry);
+    return appendLineIfMissing(gitignorePath, entry, (content) => content.split("\n").some((line) => line.trim() === entry));
 }
 /**
  * Add OPENWORKFLOW_POSTGRES_URL to .env file.
@@ -951,10 +964,7 @@ function hasDependency(packageJson, name) {
  * @returns Whether the entry was appended
  */
 function ensureEnvEntry(envPath, key, value) {
-    return appendLineIfMissing(envPath, `${key}=${value}`, (line) => {
-        const trimmed = line.trim();
-        return trimmed.startsWith(`${key}=`) || trimmed.startsWith(`${key} =`);
-    });
+    return appendLineIfMissing(envPath, `${key}=${value}`, (content) => Object.hasOwn(parseDotenv(content), key));
 }
 /**
  * Validate a numeric option is a positive integer.

package/dist/templates.d.ts

@@ -1,7 +1,12 @@
 export declare const SQLITE_CLIENT = "import { BackendSqlite } from \"openworkflow/sqlite\";\nimport { OpenWorkflow } from \"openworkflow\";\n\nexport const backend = BackendSqlite.connect(\"openworkflow/backend.db\");\nexport const ow = new OpenWorkflow({ backend });\n";
 export declare const POSTGRES_CLIENT = "import { BackendPostgres } from \"openworkflow/postgres\";\nimport { OpenWorkflow } from \"openworkflow\";\n\nexport const backend = await BackendPostgres.connect(\n  process.env[\"OPENWORKFLOW_POSTGRES_URL\"],\n);\nexport const ow = new OpenWorkflow({ backend });\n";
 export declare const POSTGRES_PROD_SQLITE_DEV_CLIENT = "import { BackendPostgres } from \"openworkflow/postgres\";\nimport { BackendSqlite } from \"openworkflow/sqlite\";\nimport { OpenWorkflow } from \"openworkflow\";\n\nexport const backend =\n  process.env[\"NODE_ENV\"] === \"production\"\n    ? await BackendPostgres.connect(process.env[\"OPENWORKFLOW_POSTGRES_URL\"])\n    : BackendSqlite.connect(\"openworkflow/backend.db\");\nexport const ow = new OpenWorkflow({ backend });\n";
-export declare const CONFIG = "import { backend } from \"./openworkflow/client.js\";\nimport { defineConfig } from \"@openworkflow/cli\";\n\nexport default defineConfig({\n  backend,\n  dirs: \"./openworkflow\",\n  ignorePatterns: [\"**/*.run.*\"],\n});\n";
+/**
+ * Render config paths relative to the config file's directory.
+ * @param clientImport - Relative import path to the scaffolded client.
+ * @returns The config template string.
+ */
+export declare function getConfigTemplate(clientImport: string): string;
 export declare const HELLO_WORLD_WORKFLOW = "import { defineWorkflow } from \"openworkflow\";\n\n/**\n * Example workflow that greets the world.\n *\n * This workflow is auto-discovered by the CLI worker.\n * To trigger it, use ow.runWorkflow() from your app:\n * ```ts\n * import { ow } from \"./openworkflow/client.js\";\n * import { helloWorld } from \"./openworkflow/hello-world.js\";\n * const handle = await ow.runWorkflow(helloWorld.spec, {});\n * const result = await handle.result();\n * ```\n */\nexport const helloWorld = defineWorkflow(\n  { name: \"hello-world\" },\n  async ({ step }) => {\n    const greeting = await step.run({ name: \"greet\" }, () => {\n      return \"Hello, World!\";\n    });\n\n    await step.sleep(\"wait-a-bit\", \"1s\");\n\n    return { greeting };\n  },\n);\n";
 export declare const HELLO_WORLD_RUNNER = "import { backend, ow } from \"./client.js\";\nimport { helloWorld } from \"./hello-world.js\";\n\n// Run this file:\n// JS: `node openworkflow/hello-world.run.js`\n// TS: `npx tsx openworkflow/hello-world.run.ts`\n//\n// This file is a temporary dev helper generated by\n// `npx @openworkflow/cli init` so you can quickly run the example workflow.\n//\n// Copy the code anywhere in your app (e.g., an API route or a script) and\n// modify it to run your workflows.\n//\n// You can delete this file once you're done with it.\n\nconsole.log(\"Running hello-world workflow...\");\nconst handle = await ow.runWorkflow(helloWorld.spec, {});\n\nconsole.log(\"Waiting for result...\");\nconst result = await handle.result(); // for very short workflows only\n\nconsole.log(`Workflow result: ${JSON.stringify(result, null, 2)}`);\n\n// Stop backend. Only needed if this is a standalone script that you want to\n// exit after running the workflow.\nawait backend.stop();\n";
 //# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../templates.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,6OAKzB,CAAC;AAEF,eAAO,MAAM,eAAe,+QAO3B,CAAC;AAEF,eAAO,MAAM,+BAA+B,ibAS3C,CAAC;AAEF,eAAO,MAAM,MAAM,qOAQlB,CAAC;AAEF,eAAO,MAAM,oBAAoB,wvBA0BhC,CAAC;AAEF,eAAO,MAAM,kBAAkB,w8BA0B9B,CAAC"}
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../templates.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,6OAKzB,CAAC;AAEF,eAAO,MAAM,eAAe,+QAO3B,CAAC;AAEF,eAAO,MAAM,+BAA+B,ibAS3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAU9D;AAED,eAAO,MAAM,oBAAoB,wvBA0BhC,CAAC;AAEF,eAAO,MAAM,kBAAkB,w8BA0B9B,CAAC"}

package/dist/templates.js

@@ -1,3 +1,4 @@
+import path from "node:path";
 export const SQLITE_CLIENT = `import { BackendSqlite } from "openworkflow/sqlite";
 import { OpenWorkflow } from "openworkflow";
 
@@ -22,15 +23,22 @@ export const backend =
     : BackendSqlite.connect("openworkflow/backend.db");
 export const ow = new OpenWorkflow({ backend });
 `;
-export const CONFIG = `import { backend } from "./openworkflow/client.js";
+/**
+ * Render config paths relative to the config file's directory.
+ * @param clientImport - Relative import path to the scaffolded client.
+ * @returns The config template string.
+ */
+export function getConfigTemplate(clientImport) {
+    return `import { backend } from ${JSON.stringify(clientImport)};
 import { defineConfig } from "@openworkflow/cli";
 
 export default defineConfig({
   backend,
-  dirs: "./openworkflow",
+  dirs: ${JSON.stringify(path.posix.dirname(clientImport))},
   ignorePatterns: ["**/*.run.*"],
 });
 `;
+}
 export const HELLO_WORLD_WORKFLOW = `import { defineWorkflow } from "openworkflow";
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkflow/cli",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "type": "module",
   "exports": {
     ".": {