reset-framework-cli 1.1.2 → 1.1.4

package/src/lib/framework.js

@@ -1,54 +1,176 @@
-import { runCommand } from "./process.js"
+import { existsSync } from "node:fs"
+import { rm } from "node:fs/promises"
+import { readFile } from "node:fs/promises"
+import path from "node:path"
+
+import { captureCommandOutput, runCommand } from "./process.js"
 import { ensureVcpkgToolchain } from "./toolchain.js"
+
+function getBuildDirectory(frameworkBuildPaths, mode) {
+  return mode === "release"
+    ? frameworkBuildPaths.releaseBuildDir
+    : frameworkBuildPaths.devBuildDir
+}
+
+function getBuildType(mode) {
+  return mode === "release" ? "Release" : "Debug"
+}
 
-function getBuildDirectory(frameworkBuildPaths, mode) {
-  return mode === "release"
-    ? frameworkBuildPaths.releaseBuildDir
-    : frameworkBuildPaths.devBuildDir
+function getVsWherePath() {
+  const candidates = [
+    path.join(process.env["ProgramFiles(x86)"] ?? "", "Microsoft Visual Studio", "Installer", "vswhere.exe"),
+    path.join(process.env.ProgramFiles ?? "", "Microsoft Visual Studio", "Installer", "vswhere.exe")
+  ]
+
+  return candidates.find((candidate) => candidate && existsSync(candidate)) ?? null
 }
 
-function getBuildType(mode) {
-  return mode === "release" ? "Release" : "Debug"
+async function findVisualStudioGenerator() {
+  const vswherePath = getVsWherePath()
+  if (!vswherePath) {
+    return null
+  }
+
+  try {
+    const version = await captureCommandOutput(vswherePath, [
+      "-latest",
+      "-products",
+      "*",
+      "-requires",
+      "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
+      "-property",
+      "catalog_productLineVersion"
+    ])
+
+    const normalized = String(version).trim()
+    if (normalized === "2022") {
+      return "Visual Studio 17 2022"
+    }
+
+    if (normalized === "2019") {
+      return "Visual Studio 16 2019"
+    }
+  } catch {
+    // Fall through to the default Windows generator if detection fails.
+  }
+
+  return "Visual Studio 17 2022"
+}
+
+async function resolveCmakeGenerator() {
+  const envGenerator =
+    typeof process.env.CMAKE_GENERATOR === "string" && process.env.CMAKE_GENERATOR.trim() !== ""
+      ? process.env.CMAKE_GENERATOR.trim()
+      : null
+
+  if (envGenerator) {
+    return {
+      name: envGenerator,
+      configureArgs: process.platform === "win32" &&
+        !process.env.CMAKE_GENERATOR_PLATFORM &&
+        envGenerator.startsWith("Visual Studio ")
+        ? ["-G", envGenerator, "-A", "x64"]
+        : ["-G", envGenerator],
+      buildArgs: envGenerator.startsWith("Visual Studio ")
+        ? ["--config"]
+        : [],
+      multiConfig: envGenerator.startsWith("Visual Studio ")
+    }
+  }
+
+  if (process.platform === "win32") {
+    const generator = await findVisualStudioGenerator()
+    if (!generator) {
+      throw new Error(
+        "Could not find a supported Visual Studio C++ installation. Install Visual Studio Build Tools or set CMAKE_GENERATOR manually."
+      )
+    }
+
+    return {
+      name: generator,
+      configureArgs: ["-G", generator, "-A", "x64"],
+      buildArgs: ["--config"],
+      multiConfig: true
+    }
+  }
+
+  return {
+    name: "Ninja",
+    configureArgs: ["-G", "Ninja"],
+    buildArgs: [],
+    multiConfig: false
+  }
+}
+
+async function ensureMatchingCmakeSource(buildDir, frameworkRoot) {
+  const cachePath = path.join(buildDir, "CMakeCache.txt")
+  if (!existsSync(cachePath)) {
+    return
+  }
+
+  let cache
+  try {
+    cache = await readFile(cachePath, "utf8")
+  } catch {
+    return
+  }
+
+  const match = cache.match(/^CMAKE_HOME_DIRECTORY:INTERNAL=(.+)$/m)
+  if (!match) {
+    return
+  }
+
+  const cachedRoot = path.resolve(match[1].trim())
+  const currentRoot = path.resolve(frameworkRoot)
+
+  if (cachedRoot !== currentRoot) {
+    await rm(buildDir, { recursive: true, force: true })
+  }
 }
 
 export async function configureFrameworkBuild(frameworkPaths, frameworkBuildPaths, mode, options = {}) {
   const { dryRun = false, cwd } = options
   const toolchainFile = await ensureVcpkgToolchain({ dryRun })
   const buildDir = getBuildDirectory(frameworkBuildPaths, mode)
+  const generator = await resolveCmakeGenerator()
+  if (!dryRun) {
+    await ensureMatchingCmakeSource(buildDir, frameworkPaths.frameworkRoot)
+  }
+  const configureArgs = [
+    "-S",
+    frameworkPaths.frameworkRoot,
+    "-B",
+    buildDir,
+    ...generator.configureArgs,
+    `-DCMAKE_BUILD_TYPE=${getBuildType(mode)}`,
+    "-DCMAKE_CXX_STANDARD=20",
+    "-DCMAKE_CXX_STANDARD_REQUIRED=ON",
+    "-DCMAKE_CXX_EXTENSIONS=OFF",
+    "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
+    `-DCMAKE_TOOLCHAIN_FILE=${toolchainFile}`
+  ]
 
-  await runCommand(
-    "cmake",
-    [
-      "-S",
-      frameworkPaths.frameworkRoot,
-      "-B",
-      buildDir,
-      "-G",
-      "Ninja",
-      `-DCMAKE_BUILD_TYPE=${getBuildType(mode)}`,
-      "-DCMAKE_CXX_STANDARD=20",
-      "-DCMAKE_CXX_STANDARD_REQUIRED=ON",
-      "-DCMAKE_CXX_EXTENSIONS=OFF",
-      "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
-      `-DCMAKE_TOOLCHAIN_FILE=${toolchainFile}`
-    ],
-    {
+  try {
+    await runCommand("cmake", configureArgs, {
       cwd,
       dryRun
-    }
-  )
+    })
+  } catch (error) {
+    throw error
+  }
 }
-
+
 export async function buildFrameworkRuntime(frameworkPaths, frameworkBuildPaths, mode, options = {}) {
   const { dryRun = false, cwd } = options
   const buildDir = getBuildDirectory(frameworkBuildPaths, mode)
+  const generator = await resolveCmakeGenerator()
 
   await configureFrameworkBuild(frameworkPaths, frameworkBuildPaths, mode, {
     cwd,
     dryRun
   })
 
-  await runCommand("cmake", ["--build", buildDir], {
+  await runCommand("cmake", ["--build", buildDir, ...generator.buildArgs, ...(generator.multiConfig ? [getBuildType(mode)] : [])], {
     cwd,
     dryRun
   })

package/src/lib/logger.js

@@ -1,11 +1,11 @@
-export const logger = {
-  info(message) {
-    console.log(message)
-  },
-  warn(message) {
-    console.warn(message)
-  },
-  error(message) {
-    console.error(message)
-  }
-}
+export const logger = {
+  info(message) {
+    console.log(message)
+  },
+  warn(message) {
+    console.warn(message)
+  },
+  error(message) {
+    console.error(message)
+  }
+}

package/src/lib/output.js

@@ -1,110 +1,178 @@
 import path from "node:path"
-import { cp, mkdir, rm, writeFile } from "node:fs/promises"
+import { cp, mkdir, readdir, rm, writeFile } from "node:fs/promises"
 import { existsSync } from "node:fs"
 
 import { logger } from "./logger.js"
 import { runCommand } from "./process.js"
-
-function escapePlistString(value) {
-  return value
-    .replaceAll("&", "&")
-    .replaceAll("<", "&lt;")
-    .replaceAll(">", "&gt;")
+import {
+  resolveFrameworkRuntimeBinary,
+  resolveFrameworkRuntimeOutputDir
+} from "./project.js"
+
+function escapePlistString(value) {
+  return value
+    .replaceAll("&", "&amp;")
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;")
+}
+
+function serializePlistValue(value, indentLevel = 1) {
+  const indent = "  ".repeat(indentLevel)
+
+  if (Array.isArray(value)) {
+    if (value.length === 0) {
+      return `${indent}<array/>\n`
+    }
+
+    return (
+      `${indent}<array>\n` +
+      value.map((entry) => serializePlistValue(entry, indentLevel + 1)).join("") +
+      `${indent}</array>\n`
+    )
+  }
+
+  if (typeof value === "object" && value !== null) {
+    const entries = Object.entries(value)
+    if (entries.length === 0) {
+      return `${indent}<dict/>\n`
+    }
+
+    return (
+      `${indent}<dict>\n` +
+      entries
+        .map(
+          ([key, entryValue]) =>
+            `${"  ".repeat(indentLevel + 1)}<key>${escapePlistString(key)}</key>\n${serializePlistValue(entryValue, indentLevel + 1)}`
+        )
+        .join("") +
+      `${indent}</dict>\n`
+    )
+  }
+
+  if (typeof value === "boolean") {
+    return `${indent}<${value ? "true" : "false"}/>\n`
+  }
+
+  if (typeof value === "number") {
+    return `${indent}<integer>${value}</integer>\n`
+  }
+
+  return `${indent}<string>${escapePlistString(String(value))}</string>\n`
+}
+
+function buildMacOSInfoPlist(config) {
+  const urlTypes = Array.isArray(config.protocols?.schemes)
+    ? config.protocols.schemes.map((schemeConfig) => ({
+        CFBundleTypeRole: schemeConfig.role ?? "Viewer",
+        CFBundleURLName:
+          typeof schemeConfig.name === "string" && schemeConfig.name.trim() !== ""
+            ? schemeConfig.name
+            : `${config.appId}.${schemeConfig.scheme}`,
+        CFBundleURLSchemes: [schemeConfig.scheme]
+      }))
+    : []
+
+  const plist = {
+    CFBundleDevelopmentRegion: "English",
+    CFBundleDisplayName: config.productName,
+    CFBundleExecutable: "reset-framework",
+    CFBundleIdentifier: config.appId,
+    CFBundleInfoDictionaryVersion: "6.0",
+    CFBundleName: config.productName,
+    CFBundlePackageType: "APPL",
+    CFBundleShortVersionString: config.version,
+    CFBundleVersion: config.version,
+    CSResourcesFileMapped: true
+  }
+
+  if (urlTypes.length > 0) {
+    plist.CFBundleURLTypes = urlTypes
+  }
+
+  return (
+    `<?xml version="1.0" encoding="UTF-8"?>\n` +
+    `<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n` +
+    `<plist version="1.0">\n` +
+    serializePlistValue(plist, 0) +
+    `</plist>\n`
+  )
 }
 
-function serializePlistValue(value, indentLevel = 1) {
-  const indent = "  ".repeat(indentLevel)
-
-  if (Array.isArray(value)) {
-    if (value.length === 0) {
-      return `${indent}<array/>\n`
-    }
-
-    return (
-      `${indent}<array>\n` +
-      value.map((entry) => serializePlistValue(entry, indentLevel + 1)).join("") +
-      `${indent}</array>\n`
-    )
-  }
-
-  if (typeof value === "object" && value !== null) {
-    const entries = Object.entries(value)
-    if (entries.length === 0) {
-      return `${indent}<dict/>\n`
-    }
-
-    return (
-      `${indent}<dict>\n` +
-      entries
-        .map(
-          ([key, entryValue]) =>
-            `${"  ".repeat(indentLevel + 1)}<key>${escapePlistString(key)}</key>\n${serializePlistValue(entryValue, indentLevel + 1)}`
-        )
-        .join("") +
-      `${indent}</dict>\n`
-    )
-  }
+function shouldCopyWindowsRuntimeArtifact(entryName) {
+  const extension = path.extname(entryName).toLowerCase()
 
-  if (typeof value === "boolean") {
-    return `${indent}<${value ? "true" : "false"}/>\n`
-  }
-
-  if (typeof value === "number") {
-    return `${indent}<integer>${value}</integer>\n`
-  }
-
-  return `${indent}<string>${escapePlistString(String(value))}</string>\n`
+  return [
+    ".bin",
+    ".dat",
+    ".dll",
+    ".exe",
+    ".json",
+    ".manifest",
+    ".pak",
+    ".pri"
+  ].includes(extension)
 }
 
-function buildMacOSInfoPlist(config) {
-  const urlTypes = Array.isArray(config.protocols?.schemes)
-    ? config.protocols.schemes.map((schemeConfig) => ({
-        CFBundleTypeRole: schemeConfig.role ?? "Viewer",
-        CFBundleURLName:
-          typeof schemeConfig.name === "string" && schemeConfig.name.trim() !== ""
-            ? schemeConfig.name
-            : `${config.appId}.${schemeConfig.scheme}`,
-        CFBundleURLSchemes: [schemeConfig.scheme]
-      }))
-    : []
-
-  const plist = {
-    CFBundleDevelopmentRegion: "English",
-    CFBundleDisplayName: config.productName,
-    CFBundleExecutable: "reset-framework",
-    CFBundleIdentifier: config.appId,
-    CFBundleInfoDictionaryVersion: "6.0",
-    CFBundleName: config.productName,
-    CFBundlePackageType: "APPL",
-    CFBundleShortVersionString: config.version,
-    CFBundleVersion: config.version,
-    CSResourcesFileMapped: true
-  }
-
-  if (urlTypes.length > 0) {
-    plist.CFBundleURLTypes = urlTypes
-  }
-
-  return (
-    `<?xml version="1.0" encoding="UTF-8"?>\n` +
-    `<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n` +
-    `<plist version="1.0">\n` +
-    serializePlistValue(plist, 0) +
-    `</plist>\n`
-  )
+function escapePowerShellLiteral(value) {
+  return String(value).replaceAll("'", "''")
 }
-
+
 export async function stageMacOSAppBundle(frameworkBuildPaths, appPaths, config, options = {}) {
+  const { dryRun = false, outputPaths, configPath } = options
+
+  if (!outputPaths) {
+    throw new Error("stageMacOSAppBundle requires resolved output paths")
+  }
+
+  if (!existsSync(frameworkBuildPaths.releaseAppTemplate) && !dryRun) {
+    throw new Error(
+      `Missing runtime app bundle at ${frameworkBuildPaths.releaseAppTemplate}. Run reset-framework-cli build first.`
+    )
+  }
+
+  if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
+    throw new Error(
+      `Missing frontend build output at ${outputPaths.frontendEntryFile}. Run the frontend build first.`
+    )
+  }
+
+  logger.info(`Staging app bundle into ${outputPaths.appBundlePath}`)
+
+  if (dryRun) {
+    logger.info(`- copy ${frameworkBuildPaths.releaseAppTemplate} -> ${outputPaths.appBundlePath}`)
+    logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
+    logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
+    return outputPaths
+  }
+
+  await mkdir(outputPaths.macosDir, { recursive: true })
+  await rm(outputPaths.appBundlePath, { recursive: true, force: true })
+  await cp(frameworkBuildPaths.releaseAppTemplate, outputPaths.appBundlePath, { recursive: true })
+
+  await mkdir(outputPaths.resourcesDir, { recursive: true })
+  await cp(configPath, outputPaths.bundledConfigPath, { force: true })
+  await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
+  await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
+  await writeFile(
+    path.join(outputPaths.appBundlePath, "Contents", "Info.plist"),
+    buildMacOSInfoPlist(config),
+    "utf8"
+  )
+
+  return outputPaths
+}
+
+export async function stageWindowsAppBundle(frameworkBuildPaths, appPaths, config, options = {}) {
   const { dryRun = false, outputPaths, configPath } = options
+  const runtimeSourceBinary = resolveFrameworkRuntimeBinary(frameworkBuildPaths, "release", {
+    mustExist: !dryRun
+  })
+  const runtimeSourceDir = resolveFrameworkRuntimeOutputDir(frameworkBuildPaths, "release", {
+    mustExist: !dryRun
+  })
 
   if (!outputPaths) {
-    throw new Error("stageMacOSAppBundle requires resolved output paths")
-  }
-
-  if (!existsSync(frameworkBuildPaths.releaseAppTemplate) && !dryRun) {
-    throw new Error(
-      `Missing runtime app bundle at ${frameworkBuildPaths.releaseAppTemplate}. Run reset-framework-cli build first.`
-    )
+    throw new Error("stageWindowsAppBundle requires resolved output paths")
   }
 
   if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
@@ -113,48 +181,88 @@ export async function stageMacOSAppBundle(frameworkBuildPaths, appPaths, config,
     )
   }
 
-  logger.info(`Staging app bundle into ${outputPaths.appBundlePath}`)
+  logger.info(`Staging Windows app into ${outputPaths.appBundlePath}`)
 
   if (dryRun) {
-    logger.info(`- copy ${frameworkBuildPaths.releaseAppTemplate} -> ${outputPaths.appBundlePath}`)
+    logger.info(`- copy ${runtimeSourceDir} -> ${outputPaths.appBundlePath}`)
+    logger.info(`- rename ${runtimeSourceBinary} -> ${outputPaths.appExecutablePath}`)
     logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
     logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
     return outputPaths
   }
 
-  await mkdir(outputPaths.macosDir, { recursive: true })
+  await mkdir(outputPaths.windowsDir, { recursive: true })
   await rm(outputPaths.appBundlePath, { recursive: true, force: true })
-  await cp(frameworkBuildPaths.releaseAppTemplate, outputPaths.appBundlePath, { recursive: true })
+  await mkdir(outputPaths.appBundlePath, { recursive: true })
+  const runtimeEntries = await readdir(runtimeSourceDir, { withFileTypes: true })
+  const runtimeBinaryName = path.basename(runtimeSourceBinary)
+
+  for (const entry of runtimeEntries) {
+    if (!entry.isDirectory() && !shouldCopyWindowsRuntimeArtifact(entry.name)) {
+      continue
+    }
+
+    const sourcePath = path.join(runtimeSourceDir, entry.name)
+    const targetPath =
+      entry.name.toLowerCase() === runtimeBinaryName.toLowerCase()
+        ? outputPaths.appExecutablePath
+        : path.join(outputPaths.appBundlePath, entry.name)
+
+    await cp(sourcePath, targetPath, { recursive: true, force: true })
+  }
 
   await mkdir(outputPaths.resourcesDir, { recursive: true })
   await cp(configPath, outputPaths.bundledConfigPath, { force: true })
   await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
   await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
-  await writeFile(
-    path.join(outputPaths.appBundlePath, "Contents", "Info.plist"),
-    buildMacOSInfoPlist(config),
-    "utf8"
-  )
 
   return outputPaths
 }
-
+
 export async function createMacOSZipArchive(outputPaths, options = {}) {
   const { dryRun = false } = options
+
+  logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
+
+  if (process.platform !== "darwin") {
+    throw new Error("Packaging is only implemented for macOS right now")
+  }
+
+  if (!dryRun) {
+    await mkdir(outputPaths.packagesDir, { recursive: true })
+  }
+
+  await runCommand(
+    "ditto",
+    ["-c", "-k", "--sequesterRsrc", "--keepParent", outputPaths.appBundlePath, outputPaths.zipPath],
+    { dryRun }
+  )
+}
+
+export async function createWindowsZipArchive(outputPaths, options = {}) {
+  const { dryRun = false } = options
 
   logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
 
-  if (process.platform !== "darwin") {
-    throw new Error("Packaging is only implemented for macOS right now")
+  if (process.platform !== "win32") {
+    throw new Error("Packaging is only implemented for Windows and macOS right now")
   }
 
   if (!dryRun) {
     await mkdir(outputPaths.packagesDir, { recursive: true })
+    await rm(outputPaths.zipPath, { force: true })
   }
 
+  const literalSourcePath = escapePowerShellLiteral(outputPaths.appBundlePath)
+  const literalDestinationPath = escapePowerShellLiteral(outputPaths.zipPath)
+  const archiveCommand = [
+    "$ErrorActionPreference = 'Stop'",
+    `Compress-Archive -LiteralPath '${literalSourcePath}' -DestinationPath '${literalDestinationPath}' -CompressionLevel Optimal`
+  ].join("; ")
+
   await runCommand(
-    "ditto",
-    ["-c", "-k", "--sequesterRsrc", "--keepParent", outputPaths.appBundlePath, outputPaths.zipPath],
+    "powershell.exe",
+    ["-NoLogo", "-NoProfile", "-NonInteractive", "-Command", archiveCommand],
     { dryRun }
   )
 }