@hla4ts/create-spacekit 0.1.0 → 0.1.1

package/src/index.ts

@@ -1,11 +1,11 @@
-export {
-  DEFAULT_TEMPLATE,
-  TEMPLATE_DESCRIPTIONS,
-  listTemplates,
-  sanitizePackageName,
-  scaffoldApp,
-  type ScaffoldAppOptions,
-  type ScaffoldAppResult,
-  type TemplateId,
-  type TemplateValues,
-} from "./scaffold.ts";
+export {
+  DEFAULT_TEMPLATE,
+  TEMPLATE_DESCRIPTIONS,
+  listTemplates,
+  sanitizePackageName,
+  scaffoldApp,
+  type ScaffoldAppOptions,
+  type ScaffoldAppResult,
+  type TemplateId,
+  type TemplateValues,
+} from "./scaffold.ts";

package/src/scaffold.test.ts

@@ -1,56 +1,56 @@
-import { describe, expect, test } from "bun:test";
-import { promises as fs } from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import { sanitizePackageName, scaffoldApp } from "./scaffold.ts";
-
+import { describe, expect, test } from "bun:test";
+import { promises as fs } from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { sanitizePackageName, scaffoldApp } from "./scaffold.ts";
+
 describe("@hla4ts/create-spacekit", () => {
-  test("sanitizePackageName normalizes arbitrary folder names", () => {
-    expect(sanitizePackageName("My Lunar Rover!")).toBe("my-lunar-rover");
-    expect(sanitizePackageName("  ")).toBe("hla4ts-spacekit-app");
-  });
-
-  test("scaffoldApp creates a configurable lunar rover project", async () => {
-    const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "hla4ts-scaffold-"));
-    const targetDir = path.join(tempRoot, "mission-rover");
-
-    await scaffoldApp({
-      targetDir,
-      values: {
-        spacekitDependency: "workspace:*",
-        referenceFrameMissingMode: "continue",
-        federationName: "MoonOps",
-        federateName: "Rover-Blue",
-        federateType: "ScoutRover",
-        rtiHost: "10.0.0.12",
-        roverSpeedMps: "1.25",
-      },
-    });
-
-    const packageJson = await fs.readFile(path.join(targetDir, "package.json"), "utf8");
-    const envFile = await fs.readFile(path.join(targetDir, ".env"), "utf8");
-    const indexFile = await fs.readFile(path.join(targetDir, "src", "index.ts"), "utf8");
-
-    expect(packageJson).toContain('"name": "mission-rover"');
-    expect(packageJson).toContain('"@hla4ts/spacekit": "workspace:*"');
-    expect(envFile).toContain("FEDERATION_NAME=MoonOps");
-    expect(envFile).toContain("FEDERATE_NAME=Rover-Blue");
-    expect(envFile).toContain("ROVER_NAME=Rover-Blue");
-    expect(envFile).toContain("ROVER_TYPE=ScoutRover");
-    expect(envFile).toContain("REFERENCE_FRAME_MISSING_MODE=continue");
-    expect(envFile).toContain("RTI_HOST=10.0.0.12");
-    expect(envFile).toContain("ROVER_SPEED_MPS=1.25");
-    expect(indexFile).toContain('import { PhysicalEntity, SpacekitApp');
-  });
-
-  test("scaffoldApp refuses non-empty target directories", async () => {
-    const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "hla4ts-scaffold-"));
-    const targetDir = path.join(tempRoot, "existing");
-    await fs.mkdir(targetDir, { recursive: true });
-    await fs.writeFile(path.join(targetDir, "keep.txt"), "existing", "utf8");
-
-    await expect(scaffoldApp({ targetDir })).rejects.toThrow(
-      "Refusing to scaffold into a non-empty directory"
-    );
-  });
-});
+  test("sanitizePackageName normalizes arbitrary folder names", () => {
+    expect(sanitizePackageName("My Lunar Rover!")).toBe("my-lunar-rover");
+    expect(sanitizePackageName("  ")).toBe("hla4ts-spacekit-app");
+  });
+
+  test("scaffoldApp creates a configurable lunar rover project", async () => {
+    const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "hla4ts-scaffold-"));
+    const targetDir = path.join(tempRoot, "mission-rover");
+
+    await scaffoldApp({
+      targetDir,
+      values: {
+        spacekitDependency: "workspace:*",
+        referenceFrameMissingMode: "continue",
+        federationName: "MoonOps",
+        federateName: "Rover-Blue",
+        federateType: "ScoutRover",
+        rtiHost: "10.0.0.12",
+        roverSpeedMps: "1.25",
+      },
+    });
+
+    const packageJson = await fs.readFile(path.join(targetDir, "package.json"), "utf8");
+    const envFile = await fs.readFile(path.join(targetDir, ".env"), "utf8");
+    const indexFile = await fs.readFile(path.join(targetDir, "src", "index.ts"), "utf8");
+
+    expect(packageJson).toContain('"name": "mission-rover"');
+    expect(packageJson).toContain('"@hla4ts/spacekit": "workspace:*"');
+    expect(envFile).toContain("FEDERATION_NAME=MoonOps");
+    expect(envFile).toContain("FEDERATE_NAME=Rover-Blue");
+    expect(envFile).toContain("ROVER_NAME=Rover-Blue");
+    expect(envFile).toContain("ROVER_TYPE=ScoutRover");
+    expect(envFile).toContain("REFERENCE_FRAME_MISSING_MODE=continue");
+    expect(envFile).toContain("RTI_HOST=10.0.0.12");
+    expect(envFile).toContain("ROVER_SPEED_MPS=1.25");
+    expect(indexFile).toContain('import { PhysicalEntity, SpacekitApp');
+  });
+
+  test("scaffoldApp refuses non-empty target directories", async () => {
+    const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "hla4ts-scaffold-"));
+    const targetDir = path.join(tempRoot, "existing");
+    await fs.mkdir(targetDir, { recursive: true });
+    await fs.writeFile(path.join(targetDir, "keep.txt"), "existing", "utf8");
+
+    await expect(scaffoldApp({ targetDir })).rejects.toThrow(
+      "Refusing to scaffold into a non-empty directory"
+    );
+  });
+});

