reset-framework-cli 1.2.1 → 1.2.4

package/src/commands/package.js

@@ -1,68 +1,68 @@
-import { existsSync } from "node:fs"
-
-import { createMacOSZipArchive, createWindowsZipArchive } from "../lib/output.js"
-import {
-  assertAppProject,
-  loadResetConfig,
-  resolveAppOutputPaths,
-  resolveAppPaths
-} from "../lib/project.js"
-import {
-  createProgress,
-  printBanner,
-  printKeyValueTable,
-  printSection,
-  printStatusTable
-} from "../lib/ui.js"
-
-export const description = "Package the built desktop app into a distributable archive"
-
-export async function run(context) {
-  const dryRun = Boolean(context.flags["dry-run"])
-  const isWindows = process.platform === "win32"
-  const archiveBuilder = isWindows ? createWindowsZipArchive : createMacOSZipArchive
-  const archiveDescription = isWindows
-    ? "Create a Windows zip package from the built app folder"
-    : "Create a macOS zip package from the built app bundle"
-  const appPaths = resolveAppPaths(context.projectRoot)
-  assertAppProject(appPaths)
-
-  const config = loadResetConfig(appPaths)
-  assertAppProject(appPaths, config)
-  const outputPaths = resolveAppOutputPaths(appPaths, config)
-
-  printBanner("reset-framework-cli package", description)
-  printSection("Project")
-  printKeyValueTable([
-    ["Desktop app", outputPaths.appBundlePath],
-    ["Archive", outputPaths.zipPath]
-  ])
-  console.log("")
-
-  printSection("Plan")
-  printStatusTable([
-    ["ready", "Archive", archiveDescription]
-  ])
-
-  if (!existsSync(outputPaths.appBundlePath) && !dryRun) {
-    throw new Error(
-      `Missing built app bundle at ${outputPaths.appBundlePath}. Run 'reset-framework-cli build' first.`
-    )
-  }
-
-  if (dryRun) {
-    console.log("")
-    printSection("Dry run")
-    printStatusTable([["plan", "Package", "No archive will be written"]])
-    return
-  }
-
-  console.log("")
-  const progress = createProgress(1, "Package")
-  await archiveBuilder(outputPaths, { dryRun })
-  progress.tick("Archive created")
-
-  console.log("")
-  printSection("Result")
-  printStatusTable([["done", "Package", outputPaths.zipPath]])
-}
+import { existsSync } from "node:fs"
+
+import { createMacOSZipArchive, createWindowsZipArchive } from "../lib/output.js"
+import {
+  assertAppProject,
+  loadResetConfig,
+  resolveAppOutputPaths,
+  resolveAppPaths
+} from "../lib/project.js"
+import {
+  createProgress,
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+export const description = "Package the built desktop app into a distributable archive"
+
+export async function run(context) {
+  const dryRun = Boolean(context.flags["dry-run"])
+  const isWindows = process.platform === "win32"
+  const archiveBuilder = isWindows ? createWindowsZipArchive : createMacOSZipArchive
+  const archiveDescription = isWindows
+    ? "Create a Windows zip package from the built app folder"
+    : "Create a macOS zip package from the built app bundle"
+  const appPaths = resolveAppPaths(context.projectRoot)
+  assertAppProject(appPaths)
+
+  const config = loadResetConfig(appPaths)
+  assertAppProject(appPaths, config)
+  const outputPaths = resolveAppOutputPaths(appPaths, config)
+
+  printBanner("reset-framework-cli package", description)
+  printSection("Project")
+  printKeyValueTable([
+    ["Desktop app", outputPaths.appBundlePath],
+    ["Archive", outputPaths.zipPath]
+  ])
+  console.log("")
+
+  printSection("Plan")
+  printStatusTable([
+    ["ready", "Archive", archiveDescription]
+  ])
+
+  if (!existsSync(outputPaths.appBundlePath) && !dryRun) {
+    throw new Error(
+      `Missing built app bundle at ${outputPaths.appBundlePath}. Run 'reset-framework-cli build' first.`
+    )
+  }
+
+  if (dryRun) {
+    console.log("")
+    printSection("Dry run")
+    printStatusTable([["plan", "Package", "No archive will be written"]])
+    return
+  }
+
+  console.log("")
+  const progress = createProgress(1, "Package")
+  await archiveBuilder(outputPaths, { dryRun })
+  progress.tick("Archive created")
+
+  console.log("")
+  printSection("Result")
+  printStatusTable([["done", "Package", outputPaths.zipPath]])
+}

package/src/index.js

@@ -1,21 +1,21 @@
 #!/usr/bin/env node
-
-import { run as runBuild, description as buildDescription } from "./commands/build.js"
-import { run as runCreateApp, description as createAppDescription } from "./commands/init.js"
-import { run as runDev, description as devDescription } from "./commands/dev.js"
-import { run as runDoctor, description as doctorDescription } from "./commands/doctor.js"
-import { run as runInit, description as initDescription } from "./commands/init.js"
-import { run as runPackage, description as packageDescription } from "./commands/package.js"
-import { createCommandContext } from "./lib/context.js"
-import { logger } from "./lib/logger.js"
-import {
-  printBanner,
-  printCommandList,
-  printKeyValueTable,
-  printSection
-} from "./lib/ui.js"
-
-const commands = {
+
+import { run as runBuild, description as buildDescription } from "./commands/build.js"
+import { run as runCreateApp, description as createAppDescription } from "./commands/init.js"
+import { run as runDev, description as devDescription } from "./commands/dev.js"
+import { run as runDoctor, description as doctorDescription } from "./commands/doctor.js"
+import { run as runInit, description as initDescription } from "./commands/init.js"
+import { run as runPackage, description as packageDescription } from "./commands/package.js"
+import { createCommandContext } from "./lib/context.js"
+import { logger } from "./lib/logger.js"
+import {
+  printBanner,
+  printCommandList,
+  printKeyValueTable,
+  printSection
+} from "./lib/ui.js"
+
+const commands = {
   build: {
     description: buildDescription,
     usage: "reset-framework-cli build [--skip-frontend] [--skip-runtime] [--skip-stage] [--runtime-source] [--dry-run]",
@@ -26,37 +26,37 @@ const commands = {
       ["--runtime-source", "Build the runtime from @reset-framework/native instead of using a bundled runtime package"],
       ["--dry-run", "Print the build plan without running commands"]
     ],
-    examples: [
-      "reset-framework-cli build",
-      "reset-framework-cli build --dry-run"
-    ],
-    run: runBuild
-  },
-  "create-app": {
-    description: createAppDescription,
-    usage: "reset-framework-cli create-app <directory> [options]",
-    options: [
-      ["--template <name>", "Choose a starter template"],
-      ["--tailwind", "Use the Tailwind CSS starter"],
-      ["--no-tailwind", "Keep the plain CSS starter"],
-      ["--frontend-dir <path>", "Use a custom relative frontend directory"],
-      ["--flat", "Place the frontend directly in the project root"],
-      ["--product-name <name>", "Override the generated product name"],
-      ["--app-id <id>", "Override the generated app identifier"],
-      ["--package-manager <name>", "Choose npm, pnpm, yarn, or bun for dependency install"],
-      ["--no-install", "Skip installing frontend dependencies after scaffolding"],
-      ["--force", "Allow scaffolding into an existing directory"],
-      ["--yes", "Skip the interactive questionnaire and use defaults"],
-      ["--no-prompt", "Disable prompts even in an interactive terminal"],
-      ["--dry-run", "Preview the scaffold plan without writing files"]
-    ],
-    examples: [
-      "reset-framework-cli create-app my-app",
-      "reset-framework-cli create-app my-app --tailwind",
-      "reset-framework-cli create-app my-app --flat --yes"
-    ],
-    run: runCreateApp
-  },
+    examples: [
+      "reset-framework-cli build",
+      "reset-framework-cli build --dry-run"
+    ],
+    run: runBuild
+  },
+  "create-app": {
+    description: createAppDescription,
+    usage: "reset-framework-cli create-app <directory> [options]",
+    options: [
+      ["--template <name>", "Choose a starter template"],
+      ["--tailwind", "Use the Tailwind CSS starter"],
+      ["--no-tailwind", "Keep the plain CSS starter"],
+      ["--frontend-dir <path>", "Use a custom relative frontend directory"],
+      ["--flat", "Place the frontend directly in the project root"],
+      ["--product-name <name>", "Override the generated product name"],
+      ["--app-id <id>", "Override the generated app identifier"],
+      ["--package-manager <name>", "Choose npm, pnpm, yarn, or bun for dependency install"],
+      ["--no-install", "Skip installing frontend dependencies after scaffolding"],
+      ["--force", "Allow scaffolding into an existing directory"],
+      ["--yes", "Skip the interactive questionnaire and use defaults"],
+      ["--no-prompt", "Disable prompts even in an interactive terminal"],
+      ["--dry-run", "Preview the scaffold plan without writing files"]
+    ],
+    examples: [
+      "reset-framework-cli create-app my-app",
+      "reset-framework-cli create-app my-app --tailwind",
+      "reset-framework-cli create-app my-app --flat --yes"
+    ],
+    run: runCreateApp
+  },
   dev: {
     description: devDescription,
     usage: "reset-framework-cli dev [--skip-frontend] [--skip-runtime] [--no-open] [--runtime-source] [--dry-run]",
@@ -67,150 +67,150 @@ const commands = {
       ["--runtime-source", "Build the runtime from @reset-framework/native instead of using a bundled runtime package"],
       ["--dry-run", "Print the dev plan without starting processes"]
     ],
-    examples: [
-      "reset-framework-cli dev",
-      "reset-framework-cli dev --skip-runtime"
-    ],
-    run: runDev
-  },
-  doctor: {
-    description: doctorDescription,
-    usage: "reset-framework-cli doctor",
-    options: [],
-    examples: ["reset-framework-cli doctor"],
-    run: runDoctor
-  },
-  init: {
-    description: `${initDescription} (alias for create-app)`,
-    usage: "reset-framework-cli init <directory> [options]",
-    options: [
-      ["--template <name>", "Choose a starter template"],
-      ["--tailwind", "Use the Tailwind CSS starter"],
-      ["--no-tailwind", "Keep the plain CSS starter"],
-      ["--frontend-dir <path>", "Use a custom relative frontend directory"],
-      ["--flat", "Place the frontend directly in the project root"],
-      ["--product-name <name>", "Override the generated product name"],
-      ["--app-id <id>", "Override the generated app identifier"],
-      ["--package-manager <name>", "Choose npm, pnpm, yarn, or bun for dependency install"],
-      ["--no-install", "Skip installing frontend dependencies after scaffolding"],
-      ["--force", "Allow scaffolding into an existing directory"],
-      ["--yes", "Skip the interactive questionnaire and use defaults"],
-      ["--no-prompt", "Disable prompts even in an interactive terminal"],
-      ["--dry-run", "Preview the scaffold plan without writing files"]
-    ],
-    examples: ["reset-framework-cli init my-app"],
-    run: runInit
-  },
-  package: {
-    description: packageDescription,
-    usage: "reset-framework-cli package [--dry-run]",
-    options: [
-      ["--dry-run", "Preview the archive step without writing the package file"]
-    ],
-    examples: [
-      "reset-framework-cli package"
-    ],
-    run: runPackage
-  }
-}
-
-const coreWorkflow = [
-  "reset-framework-cli create-app my-app",
-  "cd my-app",
-  "reset-framework-cli dev",
-  "reset-framework-cli build",
-  "reset-framework-cli package"
-]
-
-function getVisibleCommands() {
-  return ["create-app", "dev", "build", "package", "doctor"].map((name) => ({
-    name,
-    description: commands[name].description
-  }))
-}
-
-function printGeneralHelp() {
-  printBanner("reset-framework-cli", "Developer-facing orchestration for Reset Framework desktop apps.")
-
-  printSection("Usage")
-  console.log("  reset-framework-cli <command> [options]")
-  console.log("")
-
-  printSection("Core workflow")
-  for (const step of coreWorkflow) {
-    console.log(`  ${step}`)
-  }
-  console.log("")
-
-  printSection("Commands")
-  printCommandList(getVisibleCommands())
-  console.log("")
-  console.log("  reset-framework-cli help <command>  Show command-specific help")
-  console.log("")
-  printSection("Global shortcuts")
-  printKeyValueTable([
-    ["-h, --help", "Show help for the current command"],
-    ["-y, --yes", "Accept defaults in create-app without prompts"]
-  ])
-}
-
-function printCommandHelp(name) {
-  const command = commands[name]
-
-  if (!command) {
-    logger.error(`Unknown command: ${name}`)
-    printGeneralHelp()
-    process.exit(1)
-  }
-
-  printBanner(`reset-framework-cli ${name}`, command.description)
-
-  printSection("Usage")
-  console.log(`  ${command.usage}`)
-
-  if (command.options.length > 0) {
-    console.log("")
-    printSection("Options")
-    printKeyValueTable(command.options)
-  }
-
-  if (command.examples.length > 0) {
-    console.log("")
-    printSection("Examples")
-    for (const example of command.examples) {
-      console.log(`  ${example}`)
-    }
-  }
-}
-
-const context = createCommandContext(process.argv.slice(2))
-
-if (context.command === "help") {
-  if (context.args[0]) {
-    printCommandHelp(context.args[0])
-  } else {
-    printGeneralHelp()
-  }
-  process.exit(0)
-}
-
-if (context.flags.help) {
-  printCommandHelp(context.command)
-  process.exit(0)
-}
-
-const command = commands[context.command]
-
-if (!command) {
-  logger.error(`Unknown command: ${context.command}`)
-  printGeneralHelp()
-  process.exit(1)
-}
-
-try {
-  await command.run(context)
-} catch (error) {
-  const message = error instanceof Error ? error.message : String(error)
-  logger.error(message)
-  process.exit(1)
-}
+    examples: [
+      "reset-framework-cli dev",
+      "reset-framework-cli dev --skip-runtime"
+    ],
+    run: runDev
+  },
+  doctor: {
+    description: doctorDescription,
+    usage: "reset-framework-cli doctor",
+    options: [],
+    examples: ["reset-framework-cli doctor"],
+    run: runDoctor
+  },
+  init: {
+    description: `${initDescription} (alias for create-app)`,
+    usage: "reset-framework-cli init <directory> [options]",
+    options: [
+      ["--template <name>", "Choose a starter template"],
+      ["--tailwind", "Use the Tailwind CSS starter"],
+      ["--no-tailwind", "Keep the plain CSS starter"],
+      ["--frontend-dir <path>", "Use a custom relative frontend directory"],
+      ["--flat", "Place the frontend directly in the project root"],
+      ["--product-name <name>", "Override the generated product name"],
+      ["--app-id <id>", "Override the generated app identifier"],
+      ["--package-manager <name>", "Choose npm, pnpm, yarn, or bun for dependency install"],
+      ["--no-install", "Skip installing frontend dependencies after scaffolding"],
+      ["--force", "Allow scaffolding into an existing directory"],
+      ["--yes", "Skip the interactive questionnaire and use defaults"],
+      ["--no-prompt", "Disable prompts even in an interactive terminal"],
+      ["--dry-run", "Preview the scaffold plan without writing files"]
+    ],
+    examples: ["reset-framework-cli init my-app"],
+    run: runInit
+  },
+  package: {
+    description: packageDescription,
+    usage: "reset-framework-cli package [--dry-run]",
+    options: [
+      ["--dry-run", "Preview the archive step without writing the package file"]
+    ],
+    examples: [
+      "reset-framework-cli package"
+    ],
+    run: runPackage
+  }
+}
+
+const coreWorkflow = [
+  "reset-framework-cli create-app my-app",
+  "cd my-app",
+  "reset-framework-cli dev",
+  "reset-framework-cli build",
+  "reset-framework-cli package"
+]
+
+function getVisibleCommands() {
+  return ["create-app", "dev", "build", "package", "doctor"].map((name) => ({
+    name,
+    description: commands[name].description
+  }))
+}
+
+function printGeneralHelp() {
+  printBanner("reset-framework-cli", "Developer-facing orchestration for Reset Framework desktop apps.")
+
+  printSection("Usage")
+  console.log("  reset-framework-cli <command> [options]")
+  console.log("")
+
+  printSection("Core workflow")
+  for (const step of coreWorkflow) {
+    console.log(`  ${step}`)
+  }
+  console.log("")
+
+  printSection("Commands")
+  printCommandList(getVisibleCommands())
+  console.log("")
+  console.log("  reset-framework-cli help <command>  Show command-specific help")
+  console.log("")
+  printSection("Global shortcuts")
+  printKeyValueTable([
+    ["-h, --help", "Show help for the current command"],
+    ["-y, --yes", "Accept defaults in create-app without prompts"]
+  ])
+}
+
+function printCommandHelp(name) {
+  const command = commands[name]
+
+  if (!command) {
+    logger.error(`Unknown command: ${name}`)
+    printGeneralHelp()
+    process.exit(1)
+  }
+
+  printBanner(`reset-framework-cli ${name}`, command.description)
+
+  printSection("Usage")
+  console.log(`  ${command.usage}`)
+
+  if (command.options.length > 0) {
+    console.log("")
+    printSection("Options")
+    printKeyValueTable(command.options)
+  }
+
+  if (command.examples.length > 0) {
+    console.log("")
+    printSection("Examples")
+    for (const example of command.examples) {
+      console.log(`  ${example}`)
+    }
+  }
+}
+
+const context = createCommandContext(process.argv.slice(2))
+
+if (context.command === "help") {
+  if (context.args[0]) {
+    printCommandHelp(context.args[0])
+  } else {
+    printGeneralHelp()
+  }
+  process.exit(0)
+}
+
+if (context.flags.help) {
+  printCommandHelp(context.command)
+  process.exit(0)
+}
+
+const command = commands[context.command]
+
+if (!command) {
+  logger.error(`Unknown command: ${context.command}`)
+  printGeneralHelp()
+  process.exit(1)
+}
+
+try {
+  await command.run(context)
+} catch (error) {
+  const message = error instanceof Error ? error.message : String(error)
+  logger.error(message)
+  process.exit(1)
+}

