reset-framework-cli 1.1.4 → 1.2.0

package/README.md

@@ -16,32 +16,42 @@ npm install -g reset-framework-cli
 - `reset-framework-cli package`
 - `reset-framework-cli doctor`
 
-## Package boundary
-
-- `reset-framework-cli` orchestrates the framework.
-- `@reset-framework/native` provides the CMake-based runtime source package.
-- `@reset-framework/sdk` provides the frontend bridge package.
-- `@reset-framework/schema` provides the config schema package.
-
-## How it works
-
-- `reset-framework-cli dev` and `reset-framework-cli build` compile the native runtime into an app-local cache under `.reset/framework`.
-- The generated desktop app is assembled under `.reset/build`.
-- On first native build, the CLI will reuse an existing vcpkg toolchain when available, or bootstrap one into `~/.reset-framework-cli/vcpkg`.
-- The CLI remains thin. Native platform logic lives in the native package, not in command code.
-
-## Requirements
-
-- Node.js `>= 20.19.0`
-- CMake
-- Ninja
-- Git
-- A native compiler toolchain for the target platform
-
-## Publish model
-
-`reset-framework-cli` should be published only after:
-
-1. `@reset-framework/schema`
-2. `@reset-framework/sdk`
-3. `@reset-framework/native`
+## Package boundary
+
+- `reset-framework-cli` orchestrates the framework.
+- `@reset-framework/runtime-*` provides the bundled runtime package for the current platform.
+- `@reset-framework/native` provides the CMake-based runtime source package.
+- `@reset-framework/sdk` provides the frontend bridge package.
+- `@reset-framework/schema` provides the config schema package.
+
+## How it works
+
+- `reset-framework-cli dev` and `reset-framework-cli build` use the bundled runtime package for the current platform by default.
+- `reset-framework-cli dev --runtime-source` and `reset-framework-cli build --runtime-source` compile the runtime from `@reset-framework/native` into an app-local cache under `.reset/framework`.
+- The generated desktop app is assembled under `.reset/build`.
+- On first source build, the CLI will reuse an existing vcpkg toolchain when available, or bootstrap one into `~/.reset-framework-cli/vcpkg`.
+- The CLI remains thin. Native platform logic lives in the native package, not in command code.
+
+## Requirements
+
+- Node.js `>= 20.19.0`
+- A bundled runtime package for the target platform
+
+Source build requirements:
+
+- `@reset-framework/native`
+- CMake
+- Ninja
+- Git
+- A native compiler toolchain for the target platform
+
+## Publish model
+
+`reset-framework-cli` should be published only after:
+
+1. `@reset-framework/schema`
+2. `@reset-framework/sdk`
+3. `@reset-framework/runtime-darwin-arm64`
+4. `@reset-framework/runtime-darwin-x64`
+5. `@reset-framework/runtime-win32-x64`
+6. `@reset-framework/native`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reset-framework-cli",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "type": "module",
   "description": "Command-line tooling for Reset Framework.",
   "license": "MIT",
