reset-framework-cli 1.2.1 → 1.2.4

package/src/commands/dev.js

@@ -1,179 +1,200 @@
-import { prepareFrameworkRuntime } from "../lib/framework.js"
-import {
-  registerChildCleanup,
-  resolvePackageManagerCommand,
-  spawnCommand,
-  waitForProcessExit,
-  waitForUrl
-} from "../lib/process.js"
-import {
-  assertAppProject,
-  assertFrameworkInstall,
-  loadResetConfig,
-  resolveAppPaths,
-  resolveAppPackageManager,
-  resolveConfigPath,
-  resolveDevServerOptions,
-  resolveFrontendDir,
-  resolveFrameworkBuildPaths,
-  resolveFrameworkRuntimeBinary,
-  resolveFrameworkRuntimeStrategy,
-  resolveFrameworkPaths
-} from "../lib/project.js"
-import {
-  createProgress,
-  printBanner,
-  printKeyValueTable,
-  printSection,
-  printStatusTable
-} from "../lib/ui.js"
-
-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"])
+import { prepareFrameworkRuntime } from "../lib/framework.js"
+import { prepareAppBackend } from "../lib/backend.js"
+import {
+  registerChildCleanup,
+  resolvePackageManagerCommand,
+  spawnCommand,
+  waitForProcessExit,
+  waitForUrl
+} from "../lib/process.js"
+import {
+  assertAppProject,
+  assertFrameworkInstall,
+  loadResetConfig,
+  resolveAppPaths,
+  resolveAppPackageManager,
+  resolveConfigPath,
+  resolveDevServerOptions,
+  resolveFrontendDir,
+  resolveFrameworkBuildPaths,
+  resolveFrameworkRuntimeBinary,
+  resolveFrameworkRuntimeStrategy,
+  resolveFrameworkPaths,
+  resolveOptionalBackendEntry
+} from "../lib/project.js"
+import {
+  createProgress,
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+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 preferSource = Boolean(context.flags["runtime-source"])
 
   const appPaths = resolveAppPaths(context.projectRoot)
-  const frameworkPaths = resolveFrameworkPaths()
+  const frameworkPaths = resolveFrameworkPaths({ appRoot: context.projectRoot })
   assertAppProject(appPaths)
   assertFrameworkInstall(frameworkPaths)
-  const config = loadResetConfig(appPaths)
-  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 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],
-    ["Runtime", `${runtimeStrategy.kind === "prebuilt" ? "bundled" : "source"} (${runtimeStrategy.label})`]
-  ])
-  console.log("")
-
-  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("")
-    printSection("Dry run")
-    printStatusTable(
-      steps.length > 0
-        ? steps.map((step) => ["plan", step, "No processes will be started"])
-        : [["warn", "Nothing to do", "All dev phases were skipped"]]
-    )
-    return
-  }
-
-  if (steps.length === 0) {
-    console.log("")
-    printSection("Result")
-    printStatusTable([["warn", "Nothing to do", "All dev phases were skipped"]])
-    return
-  }
-
-  console.log("")
-  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 = []
-
-  if (!skipFrontend) {
-    const frontendProcess = spawnCommand(resolvePackageManagerCommand(packageManager), [
-      "run",
-      "dev",
-      "--",
-      "--host",
-      devServer.host,
-      "--port",
-      devServer.port,
-      "--strictPort"
-    ], {
-      cwd: frontendDir,
-      dryRun
-    })
-
-    if (frontendProcess) {
-      children.push(frontendProcess)
-      await waitForUrl(config.frontend.devUrl)
-      progress.tick("Frontend dev server is reachable")
-    }
-  }
-
-  if (!noOpen) {
-    const appBinary = resolveFrameworkRuntimeBinary(frameworkPaths, frameworkBuildPaths, "dev", {
-      mustExist: !dryRun,
-      strategy: runtimeStrategy
-    })
-    const appProcess = spawnCommand(appBinary, [], {
-      cwd: appPaths.appRoot,
-      env: {
-        RESET_CONFIG_PATH: configPath,
-        RESET_FRONTEND_DEV_URL: config.frontend.devUrl
-      },
-      dryRun
-    })
-
-    if (appProcess) {
-      children.push(appProcess)
-      progress.tick("Desktop window launched")
-    }
-  }
-
-  if (children.length === 0) {
-    return
-  }
-
-  console.log("")
-  printSection("Runtime")
-  printStatusTable([
-    ["done", "Frontend", config.frontend.devUrl],
-    ["done", "Config", configPath]
-  ])
-  console.log("  Press Ctrl+C to stop")
-
-  const cleanup = registerChildCleanup(children)
-
-  try {
-    await Promise.race([
-      ...children.map((child, index) =>
-        waitForProcessExit(child, index === 0 ? "dev process" : "native host")
-      )
-    ])
-  } finally {
-    await cleanup()
-  }
-}
+  const config = loadResetConfig(appPaths)
+  assertAppProject(appPaths, config)
+  const packageManager = resolveAppPackageManager(appPaths, config)
+  const devServer = resolveDevServerOptions(config)
+  const configPath = resolveConfigPath(appPaths)
+  const frontendDir = resolveFrontendDir(appPaths, config)
+  const backendEntry = resolveOptionalBackendEntry(appPaths)
+  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
+  const runtimeStrategy = resolveFrameworkRuntimeStrategy(frameworkPaths, { preferSource })
+  const steps = [
+    !skipRuntime ? "Prepare runtime" : null,
+    backendEntry ? "Bundle backend sidecar" : 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],
+    ["Backend", backendEntry ?? "not configured"],
+    ["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
+        ? (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")
+    ],
+    [backendEntry ? "ready" : "skip", "Backend", backendEntry ? "Bundle the optional TypeScript sidecar backend" : "No backend entry was found under backend/"],
+    [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("")
+    printSection("Dry run")
+    printStatusTable(
+      steps.length > 0
+        ? steps.map((step) => ["plan", step, "No processes will be started"])
+        : [["warn", "Nothing to do", "All dev phases were skipped"]]
+    )
+    return
+  }
+
+  if (steps.length === 0) {
+    console.log("")
+    printSection("Result")
+    printStatusTable([["warn", "Nothing to do", "All dev phases were skipped"]])
+    return
+  }
+
+  console.log("")
+  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 = []
+  let backendArtifact = null
+
+  if (backendEntry) {
+    backendArtifact = await prepareAppBackend(frameworkPaths, appPaths, "dev")
+    progress.tick("Backend sidecar bundled")
+  }
+
+  if (!skipFrontend) {
+    const frontendProcess = spawnCommand(resolvePackageManagerCommand(packageManager), [
+      "run",
+      "dev",
+      "--",
+      "--host",
+      devServer.host,
+      "--port",
+      devServer.port,
+      "--strictPort"
+    ], {
+      cwd: frontendDir,
+      dryRun
+    })
+
+    if (frontendProcess) {
+      children.push(frontendProcess)
+      await waitForUrl(config.frontend.devUrl)
+      progress.tick("Frontend dev server is reachable")
+    }
+  }
+
+  if (!noOpen) {
+    const appBinary = resolveFrameworkRuntimeBinary(frameworkPaths, frameworkBuildPaths, "dev", {
+      mustExist: !dryRun,
+      strategy: runtimeStrategy
+    })
+    const appProcess = spawnCommand(appBinary, [], {
+      cwd: appPaths.appRoot,
+      env: {
+        RESET_CONFIG_PATH: configPath,
+        RESET_FRONTEND_DEV_URL: config.frontend.devUrl,
+        ...(backendArtifact
+          ? {
+              RESET_BACKEND_EXECUTABLE: backendArtifact.runtimeExecutablePath,
+              RESET_BACKEND_RUNNER: backendArtifact.runnerPath,
+              RESET_BACKEND_ENTRY: backendArtifact.bundleEntryPath,
+              RESET_BACKEND_WORKING_DIRECTORY: backendArtifact.workingDirectory
+            }
+          : {})
+      },
+      dryRun
+    })
+
+    if (appProcess) {
+      children.push(appProcess)
+      progress.tick("Desktop window launched")
+    }
+  }
+
+  if (children.length === 0) {
+    return
+  }
+
+  console.log("")
+  printSection("Runtime")
+  printStatusTable([
+    ["done", "Frontend", config.frontend.devUrl],
+    ["done", "Config", configPath],
+    ["done", "Backend", backendArtifact ? backendArtifact.bundleEntryPath : "disabled"]
+  ])
+  console.log("  Press Ctrl+C to stop")
+
+  const cleanup = registerChildCleanup(children)
+
+  try {
+    await Promise.race([
+      ...children.map((child, index) =>
+        waitForProcessExit(child, index === 0 ? "dev process" : "native host")
+      )
+    ])
+  } finally {
+    await cleanup()
+  }
+}