package/src/lib/backend.js

@@ -0,0 +1,123 @@
+import path from "node:path"
+import { chmod, copyFile, mkdir, realpath } from "node:fs/promises"
+import { existsSync } from "node:fs"
+
+import { build as buildWithEsbuild } from "esbuild"
+
+import { logger } from "./logger.js"
+import { resolveOptionalBackendEntry } from "./project.js"
+
+function isRuntimeExecutableName(name) {
+  const normalized = name.toLowerCase()
+  return normalized === "node" || normalized === "node.exe" || normalized === "bun" || normalized === "bun.exe"
+}
+
+function uniqueNonEmpty(items) {
+  return [...new Set(items.filter(Boolean))]
+}
+
+function resolvePathExecutable(commandName) {
+  const pathValue = process.env.PATH ?? ""
+  const searchDirectories = pathValue.split(path.delimiter).filter(Boolean)
+  const extensions =
+    process.platform === "win32"
+      ? uniqueNonEmpty(["", ...(process.env.PATHEXT?.split(";") ?? [".EXE", ".CMD", ".BAT", ".COM"])])
+      : [""]
+
+  for (const directory of searchDirectories) {
+    for (const extension of extensions) {
+      const candidate = path.join(directory, `${commandName}${extension}`)
+      if (existsSync(candidate)) {
+        return candidate
+      }
+    }
+  }
+
+  return null
+}
+
+function resolveSidecarRuntimeBinary() {
+  const candidates = uniqueNonEmpty([
+    process.execPath,
+    resolvePathExecutable("node"),
+    resolvePathExecutable("bun")
+  ])
+
+  for (const candidate of candidates) {
+    if (!candidate || !existsSync(candidate)) {
+      continue
+    }
+
+    if (isRuntimeExecutableName(path.basename(candidate))) {
+      return candidate
+    }
+  }
+
+  return null
+}
+
+function resolveBackendBuildDir(appPaths, mode) {
+  return path.join(appPaths.appRoot, ".reset", "backend", mode)
+}
+
+export async function prepareAppBackend(frameworkPaths, appPaths, mode) {
+  const entryPath = resolveOptionalBackendEntry(appPaths)
+  if (!entryPath) {
+    return null
+  }
+
+  const runtimeExecutablePath = resolveSidecarRuntimeBinary()
+  if (!runtimeExecutablePath) {
+    throw new Error(
+      "Could not resolve a JavaScript runtime for the Reset backend sidecar. Install Node.js or Bun."
+    )
+  }
+
+  const outputDir = resolveBackendBuildDir(appPaths, mode)
+  const bundleEntryPath = path.join(outputDir, "app.mjs")
+  const runnerPath = path.join(frameworkPaths.backendPackage.packageRoot, "src", "runner.js")
+  const supportModulePath = path.join(frameworkPaths.backendPackage.packageRoot, "src", "index.js")
+
+  await mkdir(outputDir, { recursive: true })
+  await buildWithEsbuild({
+    absWorkingDir: appPaths.appRoot,
+    entryPoints: [entryPath],
+    outfile: bundleEntryPath,
+    bundle: true,
+    platform: "node",
+    format: "esm",
+    target: "node20",
+    sourcemap: mode === "dev" ? "inline" : false,
+    logLevel: "silent"
+  })
+
+  return {
+    entryPath,
+    bundleEntryPath,
+    runnerPath,
+    supportModulePath,
+    runtimeExecutablePath,
+    runtimeName: path.basename(runtimeExecutablePath),
+    workingDirectory: appPaths.appRoot
+  }
+}
+
+export async function stageAppBackend(backendArtifact, outputPaths) {
+  if (!backendArtifact) {
+    return
+  }
+
+  logger.info(`Staging backend sidecar into ${outputPaths.bundledBackendDir}`)
+
+  const resolvedRuntimePath = await realpath(backendArtifact.runtimeExecutablePath)
+
+  await mkdir(outputPaths.bundledBackendDir, { recursive: true })
+  await copyFile(backendArtifact.bundleEntryPath, outputPaths.bundledBackendEntryPath)
+  await copyFile(backendArtifact.runnerPath, outputPaths.bundledBackendRunnerPath)
+  await copyFile(backendArtifact.supportModulePath, outputPaths.bundledBackendSupportModulePath)
+  await copyFile(resolvedRuntimePath, outputPaths.bundledBackendRuntimePath)
+
+  if (process.platform !== "win32") {
+    await chmod(outputPaths.bundledBackendRuntimePath, 0o755)
+  }
+}