@navipartner/demo-video 0.4.0 → 0.5.0

package/bin/args.mjs

@@ -1,153 +1,158 @@
-import fs from "node:fs";
-import path from "node:path";
-
-export const COMMANDS = [
-  "check",
-  "render",
-  "record",
-  "encode",
-  "stills",
-  "list",
-];
-const NEEDS_STORYBOARD = new Set(["check", "render", "record"]);
-const USAGE = `Usage: demo-video <${COMMANDS.join("|")}> [--app <dir>] [--story <name|file.json>] [--brand <name>] [--draft] [--json]
-Without --story, check, render and record use the app's primary story.
---draft renders at 30 fps (about half the time) to iterate on a story.
-Setup: demo-video init [--app <dir>] [--dry-run]
-For a /demo-video request: demo-video pick --request "<text>" [--json] <app dir>...`;
-
-export const resolveStoryboard = (value, cwd, demoDir) => {
-  if (value.endsWith(".json")) {
-    const file = path.resolve(cwd, value);
-    if (!fs.existsSync(file)) {
-      throw new Error(`Story file ${file} does not exist`);
-    }
-    return file;
-  }
-  const dir = path.join(demoDir, "stories");
-  const file = path.join(dir, `${value}.json`);
-  if (!fs.existsSync(file)) {
-    const known = fs.existsSync(dir)
-      ? fs
-          .readdirSync(dir)
-          .filter((f) => f.endsWith(".json"))
-          .map((f) => f.slice(0, -".json".length))
-      : [];
-    throw new Error(
-      `No story "${value}" in ${dir}. Known: ${known.join(", ") || "(none)"}`,
-    );
-  }
-  return file;
-};
-
-/**
- * The app's stories, primary first, then by name. Reads only `description`
- * and `primary`: the full check needs the adapter and runs in `check`.
- */
-export const listStories = (demoDir) => {
-  const dir = path.join(demoDir, "stories");
-  if (!fs.existsSync(dir)) {
-    return [];
-  }
-  const stories = fs
-    .readdirSync(dir)
-    .filter((f) => f.endsWith(".json"))
-    .map((f) => {
-      const story = JSON.parse(fs.readFileSync(path.join(dir, f), "utf8"));
-      return {
-        name: f.slice(0, -".json".length),
-        description: story.description ?? null,
-        primary: story.primary === true,
-        // A variant: the base story's flow, for one brand.
-        ...(story.extends
-          ? { extends: story.extends, brand: story.brand ?? null }
-          : {}),
-      };
-    })
-    .sort(
-      (a, b) =>
-        Number(b.primary) - Number(a.primary) || a.name.localeCompare(b.name),
-    );
-  const primaries = stories.filter((s) => s.primary).map((s) => s.name);
-  if (primaries.length > 1) {
-    throw new Error(
-      `Only one story can be primary; ${primaries.join(", ")} all are (in ${dir})`,
-    );
-  }
-  return stories;
-};
-
-export const parseArgs = (argv, cwd) => {
-  const [command, ...rest] = argv;
-  if (!COMMANDS.includes(command)) {
-    throw new Error(USAGE);
-  }
-  const opts = {
-    app: ".",
-    story: undefined,
-    brand: undefined,
-    json: false,
-    draft: false,
-  };
-  for (let i = 0; i < rest.length; i++) {
-    const arg = rest[i];
-    if (arg === "--json") {
-      opts.json = true;
-    } else if (arg === "--draft") {
-      opts.draft = true;
-    } else if (["--app", "--story", "--brand"].includes(arg)) {
-      const value = rest[++i];
-      if (!value) {
-        throw new Error(`${arg} needs a value`);
-      }
-      opts[arg.slice(2)] = value;
-    } else {
-      throw new Error(`Unknown option ${arg}\n${USAGE}`);
-    }
-  }
-  const appDir = path.resolve(cwd, opts.app);
-  const demoDir = path.join(appDir, "demo");
-  const adapterPath = path.join(demoDir, "demo.config.ts");
-  if (!fs.existsSync(adapterPath)) {
-    throw new Error(`No demo adapter: expected ${adapterPath}`);
-  }
-  // Everything a run needs only while it runs (the generated Playwright
-  // config and spec, the check report, the raw recording, Playwright's
-  // results) goes here, inside demo/out/ (gitignored), and is deleted when
-  // the command ends. Only a failure's results are kept, in demo/out/failed/.
-  // `check` has its own folder, so it never touches the take that `record`
-  // leaves for `encode`.
-  const workDir = path.join(
-    demoDir,
-    "out",
-    ".work",
-    command === "check" ? "check" : "take",
-  );
-  const runnerDir = path.join(workDir, "runner");
-  let storyboardPath = null;
-  if (NEEDS_STORYBOARD.has(command)) {
-    // No --story: the app's primary story, its main journey.
-    const story =
-      opts.story ?? listStories(demoDir).find((s) => s.primary)?.name;
-    if (!story) {
-      throw new Error(
-        `No --story given and no primary story in ${path.join(demoDir, "stories")}. Name one with --story, or mark the app's main journey "primary": true.`,
-      );
-    }
-    storyboardPath = resolveStoryboard(story, cwd, demoDir);
-  }
-  return {
-    command,
-    appDir,
-    demoDir,
-    adapterPath,
-    workDir,
-    runnerDir,
-    configPath: path.join(runnerDir, "playwright.config.mjs"),
-    outDir: path.join(demoDir, "out"),
-    storyboardPath,
-    brand: opts.brand ?? null,
-    json: opts.json,
-    draft: opts.draft,
-  };
-};
+import fs from "node:fs";
+import path from "node:path";
+
+export const COMMANDS = [
+  "check",
+  "render",
+  "record",
+  "encode",
+  "stills",
+  "list",
+  "brand-needs",
+];
+const NEEDS_STORYBOARD = new Set(["check", "render", "record"]);
+const USAGE = `Usage: demo-video <${COMMANDS.join("|")}> [--app <dir>] [--story <name|file.json>] [--brand <name>] [--brands <dir>] [--draft] [--json]
+Without --story, check, render and record use the app's primary story.
+--draft renders at 30 fps (about half the time) to iterate on a story.
+--brands adds a brands folder outside the repo, searched first.
+brand-needs: what a brand must give this app (its adapter's brandNeeds).
+Setup: demo-video init [--app <dir>] [--dry-run]
+For a /demo-video request: demo-video pick --request "<text>" [--json] <app dir>...
+For a pitch draft (the skill's pitch.md): demo-video pitch <proposal.json> [--app <dir>] [--story <name>] [--out <dir>] [--json]`;
+
+export const resolveStoryboard = (value, cwd, demoDir) => {
+  if (value.endsWith(".json")) {
+    const file = path.resolve(cwd, value);
+    if (!fs.existsSync(file)) {
+      throw new Error(`Story file ${file} does not exist`);
+    }
+    return file;
+  }
+  const dir = path.join(demoDir, "stories");
+  const file = path.join(dir, `${value}.json`);
+  if (!fs.existsSync(file)) {
+    const known = fs.existsSync(dir)
+      ? fs
+          .readdirSync(dir)
+          .filter((f) => f.endsWith(".json"))
+          .map((f) => f.slice(0, -".json".length))
+      : [];
+    throw new Error(
+      `No story "${value}" in ${dir}. Known: ${known.join(", ") || "(none)"}`,
+    );
+  }
+  return file;
+};
+
+/**
+ * The app's stories, primary first, then by name. Reads only `description`
+ * and `primary`: the full check needs the adapter and runs in `check`.
+ */
+export const listStories = (demoDir) => {
+  const dir = path.join(demoDir, "stories");
+  if (!fs.existsSync(dir)) {
+    return [];
+  }
+  const stories = fs
+    .readdirSync(dir)
+    .filter((f) => f.endsWith(".json"))
+    .map((f) => {
+      const story = JSON.parse(fs.readFileSync(path.join(dir, f), "utf8"));
+      return {
+        name: f.slice(0, -".json".length),
+        description: story.description ?? null,
+        primary: story.primary === true,
+        // A variant: the base story's flow, for one brand.
+        ...(story.extends
+          ? { extends: story.extends, brand: story.brand ?? null }
+          : {}),
+      };
+    })
+    .sort(
+      (a, b) =>
+        Number(b.primary) - Number(a.primary) || a.name.localeCompare(b.name),
+    );
+  const primaries = stories.filter((s) => s.primary).map((s) => s.name);
+  if (primaries.length > 1) {
+    throw new Error(
+      `Only one story can be primary; ${primaries.join(", ")} all are (in ${dir})`,
+    );
+  }
+  return stories;
+};
+
+export const parseArgs = (argv, cwd) => {
+  const [command, ...rest] = argv;
+  if (!COMMANDS.includes(command)) {
+    throw new Error(USAGE);
+  }
+  const opts = {
+    app: ".",
+    story: undefined,
+    brand: undefined,
+    json: false,
+    draft: false,
+  };
+  for (let i = 0; i < rest.length; i++) {
+    const arg = rest[i];
+    if (arg === "--json") {
+      opts.json = true;
+    } else if (arg === "--draft") {
+      opts.draft = true;
+    } else if (["--app", "--story", "--brand", "--brands"].includes(arg)) {
+      const value = rest[++i];
+      if (!value) {
+        throw new Error(`${arg} needs a value`);
+      }
+      opts[arg.slice(2)] = value;
+    } else {
+      throw new Error(`Unknown option ${arg}\n${USAGE}`);
+    }
+  }
+  const appDir = path.resolve(cwd, opts.app);
+  const demoDir = path.join(appDir, "demo");
+  const adapterPath = path.join(demoDir, "demo.config.ts");
+  if (!fs.existsSync(adapterPath)) {
+    throw new Error(`No demo adapter: expected ${adapterPath}`);
+  }
+  // Everything a run needs only while it runs (the generated Playwright
+  // config and spec, the check report, the raw recording, Playwright's
+  // results) goes here, inside demo/out/ (gitignored), and is deleted when
+  // the command ends. Only a failure's results are kept, in demo/out/failed/.
+  // `check` has its own folder, so it never touches the take that `record`
+  // leaves for `encode`.
+  const workDir = path.join(
+    demoDir,
+    "out",
+    ".work",
+    command === "check" || command === "brand-needs" ? command : "take",
+  );
+  const runnerDir = path.join(workDir, "runner");
+  let storyboardPath = null;
+  if (NEEDS_STORYBOARD.has(command)) {
+    // No --story: the app's primary story, its main journey.
+    const story =
+      opts.story ?? listStories(demoDir).find((s) => s.primary)?.name;
+    if (!story) {
+      throw new Error(
+        `No --story given and no primary story in ${path.join(demoDir, "stories")}. Name one with --story, or mark the app's main journey "primary": true.`,
+      );
+    }
+    storyboardPath = resolveStoryboard(story, cwd, demoDir);
+  }
+  return {
+    command,
+    appDir,
+    demoDir,
+    adapterPath,
+    workDir,
+    runnerDir,
+    configPath: path.join(runnerDir, "playwright.config.mjs"),
+    outDir: path.join(demoDir, "out"),
+    storyboardPath,
+    brand: opts.brand ?? null,
+    brandsDir: opts.brands ? path.resolve(cwd, opts.brands) : null,
+    json: opts.json,
+    draft: opts.draft,
+  };
+};