package/src/scaffold.ts

@@ -1,199 +1,199 @@
-import { promises as fs } from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-export const DEFAULT_TEMPLATE = "lunar-rover";
-
-export const TEMPLATE_DESCRIPTIONS = {
-  "lunar-rover":
-    "Minimal Spacekit lunar rover with .env-driven RTI, federation, and timing config.",
-} as const;
-
-export type TemplateId = keyof typeof TEMPLATE_DESCRIPTIONS;
-
-export interface TemplateValues {
-  appName: string;
-  packageName: string;
-  spacekitDependency: "^0.1.0",
-  referenceFrameMissingMode: string;
-  federationName: string;
-  federateName: string;
-  federateType: string;
-  rtiHost: string;
-  rtiPort: string;
-  rtiUseTls: string;
-  parentReferenceFrame: string;
-  roverName: string;
-  roverType: string;
-  roverSpeedMps: string;
-  lookaheadMicros: string;
-  updatePeriodMicros: string;
-  referenceFrameTimeoutMs: string;
-}
-
-export interface ScaffoldAppOptions {
-  targetDir: string;
-  template?: TemplateId;
-  values?: Partial<TemplateValues>;
-}
-
-export interface ScaffoldAppResult {
-  template: TemplateId;
-  targetDir: string;
-  packageName: string;
-  filesWritten: number;
-}
-
-export async function scaffoldApp(options: ScaffoldAppOptions): Promise<ScaffoldAppResult> {
-  const template = options.template ?? DEFAULT_TEMPLATE;
-  assertTemplate(template);
-
-  const targetDir = path.resolve(options.targetDir);
-  await ensureEmptyTargetDirectory(targetDir);
-
-  const appName = deriveAppName(targetDir);
-  const values = {
-    ...defaultTemplateValues(appName),
-    ...(options.values ?? {}),
-  };
-  values.appName = values.appName.trim() || appName;
-  values.packageName = sanitizePackageName(values.packageName || values.appName);
-  values.roverName =
-    options.values?.roverName === undefined
-      ? values.federateName
-      : values.roverName.trim() || values.federateName;
-  values.roverType =
-    options.values?.roverType === undefined
-      ? values.federateType
-      : values.roverType.trim() || values.federateType;
-
-  const templateDir = resolveTemplateDir(template);
-  const files = await collectTemplateFiles(templateDir);
-
-  let filesWritten = 0;
-  for (const sourceFile of files) {
-    const relativePath = path.relative(templateDir, sourceFile);
-    const destinationPath = path.join(targetDir, relativePath);
-    await fs.mkdir(path.dirname(destinationPath), { recursive: true });
-    const content = await fs.readFile(sourceFile, "utf8");
-    const rendered = renderTemplate(content, values);
-    await fs.writeFile(destinationPath, rendered, "utf8");
-    filesWritten += 1;
-  }
-
-  return {
-    template,
-    targetDir,
-    packageName: values.packageName,
-    filesWritten,
-  };
-}
-
-export function listTemplates(): Array<{ id: TemplateId; description: string }> {
-  return (Object.entries(TEMPLATE_DESCRIPTIONS) as Array<[TemplateId, string]>).map(
-    ([id, description]) => ({ id, description })
-  );
-}
-
-export function sanitizePackageName(value: string): string {
-  const normalized = value
-    .trim()
-    .toLowerCase()
-    .replace(/[^a-z0-9]+/g, "-")
-    .replace(/^-+|-+$/g, "");
-
-  return normalized.length > 0 ? normalized : "hla4ts-spacekit-app";
-}
-
-function defaultTemplateValues(appName: string): TemplateValues {
-  return {
-    appName,
-    packageName: sanitizePackageName(appName),
-    spacekitDependency: "^0.1.0",
-    referenceFrameMissingMode: "continue",
-    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",
-  };
-}
-
-function assertTemplate(template: string): asserts template is TemplateId {
-  if (!(template in TEMPLATE_DESCRIPTIONS)) {
-    throw new Error(`Unknown template "${template}". Run --list-templates to inspect choices.`);
-  }
-}
-
-async function ensureEmptyTargetDirectory(targetDir: string): Promise<void> {
-  try {
-    const stat = await fs.stat(targetDir);
-    if (!stat.isDirectory()) {
-      throw new Error(`Target path exists and is not a directory: ${targetDir}`);
-    }
-    const entries = await fs.readdir(targetDir);
-    if (entries.length > 0) {
-      throw new Error(`Refusing to scaffold into a non-empty directory: ${targetDir}`);
-    }
-  } catch (error) {
-    if (isMissing(error)) {
-      await fs.mkdir(targetDir, { recursive: true });
-      return;
-    }
-    throw error;
-  }
-}
-
-async function collectTemplateFiles(root: string): Promise<string[]> {
-  const entries = await fs.readdir(root, { withFileTypes: true });
-  const files: string[] = [];
-
-  for (const entry of entries) {
-    const fullPath = path.join(root, entry.name);
-    if (entry.isDirectory()) {
-      files.push(...(await collectTemplateFiles(fullPath)));
-      continue;
-    }
-    if (entry.isFile()) {
-      files.push(fullPath);
-    }
-  }
-
-  return files.sort();
-}
-
-function renderTemplate(content: string, values: TemplateValues): string {
-  return content.replace(/\{\{([A-Z_]+)\}\}/g, (_match, rawKey: string) => {
-    const key = toTemplateValueKey(rawKey);
-    return values[key] ?? _match;
-  });
-}
-
-function toTemplateValueKey(rawKey: string): keyof TemplateValues {
-  const key = rawKey.toLowerCase().replace(/_([a-z])/g, (_match, letter: string) =>
-    letter.toUpperCase()
-  );
-  return key as keyof TemplateValues;
-}
-
-function deriveAppName(targetDir: string): string {
-  const base = path.basename(targetDir);
-  return base === "." || base.length === 0 ? "hla4ts-spacekit-app" : base;
-}
-
-function resolveTemplateDir(template: TemplateId): string {
-  const currentFile = fileURLToPath(import.meta.url);
-  return path.resolve(path.dirname(currentFile), "..", "templates", template);
-}
-
-function isMissing(error: unknown): boolean {
-  return error instanceof Error && "code" in error && error.code === "ENOENT";
-}
+import { promises as fs } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+export const DEFAULT_TEMPLATE = "lunar-rover";
+
+export const TEMPLATE_DESCRIPTIONS = {
+  "lunar-rover":
+    "Minimal Spacekit lunar rover with .env-driven RTI, federation, and timing config.",
+} as const;
+
+export type TemplateId = keyof typeof TEMPLATE_DESCRIPTIONS;
+
+export interface TemplateValues {
+  appName: string;
+  packageName: string;
+  spacekitDependency: string;
+  referenceFrameMissingMode: string;
+  federationName: string;
+  federateName: string;
+  federateType: string;
+  rtiHost: string;
+  rtiPort: string;
+  rtiUseTls: string;
+  parentReferenceFrame: string;
+  roverName: string;
+  roverType: string;
+  roverSpeedMps: string;
+  lookaheadMicros: string;
+  updatePeriodMicros: string;
+  referenceFrameTimeoutMs: string;
+}
+
+export interface ScaffoldAppOptions {
+  targetDir: string;
+  template?: TemplateId;
+  values?: Partial<TemplateValues>;
+}
+
+export interface ScaffoldAppResult {
+  template: TemplateId;
+  targetDir: string;
+  packageName: string;
+  filesWritten: number;
+}
+
+export async function scaffoldApp(options: ScaffoldAppOptions): Promise<ScaffoldAppResult> {
+  const template = options.template ?? DEFAULT_TEMPLATE;
+  assertTemplate(template);
+
+  const targetDir = path.resolve(options.targetDir);
+  await ensureEmptyTargetDirectory(targetDir);
+
+  const appName = deriveAppName(targetDir);
+  const values = {
+    ...defaultTemplateValues(appName),
+    ...(options.values ?? {}),
+  };
+  values.appName = values.appName.trim() || appName;
+  values.packageName = sanitizePackageName(values.packageName || values.appName);
+  values.roverName =
+    options.values?.roverName === undefined
+      ? values.federateName
+      : values.roverName.trim() || values.federateName;
+  values.roverType =
+    options.values?.roverType === undefined
+      ? values.federateType
+      : values.roverType.trim() || values.federateType;
+
+  const templateDir = resolveTemplateDir(template);
+  const files = await collectTemplateFiles(templateDir);
+
+  let filesWritten = 0;
+  for (const sourceFile of files) {
+    const relativePath = path.relative(templateDir, sourceFile);
+    const destinationPath = path.join(targetDir, relativePath);
+    await fs.mkdir(path.dirname(destinationPath), { recursive: true });
+    const content = await fs.readFile(sourceFile, "utf8");
+    const rendered = renderTemplate(content, values);
+    await fs.writeFile(destinationPath, rendered, "utf8");
+    filesWritten += 1;
+  }
+
+  return {
+    template,
+    targetDir,
+    packageName: values.packageName,
+    filesWritten,
+  };
+}
+
+export function listTemplates(): Array<{ id: TemplateId; description: string }> {
+  return (Object.entries(TEMPLATE_DESCRIPTIONS) as Array<[TemplateId, string]>).map(
+    ([id, description]) => ({ id, description })
+  );
+}
+
+export function sanitizePackageName(value: string): string {
+  const normalized = value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+
+  return normalized.length > 0 ? normalized : "hla4ts-spacekit-app";
+}
+
+function defaultTemplateValues(appName: string): TemplateValues {
+  return {
+    appName,
+    packageName: sanitizePackageName(appName),
+    spacekitDependency: "^0.1.1",
+    referenceFrameMissingMode: "continue",
+    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",
+  };
+}
+
+function assertTemplate(template: string): asserts template is TemplateId {
+  if (!(template in TEMPLATE_DESCRIPTIONS)) {
+    throw new Error(`Unknown template "${template}". Run --list-templates to inspect choices.`);
+  }
+}
+
+async function ensureEmptyTargetDirectory(targetDir: string): Promise<void> {
+  try {
+    const stat = await fs.stat(targetDir);
+    if (!stat.isDirectory()) {
+      throw new Error(`Target path exists and is not a directory: ${targetDir}`);
+    }
+    const entries = await fs.readdir(targetDir);
+    if (entries.length > 0) {
+      throw new Error(`Refusing to scaffold into a non-empty directory: ${targetDir}`);
+    }
+  } catch (error) {
+    if (isMissing(error)) {
+      await fs.mkdir(targetDir, { recursive: true });
+      return;
+    }
+    throw error;
+  }
+}
+
+async function collectTemplateFiles(root: string): Promise<string[]> {
+  const entries = await fs.readdir(root, { withFileTypes: true });
+  const files: string[] = [];
+
+  for (const entry of entries) {
+    const fullPath = path.join(root, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...(await collectTemplateFiles(fullPath)));
+      continue;
+    }
+    if (entry.isFile()) {
+      files.push(fullPath);
+    }
+  }
+
+  return files.sort();
+}
+
+function renderTemplate(content: string, values: TemplateValues): string {
+  return content.replace(/\{\{([A-Z_]+)\}\}/g, (_match, rawKey: string) => {
+    const key = toTemplateValueKey(rawKey);
+    return values[key] ?? _match;
+  });
+}
+
+function toTemplateValueKey(rawKey: string): keyof TemplateValues {
+  const key = rawKey.toLowerCase().replace(/_([a-z])/g, (_match, letter: string) =>
+    letter.toUpperCase()
+  );
+  return key as keyof TemplateValues;
+}
+
+function deriveAppName(targetDir: string): string {
+  const base = path.basename(targetDir);
+  return base === "." || base.length === 0 ? "hla4ts-spacekit-app" : base;
+}
+
+function resolveTemplateDir(template: TemplateId): string {
+  const currentFile = fileURLToPath(import.meta.url);
+  return path.resolve(path.dirname(currentFile), "..", "templates", template);
+}
+
+function isMissing(error: unknown): boolean {
+  return error instanceof Error && "code" in error && error.code === "ENOENT";
+}

