Fix CLI export errors and locale selection

Author: mniinio

package.json

@@ -33,7 +33,7 @@
     "release:create-apiops:publish": "npm publish --workspace packages/create-apiops --access public",
     "check:packaging:skills": "node scripts/check-packaging-skills.mjs",
     "check:package:contents": "node scripts/check-package-contents.mjs",
-    "test:create-apiops": "node scripts/test-create-apiops-scaffold.mjs"
+    "test:create-apiops": "node scripts/test-create-apiops-scaffold.mjs && node scripts/test-method-cli.mjs"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.7",

packages/create-apiops/bin/create-apiops-project.js

@@ -97,10 +97,32 @@ function replaceInFile(filePath, replacements) {
   fs.writeFileSync(filePath, content);
 }
 
+function resolveNpmCommand() {
+  const npmCliPath = path.resolve(path.dirname(process.execPath), "node_modules", "npm", "bin", "npm-cli.js");
+  if (fs.existsSync(npmCliPath)) {
+    return {
+      command: process.execPath,
+      args: [npmCliPath]
+    };
+  }
+
+  return {
+    command: process.platform === "win32" ? "npm.cmd" : "npm",
+    args: []
+  };
+}
+
+function runCommand(command, args, options = {}) {
+  return spawnSync(command, args, {
+    shell: false,
+    ...options
+  });
+}
+
 function getScripts(locale, apiStyle) {
   const base = {
     "method": "node ./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js",
-    "method:start": `node ./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js start --locale ${locale}`,
+    "method:start": `node ./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js start --default-locale ${locale}`,
     "method:resources:strategy": `node ./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js resources --station api-product-strategy --locale ${locale}`,
     "method:canvases:new-api": `node ./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js generate-canvases --preset new-api --style "${apiStyle}" --locale ${locale} --output ./specs/canvases`,
     "method:stations": `node ./node_modules/apiops-cycles-method-data/skills/new-api-guide/scripts/get-core-stations.cjs ${locale}`,
@@ -200,18 +222,18 @@ async function main() {
   console.log(`Created ${projectName}`);
 
   if (installNow) {
-    const result = spawnSync("npm", ["install"], {
+    const npmCommand = resolveNpmCommand();
+    const result = runCommand(npmCommand.command, [...npmCommand.args, "install"], {
       cwd: targetDir,
-      stdio: "inherit",
-      shell: true
+      stdio: "inherit"
     });
     if (result.status !== 0) {
       console.error("npm install failed");
       process.exit(result.status || 1);
     }
 
-    const canvasInit = spawnSync(
-      "node",
+    const canvasInit = runCommand(
+      process.execPath,
       [
         "./node_modules/apiops-cycles-method-data/packages/create-apiops/bin/method-cli.js",
         "generate-canvases",
@@ -222,8 +244,7 @@ async function main() {
       ],
       {
         cwd: targetDir,
-        stdio: "inherit",
-        shell: true
+        stdio: "inherit"
       }
     );
 

packages/create-apiops/bin/method-cli.js

@@ -18,12 +18,13 @@ const STATION_SCRIPT_HINTS = {
 
 function printUsage() {
   console.log(`Usage:
-  node packages/create-apiops/bin/method-cli.js start [--locale <locale>] [--json] [--list] [--answers <yes,no,...>] [--next-action <resources|canvases|exit>]
+  node packages/create-apiops/bin/method-cli.js start [--locale <locale>] [--default-locale <locale>] [--json] [--list] [--answers <yes,no,...>] [--next-action <resources|canvases|exit>]
   node packages/create-apiops/bin/method-cli.js resources --station <station-id> [--locale <locale>] [--style <style>] [--json] [--list] [--step-actions <details,next,...>]
   node packages/create-apiops/bin/method-cli.js generate-canvases [--station <station-id> | --stations <ids> | --preset new-api] [--locale <locale>] [--style <style>] [--output <dir>] [--force] [--json]
 
 Examples:
   node packages/create-apiops/bin/method-cli.js start --locale en
+  node packages/create-apiops/bin/method-cli.js start --default-locale en
   node packages/create-apiops/bin/method-cli.js start --locale en --answers yes,no,yes --next-action resources
   node packages/create-apiops/bin/method-cli.js resources --station api-product-strategy --locale en
   node packages/create-apiops/bin/method-cli.js generate-canvases --preset new-api --style REST --output ./specs/canvases
@@ -71,6 +72,14 @@ function readJson(filePath) {
   return JSON.parse(fs.readFileSync(filePath, "utf8"));
 }
 
+function runCommand(command, args, options = {}) {
+  return spawnSync(command, args, {
+    encoding: "utf8",
+    shell: false,
+    ...options
+  });
+}
+
 function getNextStepHints(stationId) {
   const hints = STATION_SCRIPT_HINTS[stationId];
   if (hints) {
@@ -155,44 +164,137 @@ async function fillCanvasSectionsInteractive(stationId, step, locale, output, rl
 }
 
 function resolveCanvasExportCommand() {
-  const binPath = path.resolve(
-    process.cwd(),
-    "node_modules",
-    ".bin",
-    process.platform === "win32" ? "canvascreator-export.cmd" : "canvascreator-export"
-  );
-  if (fs.existsSync(binPath)) {
+  const packageRoot = path.resolve(process.cwd(), "node_modules", "canvascreator");
+  if (!fs.existsSync(packageRoot)) {
     return {
-      command: binPath,
-      args: []
+      ok: false,
+      reason: "SVG export requires CanvasCreator export support, which is not installed in this project.",
+      help: "Run `npm install` to install project dependencies, or `npm install canvascreator` to add CanvasCreator manually."
     };
   }
 
-  const scriptPath = path.resolve(process.cwd(), "node_modules", "canvascreator", "scripts", "export.js");
+  const packageJsonPath = path.join(packageRoot, "package.json");
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = readJson(packageJsonPath);
+    const binEntry = typeof packageJson.bin === "string"
+      ? packageJson.bin
+      : packageJson.bin?.["canvascreator-export"];
+
+    if (binEntry) {
+      const binPath = path.resolve(packageRoot, binEntry);
+      if (fs.existsSync(binPath)) {
+        return {
+          ok: true,
+          command: process.execPath,
+          args: [binPath]
+        };
+      }
+    }
+  }
+
+  const scriptPath = path.resolve(packageRoot, "scripts", "export.js");
   if (fs.existsSync(scriptPath)) {
     return {
+      ok: true,
       command: process.execPath,
       args: [scriptPath]
     };
   }
 
-  return null;
+  return {
+    ok: false,
+    reason: "CanvasCreator is installed, but its export CLI could not be found.",
+    help: "Reinstall `canvascreator` or use the CanvasCreator web app to export SVG from the JSON file."
+  };
+}
+
+function resolveStartLocale(options = {}) {
+  const explicitLocale = options.locale;
+  const defaultLocale = options["default-locale"] || methodEngine.DEFAULT_LOCALE;
+  if (explicitLocale) {
+    return explicitLocale;
+  }
+
+  return methodEngine.getSupportedMethodLocales().includes(defaultLocale)
+    ? defaultLocale
+    : methodEngine.DEFAULT_LOCALE;
+}
+
+async function maybePromptForStartLocale(options = {}) {
+  const selectedLocale = resolveStartLocale(options);
+  if (
+    options.locale ||
+    options.json ||
+    options.list ||
+    options.answers ||
+    !process.stdin.isTTY
+  ) {
+    return selectedLocale;
+  }
+
+  const supportedLocales = methodEngine.getSupportedMethodLocales();
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  try {
+    console.log(`Default method language: ${selectedLocale}`);
+    console.log(`Available languages: ${supportedLocales.join(", ")}`);
+    const answer = (await rl.question("Press Enter to keep the default, or type another locale for this run: "))
+      .trim()
+      .toLowerCase();
+    if (!answer) {
+      console.log("");
+      return selectedLocale;
+    }
+
+    if (supportedLocales.includes(answer)) {
+      console.log("");
+      return answer;
+    }
+
+    console.log(`Unknown locale "${answer}", using ${selectedLocale}.`);
+    console.log("");
+    return selectedLocale;
+  } finally {
+    rl.close();
+  }
+}
+
+function formatCommandFailure(result) {
+  if (result.error?.message) {
+    return result.error.message;
+  }
+
+  const stderr = String(result.stderr || "").trim();
+  if (stderr) {
+    return stderr;
+  }
+
+  const stdout = String(result.stdout || "").trim();
+  if (stdout) {
+    return stdout;
+  }
+
+  return "Canvas export failed.";
 }
 
 function exportCanvasSvgForResource(stationId, step, locale, output) {
   const jsonPath = methodEngine.generateCanvasForStationResource(stationId, step.resourceId, locale, output);
   const exportCommand = resolveCanvasExportCommand();
-  if (!exportCommand) {
+  if (!exportCommand.ok) {
     return {
       ok: false,
-      reason: "CanvasCreator export CLI is not installed in this project yet.",
+      reason: exportCommand.reason,
+      help: exportCommand.help,
       jsonPath
     };
   }
 
   const outputDir = path.dirname(jsonPath);
   const outputFile = path.join(outputDir, `${step.resourceId}.svg`);
-  const result = spawnSync(
+  const result = runCommand(
     exportCommand.command,
     [
       ...exportCommand.args,
@@ -201,16 +303,14 @@ function exportCanvasSvgForResource(stationId, step, locale, output) {
       "--output", outputFile
     ],
     {
-      cwd: process.cwd(),
-      encoding: "utf8",
-      shell: process.platform === "win32"
+      cwd: process.cwd()
     }
   );
 
   if (result.status !== 0) {
     return {
       ok: false,
-      reason: result.stderr || result.stdout || "Canvas export failed.",
+      reason: formatCommandFailure(result),
       jsonPath
     };
   }
@@ -562,6 +662,9 @@ async function runInteractiveResources(options) {
             console.log(`Source JSON: ${exportResult.jsonPath}`);
           } else {
             console.log(`SVG export unavailable: ${exportResult.reason}`);
+            if (exportResult.help) {
+              console.log(exportResult.help);
+            }
             console.log(`Canvas JSON is still available at: ${exportResult.jsonPath}`);
             console.log(`CanvasCreator URL: ${methodEngine.getCanvasCreatorUrl(step.canvasId, locale)}`);
           }
@@ -627,7 +730,8 @@ async function main() {
   }
 
   if (command === "start") {
-    const data = methodEngine.buildStartData(options.locale || methodEngine.DEFAULT_LOCALE);
+    const locale = await maybePromptForStartLocale(options);
+    const data = methodEngine.buildStartData(locale);
     if (options.json) {
       console.log(JSON.stringify(data, null, 2));
       return;
@@ -638,7 +742,7 @@ async function main() {
       return;
     }
 
-    await runInteractiveStart(data, options);
+    await runInteractiveStart(data, { ...options, locale });
     return;
   }
 

packages/create-apiops/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-apiops",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Scaffold a new APIOps project with an OpenAPI spec, audit scaffolding, and APIOps documentation templates.",
   "license": "Apache-2.0",
   "type": "module",

scripts/test-create-apiops-scaffold.mjs

@@ -59,6 +59,10 @@ try {
   assert(pkg.name === projectName, "Scaffolded package name was not set correctly.");
   assert(pkg.scripts?.method, "Expected generic method script in scaffolded package.");
   assert(pkg.scripts?.["method:start"], "Expected method:start script in scaffolded package.");
+  assert(
+    pkg.scripts["method:start"].includes("--default-locale en"),
+    "Expected method:start to pass the project default locale without forcing the runtime locale."
+  );
   assert(pkg.scripts?.["method:resources:strategy"], "Expected method:resources:strategy script in scaffolded package.");
   assert(pkg.scripts?.["method:canvases:new-api"], "Expected method:canvases:new-api script in scaffolded package.");
   assert(pkg.scripts?.["method:stations"], "Expected method:stations script in scaffolded package.");