@@ -11,9 +11,13 @@
     "node": ">=20.19.0"
   },
   "dependencies": {
-    "@reset-framework/native": "1.1.4",
-    "@reset-framework/schema": "1.1.4",
-    "@reset-framework/sdk": "1.1.4"
+    "@reset-framework/schema": "1.2.0",
+    "@reset-framework/sdk": "1.2.0"
+  },
+  "optionalDependencies": {
+    "@reset-framework/runtime-darwin-arm64": "1.2.0",
+    "@reset-framework/runtime-darwin-x64": "1.2.0",
+    "@reset-framework/runtime-win32-x64": "1.2.0"
   },
   "bin": {
     "reset-framework-cli": "src/index.js"

package/src/commands/build.js

@@ -1,5 +1,5 @@
-import { buildFrameworkRuntime } from "../lib/framework.js"
-import { stageMacOSAppBundle, stageWindowsAppBundle } from "../lib/output.js"
+import { prepareFrameworkRuntime } from "../lib/framework.js"
+import { stageMacOSAppBundle, stageWindowsAppBundle } from "../lib/output.js"
 import { resolvePackageManagerCommand, runCommand } from "../lib/process.js"
 import {
   assertAppProject,
@@ -8,11 +8,12 @@ import {
   resolveAppOutputPaths,
   resolveAppPaths,
   resolveAppPackageManager,
-  resolveConfigPath,
-  resolveFrontendDir,
-  resolveFrameworkBuildPaths,
-  resolveFrameworkPaths
-} from "../lib/project.js"
+  resolveConfigPath,
+  resolveFrontendDir,
+  resolveFrameworkBuildPaths,
+  resolveFrameworkRuntimeStrategy,
+  resolveFrameworkPaths
+} from "../lib/project.js"
 import {
   createProgress,
   printBanner,
@@ -24,10 +25,11 @@ import {
 export const description = "Build the frontend, runtime, and final desktop app bundle"
 
 export async function run(context) {
-  const dryRun = Boolean(context.flags["dry-run"])
-  const skipFrontend = Boolean(context.flags["skip-frontend"])
-  const skipRuntime = Boolean(context.flags["skip-runtime"])
-  const skipStage = Boolean(context.flags["skip-stage"])
+  const dryRun = Boolean(context.flags["dry-run"])
+  const skipFrontend = Boolean(context.flags["skip-frontend"])
+  const skipRuntime = Boolean(context.flags["skip-runtime"])
+  const skipStage = Boolean(context.flags["skip-stage"])
+  const preferSource = Boolean(context.flags["runtime-source"])
 
   const appPaths = resolveAppPaths(context.projectRoot)
   const frameworkPaths = resolveFrameworkPaths()
@@ -36,32 +38,40 @@ export async function run(context) {
   const config = loadResetConfig(appPaths)
   assertAppProject(appPaths, config)
   const packageManager = resolveAppPackageManager(appPaths, config)
-  const outputPaths = resolveAppOutputPaths(appPaths, config)
-  const configPath = resolveConfigPath(appPaths)
-  const frontendDir = resolveFrontendDir(appPaths, config)
-  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
-  const steps = [
-    !skipFrontend ? "Build frontend" : null,
-    !skipRuntime ? "Build runtime" : null,
-    !skipStage ? "Stage desktop bundle" : null
-  ].filter(Boolean)
+  const outputPaths = resolveAppOutputPaths(appPaths, config)
+  const configPath = resolveConfigPath(appPaths)
+  const frontendDir = resolveFrontendDir(appPaths, config)
+  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
+  const runtimeStrategy = resolveFrameworkRuntimeStrategy(frameworkPaths, { preferSource })
+  const steps = [
+    !skipFrontend ? "Build frontend" : null,
+    !skipRuntime ? "Prepare runtime" : null,
+    !skipStage ? "Stage desktop bundle" : null
+  ].filter(Boolean)
 
   printBanner("reset-framework-cli build", description)
   printSection("Project")
-  printKeyValueTable([
-    ["Config", configPath],
-    ["Frontend", frontendDir],
-    ["Package manager", packageManager],
-    ["Output", outputPaths.appBundlePath]
-  ])
+  printKeyValueTable([
+    ["Config", configPath],
+    ["Frontend", frontendDir],
+    ["Package manager", packageManager],
+    ["Output", outputPaths.appBundlePath],
+    ["Runtime", `${runtimeStrategy.kind === "prebuilt" ? "bundled" : "source"} (${runtimeStrategy.label})`]
+  ])
   console.log("")
 
-  printSection("Plan")
-  printStatusTable([
-    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Skipping frontend build" : "Build static frontend assets"],
-    [skipRuntime ? "skip" : "ready", "Runtime", skipRuntime ? "Skipping release runtime build" : "Configure and build the native runtime"],
-    [skipStage ? "skip" : "ready", "Bundle", skipStage ? "Skipping app bundle staging" : "Assemble the final desktop app bundle"]
-  ])
+  printSection("Plan")
+  printStatusTable([
+    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Skipping frontend build" : "Build static frontend assets"],
+    [
+      skipRuntime ? "skip" : "ready",
+      "Runtime",
+      skipRuntime
+        ? (runtimeStrategy.kind === "prebuilt" ? "Reuse the bundled runtime package" : "Skip the source runtime build")
+        : (runtimeStrategy.kind === "prebuilt" ? "Use the bundled runtime package" : "Configure and build the runtime from source")
+    ],
+    [skipStage ? "skip" : "ready", "Bundle", skipStage ? "Skipping app bundle staging" : "Assemble the final desktop app bundle"]
+  ])
 
   if (dryRun) {
     console.log("")
@@ -92,23 +102,25 @@ export async function run(context) {
     progress.tick("Frontend assets built")
   }
 
-  if (!skipRuntime) {
-    await buildFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "release", {
-      cwd: appPaths.appRoot,
-      dryRun
-    })
-    progress.tick("Native runtime built")
-  }
-
+  if (!skipRuntime) {
+    const preparedRuntime = await prepareFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "release", {
+      cwd: appPaths.appRoot,
+      dryRun,
+      preferSource
+    })
+    progress.tick(preparedRuntime.kind === "prebuilt" ? "Bundled runtime ready" : "Native runtime built")
+  }
+
   if (!skipStage) {
     const stageBundle = process.platform === "win32" ? stageWindowsAppBundle : stageMacOSAppBundle
-    await stageBundle(frameworkBuildPaths, appPaths, config, {
+    await stageBundle(frameworkPaths, frameworkBuildPaths, config, {
       dryRun,
       outputPaths,
-      configPath
+      configPath,
+      preferSource
     })
-    progress.tick("Desktop app bundle staged")
-  }
+    progress.tick("Desktop app bundle staged")
+  }
 
   console.log("")
   printSection("Result")

package/src/commands/dev.js

@@ -1,4 +1,4 @@
-import { buildFrameworkRuntime } from "../lib/framework.js"
+import { prepareFrameworkRuntime } from "../lib/framework.js"
 import {
   registerChildCleanup,
   resolvePackageManagerCommand,
@@ -17,6 +17,7 @@ import {
   resolveFrontendDir,
   resolveFrameworkBuildPaths,
   resolveFrameworkRuntimeBinary,
+  resolveFrameworkRuntimeStrategy,
   resolveFrameworkPaths
 } from "../lib/project.js"
 import {
@@ -30,10 +31,11 @@ import {
 export const description = "Run the frontend dev server and native host"
 
 export async function run(context) {
-  const dryRun = Boolean(context.flags["dry-run"])
-  const skipFrontend = Boolean(context.flags["skip-frontend"])
-  const skipRuntime = Boolean(context.flags["skip-runtime"])
-  const noOpen = Boolean(context.flags["no-open"])
+  const dryRun = Boolean(context.flags["dry-run"])
+  const skipFrontend = Boolean(context.flags["skip-frontend"])
+  const skipRuntime = Boolean(context.flags["skip-runtime"])
+  const noOpen = Boolean(context.flags["no-open"])
+  const preferSource = Boolean(context.flags["runtime-source"])
 
   const appPaths = resolveAppPaths(context.projectRoot)
   const frameworkPaths = resolveFrameworkPaths()
@@ -43,31 +45,39 @@ export async function run(context) {
   assertAppProject(appPaths, config)
   const packageManager = resolveAppPackageManager(appPaths, config)
   const devServer = resolveDevServerOptions(config)
-  const configPath = resolveConfigPath(appPaths)
-  const frontendDir = resolveFrontendDir(appPaths, config)
-  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
-  const steps = [
-    !skipRuntime ? "Build native runtime" : null,
-    !skipFrontend ? "Start frontend dev server" : null,
-    !noOpen ? "Launch desktop window" : null
-  ].filter(Boolean)
+  const configPath = resolveConfigPath(appPaths)
+  const frontendDir = resolveFrontendDir(appPaths, config)
+  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
+  const runtimeStrategy = resolveFrameworkRuntimeStrategy(frameworkPaths, { preferSource })
+  const steps = [
+    !skipRuntime ? "Prepare runtime" : null,
+    !skipFrontend ? "Start frontend dev server" : null,
+    !noOpen ? "Launch desktop window" : null
+  ].filter(Boolean)
 
   printBanner("reset-framework-cli dev", description)
   printSection("Project")
-  printKeyValueTable([
-    ["Config", configPath],
-    ["Frontend", frontendDir],
-    ["Package manager", packageManager],
-    ["Dev URL", config.frontend.devUrl]
-  ])
+  printKeyValueTable([
+    ["Config", configPath],
+    ["Frontend", frontendDir],
+    ["Package manager", packageManager],
+    ["Dev URL", config.frontend.devUrl],
+    ["Runtime", `${runtimeStrategy.kind === "prebuilt" ? "bundled" : "source"} (${runtimeStrategy.label})`]
+  ])
   console.log("")
 
-  printSection("Plan")
-  printStatusTable([
-    [skipRuntime ? "skip" : "ready", "Runtime", skipRuntime ? "Reusing existing native dev build" : "Configure and build the native runtime"],
-    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Expecting an already running dev server" : "Start the frontend dev server and wait for readiness"],
-    [noOpen ? "skip" : "ready", "Window", noOpen ? "Do not launch the desktop window" : "Start the native host with the active project config"]
-  ])
+  printSection("Plan")
+  printStatusTable([
+    [
+      skipRuntime ? "skip" : "ready",
+      "Runtime",
+      skipRuntime
+        ? (runtimeStrategy.kind === "prebuilt" ? "Reuse the bundled runtime package" : "Reuse the existing source runtime build")
+        : (runtimeStrategy.kind === "prebuilt" ? "Use the bundled runtime package" : "Configure and build the runtime from source")
+    ],
+    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Expecting an already running dev server" : "Start the frontend dev server and wait for readiness"],
+    [noOpen ? "skip" : "ready", "Window", noOpen ? "Do not launch the desktop window" : "Start the native host with the active project config"]
+  ])
 
   if (dryRun) {
     console.log("")
@@ -88,15 +98,16 @@ export async function run(context) {
   }
 
   console.log("")
-  const progress = createProgress(steps.length, "Dev")
-
-  if (!skipRuntime) {
-    await buildFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "dev", {
-      cwd: appPaths.appRoot,
-      dryRun
-    })
-    progress.tick("Native runtime built")
-  }
+  const progress = createProgress(steps.length, "Dev")
+
+  if (!skipRuntime) {
+    const preparedRuntime = await prepareFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "dev", {
+      cwd: appPaths.appRoot,
+      dryRun,
+      preferSource
+    })
+    progress.tick(preparedRuntime.kind === "prebuilt" ? "Bundled runtime ready" : "Native runtime built")
+  }
 
   const children = []
 
@@ -123,13 +134,14 @@ export async function run(context) {
   }
 
   if (!noOpen) {
-    const appBinary = resolveFrameworkRuntimeBinary(frameworkBuildPaths, "dev", {
-      mustExist: !dryRun
+    const appBinary = resolveFrameworkRuntimeBinary(frameworkPaths, frameworkBuildPaths, "dev", {
+      mustExist: !dryRun,
+      strategy: runtimeStrategy
     })
     const appProcess = spawnCommand(appBinary, [], {
-      cwd: appPaths.appRoot,
-      env: {
-        RESET_CONFIG_PATH: configPath,
+      cwd: appPaths.appRoot,
+      env: {
+        RESET_CONFIG_PATH: configPath,
         RESET_FRONTEND_DEV_URL: config.frontend.devUrl
       },
       dryRun
@@ -162,6 +174,6 @@ export async function run(context) {
       )
     ])
   } finally {
-    cleanup()
+    await cleanup()
   }
 }

package/src/commands/doctor.js

@@ -1,11 +1,14 @@
 import { existsSync } from "node:fs"
 
-import {
-  getAppChecks,
-  getFrameworkChecks,
-  loadResetConfig,
-  resolveFrontendDir,
-  resolveAppPaths,
+import {
+  getAppChecks,
+  getFrameworkChecks,
+  getFrameworkRuntimeChecks,
+  getFrameworkRuntimeModeSummary,
+  hasFrameworkSourcePackage,
+  loadResetConfig,
+  resolveFrontendDir,
+  resolveAppPaths,
   resolveConfigPath,
   resolveFrameworkPaths
 } from "../lib/project.js"
@@ -19,15 +22,23 @@ import {
 
 export const description = "Inspect the current project layout"
 
-export async function run(context) {
-  const appPaths = resolveAppPaths(context.projectRoot)
-  const frameworkPaths = resolveFrameworkPaths()
-
-  let config = null
-
-  if (existsSync(resolveConfigPath(appPaths))) {
-    config = loadResetConfig(appPaths)
-  }
+export async function run(context) {
+  const appPaths = resolveAppPaths(context.projectRoot)
+  const frameworkPaths = resolveFrameworkPaths()
+  let runtimeMode = null
+  let runtimeModeError = null
+
+  let config = null
+
+  if (existsSync(resolveConfigPath(appPaths))) {
+    config = loadResetConfig(appPaths)
+  }
+
+  try {
+    runtimeMode = getFrameworkRuntimeModeSummary(frameworkPaths)
+  } catch (error) {
+    runtimeModeError = error instanceof Error ? error.message : String(error)
+  }
 
   printBanner("reset-framework-cli doctor", description)
 
@@ -49,31 +60,68 @@ export async function run(context) {
   console.log("")
   printSection("Framework installation")
 
-  printStatusTable(
-    getFrameworkChecks(frameworkPaths).map(([label, filePath]) => [
-      existsSync(filePath) ? "ok" : "missing",
+  printStatusTable(
+    getFrameworkChecks(frameworkPaths).map(([label, filePath]) => [
+      existsSync(filePath) ? "ok" : "missing",
       label,
       filePath
     ])
   )
 
-  console.log("")
-  printSection("Framework packages")
-  printKeyValueTable([
-    ["Native", `${frameworkPaths.frameworkPackage.packageName}@${frameworkPaths.frameworkPackage.version}`],
-    ["SDK", `${frameworkPaths.sdkPackage.packageName}@${frameworkPaths.sdkPackage.version}`],
-    ["Schema", `${frameworkPaths.schemaPackage.packageName}@${frameworkPaths.schemaPackage.version}`]
-  ])
-
-  console.log("")
-  printSection("Native toolchain")
-  const vcpkgToolchainFile = findVcpkgToolchainFile()
-  printStatusTable([
-    [vcpkgToolchainFile ? "ok" : "warn", "Framework source", frameworkPaths.frameworkRoot],
-    [vcpkgToolchainFile ? "ok" : "warn", "vcpkg toolchain", vcpkgToolchainFile ?? "Will be bootstrapped on first native build"]
-  ])
-
-  if (config) {
+  console.log("")
+  printSection("Runtime installation")
+
+  const runtimeChecks = getFrameworkRuntimeChecks(frameworkPaths)
+  printStatusTable(
+    runtimeChecks.length > 0
+      ? runtimeChecks.map(([label, filePath]) => [
+          existsSync(filePath) ? "ok" : "missing",
+          label,
+          filePath
+        ])
+      : [["warn", "runtime", `No packaged runtime registered for ${process.platform}-${process.arch}`]]
+  )
+
+  console.log("")
+  printSection("Framework packages")
+  printKeyValueTable([
+    [
+      "Runtime",
+      frameworkPaths.runtimePackage?.packageInfo
+        ? `${frameworkPaths.runtimePackage.packageInfo.packageName}@${frameworkPaths.runtimePackage.packageInfo.version}`
+        : `Not installed for ${process.platform}-${process.arch}`
+    ],
+    [
+      "Native source",
+      frameworkPaths.frameworkPackage
+        ? `${frameworkPaths.frameworkPackage.packageName}@${frameworkPaths.frameworkPackage.version}`
+        : "Not installed"
+    ],
+    ["SDK", `${frameworkPaths.sdkPackage.packageName}@${frameworkPaths.sdkPackage.version}`],
+    ["Schema", `${frameworkPaths.schemaPackage.packageName}@${frameworkPaths.schemaPackage.version}`]
+  ])
+
+  console.log("")
+  printSection("Runtime mode")
+  printStatusTable([
+    [
+      runtimeMode ? "ok" : "warn",
+      "Runtime mode",
+      runtimeMode ? `${runtimeMode.kind} (${runtimeMode.label})` : runtimeModeError
+    ]
+  ])
+
+  if (hasFrameworkSourcePackage(frameworkPaths)) {
+    console.log("")
+    printSection("Native toolchain")
+    const vcpkgToolchainFile = findVcpkgToolchainFile()
+    printStatusTable([
+      ["ok", "Framework source", frameworkPaths.frameworkRoot],
+      [vcpkgToolchainFile ? "ok" : "warn", "vcpkg toolchain", vcpkgToolchainFile ?? "Will be bootstrapped on first source build"]
+    ])
+  }
+
+  if (config) {
     console.log("")
     printSection("Config")
     printKeyValueTable([