package/src/commands/doctor.js

@@ -1,137 +1,144 @@
-import { existsSync } from "node:fs"
-
-import {
-  getAppChecks,
-  getFrameworkChecks,
-  getFrameworkRuntimeChecks,
-  getFrameworkRuntimeModeSummary,
-  hasFrameworkSourcePackage,
-  loadResetConfig,
-  resolveFrontendDir,
-  resolveAppPaths,
-  resolveConfigPath,
-  resolveFrameworkPaths
-} from "../lib/project.js"
-import { findVcpkgToolchainFile } from "../lib/toolchain.js"
-import {
-  printBanner,
-  printKeyValueTable,
-  printSection,
-  printStatusTable
-} from "../lib/ui.js"
-
-export const description = "Inspect the current project layout"
-
+import { existsSync } from "node:fs"
+
+import {
+  getAppChecks,
+  getFrameworkChecks,
+  getFrameworkRuntimeChecks,
+  getFrameworkRuntimeModeSummary,
+  hasFrameworkSourcePackage,
+  loadResetConfig,
+  resolveOptionalBackendEntry,
+  resolveFrontendDir,
+  resolveAppPaths,
+  resolveConfigPath,
+  resolveFrameworkPaths
+} from "../lib/project.js"
+import { findVcpkgToolchainFile } from "../lib/toolchain.js"
+import {
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+export const description = "Inspect the current project layout"
+
 export async function run(context) {
   const appPaths = resolveAppPaths(context.projectRoot)
-  const frameworkPaths = resolveFrameworkPaths()
+  const frameworkPaths = resolveFrameworkPaths({ appRoot: context.projectRoot })
   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)
-
-  printSection("App project")
-
-  const appChecks = [...getAppChecks(appPaths)]
-  if (config) {
-    appChecks.unshift(["frontend", resolveFrontendDir(appPaths, config)])
-  }
-
-  printStatusTable(
-    appChecks.map(([label, filePath]) => [
-      existsSync(filePath) ? "ok" : "missing",
-      label,
-      filePath
-    ])
-  )
-
-  console.log("")
-  printSection("Framework installation")
-
-  printStatusTable(
-    getFrameworkChecks(frameworkPaths).map(([label, filePath]) => [
-      existsSync(filePath) ? "ok" : "missing",
-      label,
-      filePath
-    ])
-  )
-
-  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([
-      ["Name", config.name],
-      ["Product", config.productName],
-      ["App ID", config.appId],
-      ["Frontend", config.project.frontendDir],
-      ["Styling", config.project.styling],
-      ["Dev URL", config.frontend.devUrl],
-      ["Output", config.build.outputDir]
-    ])
-  }
-}
+
+  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)
+
+  printSection("App project")
+
+  const appChecks = [...getAppChecks(appPaths)]
+  if (config) {
+    appChecks.unshift(["frontend", resolveFrontendDir(appPaths, config)])
+  }
+  const backendEntry = resolveOptionalBackendEntry(appPaths)
+  if (backendEntry) {
+    appChecks.splice(1, 0, ["backend", backendEntry])
+  }
+
+  printStatusTable(
+    appChecks.map(([label, filePath]) => [
+      existsSync(filePath) ? "ok" : "missing",
+      label,
+      filePath
+    ])
+  )
+
+  console.log("")
+  printSection("Framework installation")
+
+  printStatusTable(
+    getFrameworkChecks(frameworkPaths).map(([label, filePath]) => [
+      existsSync(filePath) ? "ok" : "missing",
+      label,
+      filePath
+    ])
+  )
+
+  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"
+    ],
+    ["Backend", `${frameworkPaths.backendPackage.packageName}@${frameworkPaths.backendPackage.version}`],
+    ["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([
+      ["Name", config.name],
+      ["Product", config.productName],
+      ["App ID", config.appId],
+      ["Frontend", config.project.frontendDir],
+      ["Backend", backendEntry ?? "disabled"],
+      ["Styling", config.project.styling],
+      ["Dev URL", config.frontend.devUrl],
+      ["Output", config.build.outputDir]
+    ])
+  }
+}