@hla4ts/create-spacekit 0.1.0 → 0.1.1

package/src/cli.ts

@@ -1,364 +1,364 @@
-#!/usr/bin/env bun
-import readline from "node:readline/promises";
-import { stdin, stdout } from "node:process";
-import path from "node:path";
-import {
-  DEFAULT_TEMPLATE,
-  TEMPLATE_DESCRIPTIONS,
-  listTemplates,
-  scaffoldApp,
-  type TemplateId,
-  type TemplateValues,
-} from "./scaffold.ts";
-
-interface CliOptions {
-  targetDir?: string;
-  template: TemplateId;
-  workspaceDeps: boolean;
-  yes: boolean;
-  values: Partial<TemplateValues>;
-  listTemplates: boolean;
-  help: boolean;
-}
-
-try {
-  await main();
-} catch (error) {
-  const message = error instanceof Error ? error.message : String(error);
-  console.error(message);
-  process.exit(1);
-}
-
-async function main(): Promise<void> {
-  const options = parseArgs(process.argv.slice(2));
-
-  if (options.help) {
-    printHelp();
-    return;
-  }
-
-  if (options.listTemplates) {
-    for (const template of listTemplates()) {
-      console.log(`${template.id}\t${template.description}`);
-    }
-    return;
-  }
-
-  if (!options.targetDir) {
-    printHelp("Target directory is required.");
-    process.exit(1);
-  }
-
-  if (!isTemplateId(options.template)) {
-    throw new Error(`Unknown template "${options.template}". Run --list-templates to inspect choices.`);
-  }
-
-  const usePrompts = stdin.isTTY && stdout.isTTY && !options.yes;
-  const values = usePrompts
-    ? await promptForMissingValues(options.targetDir, options.template, options.values)
-    : options.values;
-  if (options.workspaceDeps) {
-    values.spacekitDependency = "workspace:*";
-  }
-
-  const result = await scaffoldApp({
-    targetDir: options.targetDir,
-    template: options.template,
-    values,
-  });
-
-  const relativeTarget = path.relative(process.cwd(), result.targetDir) || ".";
-  const displayTarget =
-    relativeTarget === "." || (!relativeTarget.startsWith("..") && !path.isAbsolute(relativeTarget))
-      ? relativeTarget
-      : result.targetDir;
-  console.log(`Created ${result.template} app in ${result.targetDir}`);
-  console.log("");
-  console.log("Next steps:");
-  console.log(`  cd ${displayTarget}`);
-  console.log("  bun install");
-  console.log("  bun run start");
-  console.log("");
+#!/usr/bin/env bun
+import readline from "node:readline/promises";
+import { stdin, stdout } from "node:process";
+import path from "node:path";
+import {
+  DEFAULT_TEMPLATE,
+  TEMPLATE_DESCRIPTIONS,
+  listTemplates,
+  scaffoldApp,
+  type TemplateId,
+  type TemplateValues,
+} from "./scaffold.ts";
+
+interface CliOptions {
+  targetDir?: string;
+  template: TemplateId;
+  workspaceDeps: boolean;
+  yes: boolean;
+  values: Partial<TemplateValues>;
+  listTemplates: boolean;
+  help: boolean;
+}
+
+try {
+  await main();
+} catch (error) {
+  const message = error instanceof Error ? error.message : String(error);
+  console.error(message);
+  process.exit(1);
+}
+
+async function main(): Promise<void> {
+  const options = parseArgs(process.argv.slice(2));
+
+  if (options.help) {
+    printHelp();
+    return;
+  }
+
+  if (options.listTemplates) {
+    for (const template of listTemplates()) {
+      console.log(`${template.id}\t${template.description}`);
+    }
+    return;
+  }
+
+  if (!options.targetDir) {
+    printHelp("Target directory is required.");
+    process.exit(1);
+  }
+
+  if (!isTemplateId(options.template)) {
+    throw new Error(`Unknown template "${options.template}". Run --list-templates to inspect choices.`);
+  }
+
+  const usePrompts = stdin.isTTY && stdout.isTTY && !options.yes;
+  const values = usePrompts
+    ? await promptForMissingValues(options.targetDir, options.template, options.values)
+    : options.values;
+  if (options.workspaceDeps) {
+    values.spacekitDependency = "workspace:*";
+  }
+
+  const result = await scaffoldApp({
+    targetDir: options.targetDir,
+    template: options.template,
+    values,
+  });
+
+  const relativeTarget = path.relative(process.cwd(), result.targetDir) || ".";
+  const displayTarget =
+    relativeTarget === "." || (!relativeTarget.startsWith("..") && !path.isAbsolute(relativeTarget))
+      ? relativeTarget
+      : result.targetDir;
+  console.log(`Created ${result.template} app in ${result.targetDir}`);
+  console.log("");
+  console.log("Next steps:");
+  console.log(`  cd ${displayTarget}`);
+  console.log("  bun install");
+  console.log("  bun run start");
+  console.log("");
   console.log(
     "This package is bunx-ready, but the one-line zero-clone flow still depends on npm publication:"
   );
   console.log(`  bunx @hla4ts/create-spacekit ${path.basename(result.targetDir)}`);
 }
-
-function parseArgs(argv: string[]): CliOptions {
-  const options: CliOptions = {
-    template: DEFAULT_TEMPLATE,
-    workspaceDeps: false,
-    yes: false,
-    values: {},
-    listTemplates: false,
-    help: false,
-  };
-
-  for (let index = 0; index < argv.length; index += 1) {
-    const arg = argv[index];
-    if (!arg) continue;
-
-    if (arg === "--help" || arg === "-h") {
-      options.help = true;
-      continue;
-    }
-    if (arg === "--list-templates") {
-      options.listTemplates = true;
-      continue;
-    }
-    if (arg === "--yes" || arg === "-y") {
-      options.yes = true;
-      continue;
-    }
-    if (arg === "--workspace-deps") {
-      options.workspaceDeps = true;
-      continue;
-    }
-    if (arg === "--template") {
-      options.template = readValue(argv, ++index, arg) as TemplateId;
-      continue;
-    }
-    if (arg === "--federation-name") {
-      options.values.federationName = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--federate-name") {
-      options.values.federateName = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--federate-type") {
-      options.values.federateType = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rti-host") {
-      options.values.rtiHost = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rti-port") {
-      options.values.rtiPort = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rti-use-tls") {
-      options.values.rtiUseTls = "true";
-      continue;
-    }
-    if (arg === "--parent-reference-frame") {
-      options.values.parentReferenceFrame = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rover-name") {
-      options.values.roverName = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rover-type") {
-      options.values.roverType = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--rover-speed-mps") {
-      options.values.roverSpeedMps = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--lookahead-micros") {
-      options.values.lookaheadMicros = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--update-period-micros") {
-      options.values.updatePeriodMicros = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--reference-frame-timeout-ms") {
-      options.values.referenceFrameTimeoutMs = readValue(argv, ++index, arg);
-      continue;
-    }
-    if (arg === "--reference-frame-missing-mode") {
-      options.values.referenceFrameMissingMode = readValue(argv, ++index, arg);
-      continue;
-    }
-
-    if (arg.startsWith("--")) {
-      throw new Error(`Unknown flag: ${arg}`);
-    }
-
-    if (!options.targetDir) {
-      options.targetDir = arg;
-      continue;
-    }
-
-    throw new Error(`Unexpected argument: ${arg}`);
-  }
-
-  return options;
-}
-
-async function promptForMissingValues(
-  targetDir: string,
-  template: TemplateId,
-  values: Partial<TemplateValues>
-): Promise<Partial<TemplateValues>> {
-  const rl = readline.createInterface({ input: stdin, output: stdout });
-  const defaults = {
-    federationName: "SpaceFederation",
-    federateName: "LunarRover-1",
-    federateType: "LunarRover",
-    rtiHost: "localhost",
-    rtiPort: "15164",
-    rtiUseTls: "false",
-    parentReferenceFrame: "AitkenBasinLocalFixed",
-    roverName: "LunarRover-1",
-    roverType: "LunarRover",
-    roverSpeedMps: "0.5",
-    lookaheadMicros: "1000000",
-    updatePeriodMicros: "1000000",
-    referenceFrameTimeoutMs: "30000",
-    referenceFrameMissingMode: "continue",
-  } satisfies Partial<TemplateValues>;
-
-  try {
-    console.log(`Scaffolding template "${template}" into ${path.resolve(targetDir)}`);
-    console.log(TEMPLATE_DESCRIPTIONS[template]);
-    console.log("");
-
-    const federationName = await ask(
-      rl,
-      "Federation name",
-      values.federationName ?? defaults.federationName
-    );
-    const federateName = await ask(
-      rl,
-      "Federate name",
-      values.federateName ?? defaults.federateName
-    );
-    const federateType = await ask(
-      rl,
-      "Federate type",
-      values.federateType ?? defaults.federateType
-    );
-    const rtiHost = await ask(rl, "RTI host", values.rtiHost ?? defaults.rtiHost);
-    const rtiPort = await ask(rl, "RTI port", values.rtiPort ?? defaults.rtiPort);
-    const rtiUseTls = await askBool(rl, "Use TLS", values.rtiUseTls ?? defaults.rtiUseTls);
-    const parentReferenceFrame = await ask(
-      rl,
-      "Parent reference frame",
-      values.parentReferenceFrame ?? defaults.parentReferenceFrame
-    );
-    const roverName = await ask(
-      rl,
-      "Rover object name",
-      values.roverName ?? federateName ?? defaults.roverName
-    );
-    const roverType = await ask(
-      rl,
-      "Rover type",
-      values.roverType ?? federateType ?? defaults.roverType
-    );
-    const roverSpeedMps = await ask(
-      rl,
-      "Rover speed (m/s)",
-      values.roverSpeedMps ?? defaults.roverSpeedMps
-    );
-    const lookaheadMicros = await ask(
-      rl,
-      "Lookahead (micros)",
-      values.lookaheadMicros ?? defaults.lookaheadMicros
-    );
-    const updatePeriodMicros = await ask(
-      rl,
-      "Update period (micros)",
-      values.updatePeriodMicros ?? defaults.updatePeriodMicros
-    );
-    const referenceFrameTimeoutMs = await ask(
-      rl,
-      "Reference frame timeout (ms)",
-      values.referenceFrameTimeoutMs ?? defaults.referenceFrameTimeoutMs
-    );
-    const referenceFrameMissingMode = await ask(
-      rl,
-      "Missing frame mode (error/continue)",
-      values.referenceFrameMissingMode ?? defaults.referenceFrameMissingMode
-    );
-
-    return {
-      ...values,
-      federationName,
-      federateName,
-      federateType,
-      rtiHost,
-      rtiPort,
-      rtiUseTls,
-      parentReferenceFrame,
-      roverName,
-      roverType,
-      roverSpeedMps,
-      lookaheadMicros,
-      updatePeriodMicros,
-      referenceFrameTimeoutMs,
-      referenceFrameMissingMode,
-    };
-  } finally {
-    rl.close();
-  }
-}
-
-async function ask(
-  rl: readline.Interface,
-  label: string,
-  fallback: string | undefined
-): Promise<string> {
-  const resolvedFallback = fallback ?? "";
-  const response = await rl.question(`${label} (${resolvedFallback}): `);
-  return response.trim() === "" ? resolvedFallback : response.trim();
-}
-
-async function askBool(
-  rl: readline.Interface,
-  label: string,
-  fallback: string | undefined
-): Promise<string> {
-  const response = await ask(rl, `${label} [y/N]`, fallback === "true" ? "y" : "n");
-  const normalized = response.toLowerCase();
-  return ["y", "yes", "true", "1"].includes(normalized) ? "true" : "false";
-}
-
-function readValue(argv: string[], index: number, flag: string): string {
-  const value = argv[index];
-  if (!value) {
-    throw new Error(`Missing value for ${flag}`);
-  }
-  return value;
-}
-
-function isTemplateId(value: string): value is TemplateId {
-  return value in TEMPLATE_DESCRIPTIONS;
-}
-
-function printHelp(errorMessage?: string): void {
-  if (errorMessage) {
-    console.error(errorMessage);
-    console.error("");
-  }
-
-  console.log("Usage:");
+
+function parseArgs(argv: string[]): CliOptions {
+  const options: CliOptions = {
+    template: DEFAULT_TEMPLATE,
+    workspaceDeps: false,
+    yes: false,
+    values: {},
+    listTemplates: false,
+    help: false,
+  };
+
+  for (let index = 0; index < argv.length; index += 1) {
+    const arg = argv[index];
+    if (!arg) continue;
+
+    if (arg === "--help" || arg === "-h") {
+      options.help = true;
+      continue;
+    }
+    if (arg === "--list-templates") {
+      options.listTemplates = true;
+      continue;
+    }
+    if (arg === "--yes" || arg === "-y") {
+      options.yes = true;
+      continue;
+    }
+    if (arg === "--workspace-deps") {
+      options.workspaceDeps = true;
+      continue;
+    }
+    if (arg === "--template") {
+      options.template = readValue(argv, ++index, arg) as TemplateId;
+      continue;
+    }
+    if (arg === "--federation-name") {
+      options.values.federationName = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--federate-name") {
+      options.values.federateName = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--federate-type") {
+      options.values.federateType = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rti-host") {
+      options.values.rtiHost = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rti-port") {
+      options.values.rtiPort = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rti-use-tls") {
+      options.values.rtiUseTls = "true";
+      continue;
+    }
+    if (arg === "--parent-reference-frame") {
+      options.values.parentReferenceFrame = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rover-name") {
+      options.values.roverName = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rover-type") {
+      options.values.roverType = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--rover-speed-mps") {
+      options.values.roverSpeedMps = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--lookahead-micros") {
+      options.values.lookaheadMicros = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--update-period-micros") {
+      options.values.updatePeriodMicros = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--reference-frame-timeout-ms") {
+      options.values.referenceFrameTimeoutMs = readValue(argv, ++index, arg);
+      continue;
+    }
+    if (arg === "--reference-frame-missing-mode") {
+      options.values.referenceFrameMissingMode = readValue(argv, ++index, arg);
+      continue;
+    }
+
+    if (arg.startsWith("--")) {
+      throw new Error(`Unknown flag: ${arg}`);
+    }
+
+    if (!options.targetDir) {
+      options.targetDir = arg;
+      continue;
+    }
+
+    throw new Error(`Unexpected argument: ${arg}`);
+  }
+
+  return options;
+}
+
+async function promptForMissingValues(
+  targetDir: string,
+  template: TemplateId,
+  values: Partial<TemplateValues>
+): Promise<Partial<TemplateValues>> {
+  const rl = readline.createInterface({ input: stdin, output: stdout });
+  const defaults = {
+    federationName: "SpaceFederation",
+    federateName: "LunarRover-1",
+    federateType: "LunarRover",
+    rtiHost: "localhost",
+    rtiPort: "15164",
+    rtiUseTls: "false",
+    parentReferenceFrame: "AitkenBasinLocalFixed",
+    roverName: "LunarRover-1",
+    roverType: "LunarRover",
+    roverSpeedMps: "0.5",
+    lookaheadMicros: "1000000",
+    updatePeriodMicros: "1000000",
+    referenceFrameTimeoutMs: "30000",
+    referenceFrameMissingMode: "continue",
+  } satisfies Partial<TemplateValues>;
+
+  try {
+    console.log(`Scaffolding template "${template}" into ${path.resolve(targetDir)}`);
+    console.log(TEMPLATE_DESCRIPTIONS[template]);
+    console.log("");
+
+    const federationName = await ask(
+      rl,
+      "Federation name",
+      values.federationName ?? defaults.federationName
+    );
+    const federateName = await ask(
+      rl,
+      "Federate name",
+      values.federateName ?? defaults.federateName
+    );
+    const federateType = await ask(
+      rl,
+      "Federate type",
+      values.federateType ?? defaults.federateType
+    );
+    const rtiHost = await ask(rl, "RTI host", values.rtiHost ?? defaults.rtiHost);
+    const rtiPort = await ask(rl, "RTI port", values.rtiPort ?? defaults.rtiPort);
+    const rtiUseTls = await askBool(rl, "Use TLS", values.rtiUseTls ?? defaults.rtiUseTls);
+    const parentReferenceFrame = await ask(
+      rl,
+      "Parent reference frame",
+      values.parentReferenceFrame ?? defaults.parentReferenceFrame
+    );
+    const roverName = await ask(
+      rl,
+      "Rover object name",
+      values.roverName ?? federateName ?? defaults.roverName
+    );
+    const roverType = await ask(
+      rl,
+      "Rover type",
+      values.roverType ?? federateType ?? defaults.roverType
+    );
+    const roverSpeedMps = await ask(
+      rl,
+      "Rover speed (m/s)",
+      values.roverSpeedMps ?? defaults.roverSpeedMps
+    );
+    const lookaheadMicros = await ask(
+      rl,
+      "Lookahead (micros)",
+      values.lookaheadMicros ?? defaults.lookaheadMicros
+    );
+    const updatePeriodMicros = await ask(
+      rl,
+      "Update period (micros)",
+      values.updatePeriodMicros ?? defaults.updatePeriodMicros
+    );
+    const referenceFrameTimeoutMs = await ask(
+      rl,
+      "Reference frame timeout (ms)",
+      values.referenceFrameTimeoutMs ?? defaults.referenceFrameTimeoutMs
+    );
+    const referenceFrameMissingMode = await ask(
+      rl,
+      "Missing frame mode (error/continue)",
+      values.referenceFrameMissingMode ?? defaults.referenceFrameMissingMode
+    );
+
+    return {
+      ...values,
+      federationName,
+      federateName,
+      federateType,
+      rtiHost,
+      rtiPort,
+      rtiUseTls,
+      parentReferenceFrame,
+      roverName,
+      roverType,
+      roverSpeedMps,
+      lookaheadMicros,
+      updatePeriodMicros,
+      referenceFrameTimeoutMs,
+      referenceFrameMissingMode,
+    };
+  } finally {
+    rl.close();
+  }
+}
+
+async function ask(
+  rl: readline.Interface,
+  label: string,
+  fallback: string | undefined
+): Promise<string> {
+  const resolvedFallback = fallback ?? "";
+  const response = await rl.question(`${label} (${resolvedFallback}): `);
+  return response.trim() === "" ? resolvedFallback : response.trim();
+}
+
+async function askBool(
+  rl: readline.Interface,
+  label: string,
+  fallback: string | undefined
+): Promise<string> {
+  const response = await ask(rl, `${label} [y/N]`, fallback === "true" ? "y" : "n");
+  const normalized = response.toLowerCase();
+  return ["y", "yes", "true", "1"].includes(normalized) ? "true" : "false";
+}
+
+function readValue(argv: string[], index: number, flag: string): string {
+  const value = argv[index];
+  if (!value) {
+    throw new Error(`Missing value for ${flag}`);
+  }
+  return value;
+}
+
+function isTemplateId(value: string): value is TemplateId {
+  return value in TEMPLATE_DESCRIPTIONS;
+}
+
+function printHelp(errorMessage?: string): void {
+  if (errorMessage) {
+    console.error(errorMessage);
+    console.error("");
+  }
+
+  console.log("Usage:");
   console.log("  spacekit <target-dir> [options]");
-  console.log("");
-  console.log("Options:");
-  console.log("  --template <name>                   Template to use (default: lunar-rover)");
-  console.log("  --list-templates                    Print the available templates");
-  console.log("  --federation-name <name>            Default federation name in .env");
-  console.log("  --federate-name <name>              Default federate name in .env");
-  console.log("  --federate-type <type>              Default federate type in .env");
-  console.log("  --rti-host <host>                   Default RTI host in .env");
-  console.log("  --rti-port <port>                   Default RTI port in .env");
-  console.log("  --rti-use-tls                       Enable TLS in .env");
-  console.log("  --parent-reference-frame <name>     Parent frame for the rover entity");
-  console.log("  --rover-name <name>                 Rover object instance name");
-  console.log("  --rover-type <type>                 Rover object type");
-  console.log("  --rover-speed-mps <value>           Rover speed along the X axis");
-  console.log("  --lookahead-micros <value>          Spacekit lookahead");
-  console.log("  --update-period-micros <value>      Spacekit tick period");
-  console.log("  --reference-frame-timeout-ms <ms>   How long to wait for the frame tree");
-  console.log("  --reference-frame-missing-mode <m>  error | continue");
-  console.log("  --workspace-deps                    Use workspace:* for @hla4ts/spacekit");
-  console.log("  --yes, -y                           Skip prompts and use defaults/flags");
-  console.log("  --help, -h                          Show this help text");
-}
+  console.log("");
+  console.log("Options:");
+  console.log("  --template <name>                   Template to use (default: lunar-rover)");
+  console.log("  --list-templates                    Print the available templates");
+  console.log("  --federation-name <name>            Default federation name in .env");
+  console.log("  --federate-name <name>              Default federate name in .env");
+  console.log("  --federate-type <type>              Default federate type in .env");
+  console.log("  --rti-host <host>                   Default RTI host in .env");
+  console.log("  --rti-port <port>                   Default RTI port in .env");
+  console.log("  --rti-use-tls                       Enable TLS in .env");
+  console.log("  --parent-reference-frame <name>     Parent frame for the rover entity");
+  console.log("  --rover-name <name>                 Rover object instance name");
+  console.log("  --rover-type <type>                 Rover object type");
+  console.log("  --rover-speed-mps <value>           Rover speed along the X axis");
+  console.log("  --lookahead-micros <value>          Spacekit lookahead");
+  console.log("  --update-period-micros <value>      Spacekit tick period");
+  console.log("  --reference-frame-timeout-ms <ms>   How long to wait for the frame tree");
+  console.log("  --reference-frame-missing-mode <m>  error | continue");
+  console.log("  --workspace-deps                    Use workspace:* for @hla4ts/spacekit");
+  console.log("  --yes, -y                           Skip prompts and use defaults/flags");
+  console.log("  --help, -h                          Show this help text");
+}