package/templates/lunar-rover/README.md

@@ -1,37 +1,37 @@
-# {{APP_NAME}}
-
+# {{APP_NAME}}
+
 Minimal lunar rover example generated by `spacekit` from `@hla4ts/create-spacekit`.
-
-This app uses `@hla4ts/spacekit` directly:
-
-- `SpacekitApp.run()` owns the join/bootstrap/tick loop
-- `PhysicalEntity` publishes a single rover object
-- `.env` contains the RTI, federation, rover, and timing defaults
-
-## Prerequisites
-
-- Bun installed
-- an HLA 4 RTI reachable at the configured host/port
-- SpaceMaster and a root reference frame publisher if you are running a SEE late-join federation
-
-## Configure
-
-Edit `.env` if needed:
-
-- `RTI_HOST`, `RTI_PORT`, `RTI_USE_TLS`
-- `FEDERATION_NAME`, `FEDERATE_NAME`, `FEDERATE_TYPE`
-- `ROVER_NAME`, `ROVER_TYPE`, `PARENT_REFERENCE_FRAME`
-- `ROVER_SPEED_MPS`, `LOOKAHEAD_MICROS`, `UPDATE_PERIOD_MICROS`
-- `REFERENCE_FRAME_MISSING_MODE` (`continue` by default)
-
-## Run
-
-```bash
-bun install
-bun run start
-```
-
-The rover moves forward along the X axis at the configured speed and logs each
-published tick. By default the generated app uses `continue` mode for missing
-reference frames, so it warns and keeps running if the configured parent frame
-has not been published yet.
+
+This app uses `@hla4ts/spacekit` directly:
+
+- `SpacekitApp.run()` owns the join/bootstrap/tick loop
+- `PhysicalEntity` publishes a single rover object
+- `.env` contains the RTI, federation, rover, and timing defaults
+
+## Prerequisites
+
+- Bun installed
+- an HLA 4 RTI reachable at the configured host/port
+- SpaceMaster and a root reference frame publisher if you are running a SEE late-join federation
+
+## Configure
+
+Edit `.env` if needed:
+
+- `RTI_HOST`, `RTI_PORT`, `RTI_USE_TLS`
+- `FEDERATION_NAME`, `FEDERATE_NAME`, `FEDERATE_TYPE`
+- `ROVER_NAME`, `ROVER_TYPE`, `PARENT_REFERENCE_FRAME`
+- `ROVER_SPEED_MPS`, `LOOKAHEAD_MICROS`, `UPDATE_PERIOD_MICROS`
+- `REFERENCE_FRAME_MISSING_MODE` (`continue` by default)
+
+## Run
+
+```bash
+bun install
+bun run start
+```
+
+The rover moves forward along the X axis at the configured speed and logs each
+published tick. By default the generated app uses `continue` mode for missing
+reference frames, so it warns and keeps running if the configured parent frame
+has not been published yet.

package/templates/lunar-rover/package.json

@@ -1,17 +1,17 @@
-{
-  "name": "{{PACKAGE_NAME}}",
-  "version": "0.1.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "start": "bun run src/index.ts",
-    "typecheck": "tsc --noEmit"
-  },
-  "dependencies": {
-    "@hla4ts/spacekit": "{{SPACEKIT_DEPENDENCY}}"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "typescript": "^5.9.0"
-  }
-}
+{
+  "name": "{{PACKAGE_NAME}}",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "start": "bun run src/index.ts",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@hla4ts/spacekit": "{{SPACEKIT_DEPENDENCY}}"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.9.0"
+  }
+}