Merge pull request #57 from EmbeddedEnterprises/cross-compile-default

fix: fix detection of default cross-compilation

Author: aminya

README.md

@@ -24,12 +24,18 @@ cmake-ts can build the projects with built-in configurations that are selected d
 cmake-ts build --config debug
 ```
 
-You can cross-compile by specifying the built-in cross configs
+You can cross-compile by specifying the built-in cross configs:
 
 ```bash
 cmake-ts build --config cross-win32-arm64-release
 ```
 
+Or by specifying the `npm_config_target_os` and `npm_config_target_arch` environment variables:
+
+```bash
+npm_config_target_os=linux npm_config_target_arch=arm64 cmake-ts build
+```
+
 ### CLI Arguments
 
 `build` command:
@@ -81,11 +87,11 @@ Options:
          - `darwin-arm64-node-release`
          - `darwin-arm64-electron-relwithdebinfo`
 
-      To explicitly indicate cross-compilation, prefix the config name with \`cross-\`:
+      To explicitly indicate cross-compilation, prefix the config name with `cross-`:
 
-       - \`cross-win32-ia32-node-release\`
-       - \`cross-linux-arm64-node-release\`
-       - \`cross-darwin-x64-electron-relwithdebinfo\`
+       - `cross-win32-ia32-node-release`
+       - `cross-linux-arm64-node-release`
+       - `cross-darwin-x64-electron-relwithdebinfo`
 
       You can also define your own configs in the config file (package.json).
 

src/config.ts

@@ -62,14 +62,10 @@ export async function getBuildConfig(
 
   // Platform
 
+  config.cross = detectCrossCompilation(globalConfig, config)
+
   config.os ??= globalConfig.os ?? process.platform
   config.arch ??= globalConfig.arch ?? process.arch
-  config.cross ??=
-    globalConfig.cross ??
-    (process.platform !== config.os ||
-      (process.env.npm_config_target_os !== undefined && process.env.npm_config_target_os !== config.os) ||
-      process.arch !== config.arch ||
-      (process.env.npm_config_target_arch !== undefined && process.env.npm_config_target_arch !== config.arch))
 
   // Runtime
 
@@ -111,6 +107,55 @@ export async function getBuildConfig(
   return config as BuildConfiguration
 }
 
+export function detectCrossCompilation(
+  globalConfig: Partial<BuildConfigurations>,
+  config: Partial<BuildConfiguration>,
+) {
+  if (globalConfig.cross === true) {
+    logger.debug("Cross compilation detected: globalConfig.cross is true")
+    return true
+  }
+  if (config.os !== undefined && platforms.has(config.os as NodeJS.Platform) && config.os !== process.platform) {
+    // if the config os is set, check if the current os is different from the config os
+    logger.debug(
+      `Cross compilation detected: config.os (${config.os}) differs from process.platform (${process.platform})`,
+    )
+    return true
+  }
+  if (
+    config.arch !== undefined &&
+    architectures.has(config.arch as NodeJS.Architecture) &&
+    config.arch !== process.arch
+  ) {
+    // if the config arch is set, check if the current arch is different from the config arch
+    logger.debug(`Cross compilation detected: config.arch (${config.arch}) differs from process.arch (${process.arch})`)
+    return true
+  }
+  if (
+    process.env.npm_config_target_os !== undefined &&
+    platforms.has(process.env.npm_config_target_os as NodeJS.Platform) &&
+    process.env.npm_config_target_os !== process.platform
+  ) {
+    // if the target os is set via npm_config_target_os, check if it is different from the config os
+    logger.debug(
+      `Cross compilation detected: npm_config_target_os (${process.env.npm_config_target_os}) differs from process.platform (${process.platform})`,
+    )
+    return true
+  }
+  if (
+    process.env.npm_config_target_arch !== undefined &&
+    architectures.has(process.env.npm_config_target_arch as NodeJS.Architecture) &&
+    process.env.npm_config_target_arch !== process.arch
+  ) {
+    // if the target arch is set via npm_config_target_arch, check if it is different from the config arch
+    logger.debug(
+      `Cross compilation detected: npm_config_target_arch (${process.env.npm_config_target_arch}) differs from process.arch (${process.arch})`,
+    )
+    return true
+  }
+  return false
+}
+
 export function parseBuiltInConfigs(configName: string) {
   const parts = configName.split("-")
 

test/config.test.ts

@@ -1,10 +1,19 @@
 import { join } from "path"
 import { writeJson } from "fs-extra"
-import { afterEach, beforeEach, expect, suite, test } from "vitest"
+import { afterEach, beforeEach, expect, suite, test, vi } from "vitest"
 import type { BuildCommandOptions, BuildConfiguration, BuildConfigurations, Options } from "../src/config-types.d.js"
-import { getBuildConfig, getConfigFile, parseBuildConfigs, parseBuiltInConfigs } from "../src/config.js"
+import {
+  detectCrossCompilation,
+  getBuildConfig,
+  getConfigFile,
+  parseBuildConfigs,
+  parseBuiltInConfigs,
+} from "../src/config.js"
+import { logger } from "../src/lib.js"
 
 suite("Config Functions", () => {
+  logger.setLevel("debug")
+
   const mockBuildOptions: BuildCommandOptions = {
     configs: [],
     addonSubdirectory: "",
@@ -35,8 +44,10 @@ suite("Config Functions", () => {
 
   beforeEach(async () => {
     // Reset environment variables
-    process.env.npm_config_target_arch = undefined
-    process.env.npm_config_target_os = undefined
+    // biome-ignore lint/performance/noDelete: https://github.com/biomejs/biome/issues/5643
+    delete process.env.npm_config_target_arch
+    // biome-ignore lint/performance/noDelete: https://github.com/biomejs/biome/issues/5643
+    delete process.env.npm_config_target_os
 
     // Create test package.json
     await writeJson(testPackageJsonPath, {
@@ -48,8 +59,10 @@ suite("Config Functions", () => {
 
   afterEach(async () => {
     // Clean up environment variables
-    process.env.npm_config_target_arch = undefined
-    process.env.npm_config_target_os = undefined
+    // biome-ignore lint/performance/noDelete: https://github.com/biomejs/biome/issues/5643
+    delete process.env.npm_config_target_arch
+    // biome-ignore lint/performance/noDelete: https://github.com/biomejs/biome/issues/5643
+    delete process.env.npm_config_target_os
 
     // Remove test package.json
     try {
@@ -122,7 +135,7 @@ suite("Config Functions", () => {
 
     test("should handle cross compilation flags", async () => {
       const partialConfig: Partial<BuildConfiguration> = {
-        os: "win32",
+        os: process.platform === "win32" ? "linux" : "win32",
         arch: "x64",
       }
 
@@ -131,7 +144,7 @@ suite("Config Functions", () => {
       expect(result.cross).toBe(true)
     })
 
-    test("should set cross flag when npm_config_target_arch differs from process.arch", async () => {
+    test("should respect npm_config_target_arch when it matches config.arch", async () => {
       // Set npm_config_target_arch to a different architecture than the current one
       process.env.npm_config_target_arch = process.arch === "x64" ? "arm64" : "x64"
 
@@ -146,19 +159,55 @@ suite("Config Functions", () => {
       expect(result.arch).toBe(process.env.npm_config_target_arch)
     })
 
-    test("should set cross flag when npm_config_target_arch differs from process.arch when no config file is provided", async () => {
+    test("should respect config.arch when it matches process.arch", async () => {
+      // Mock process.arch
+      vi.spyOn(process, "arch", "get").mockReturnValue("arm64")
+
+      const partialConfig: Partial<BuildConfiguration> = {
+        os: process.platform,
+        arch: process.arch,
+      }
+
+      console.log(process.arch, detectCrossCompilation(mockConfigFile, partialConfig))
+
+      const result = await getBuildConfig(mockBuildOptions, partialConfig, mockConfigFile)
+
+      expect(result.cross).toBe(false)
+      expect(result.arch).toBe(process.arch)
+
+      vi.restoreAllMocks()
+    })
+
+    test("should respect config.arch when it differs from process.arch", async () => {
+      // Mock process.arch
+      vi.spyOn(process, "arch", "get").mockReturnValue("arm64")
+
+      const partialConfig: Partial<BuildConfiguration> = {
+        os: process.platform,
+        arch: "x64", // Different from process.arch
+      }
+
+      const result = await getBuildConfig(mockBuildOptions, partialConfig, mockConfigFile)
+
+      expect(result.cross).toBe(true)
+      expect(result.arch).toBe("x64")
+
+      vi.restoreAllMocks()
+    })
+
+    test("should respect npm_config_target_arch when it differs from process.arch", async () => {
       // Set npm_config_target_arch to a different architecture than the current one
       process.env.npm_config_target_arch = process.arch === "x64" ? "arm64" : "x64"
 
       const partialConfig: Partial<BuildConfiguration> = {
         os: process.platform,
-        arch: process.env.npm_config_target_arch as NodeJS.Architecture,
+        arch: process.arch,
       }
 
-      const result = await getBuildConfig(mockBuildOptions, partialConfig, {})
+      const result = await getBuildConfig(mockBuildOptions, partialConfig, mockConfigFile)
 
       expect(result.cross).toBe(true)
-      expect(result.arch).toBe(process.env.npm_config_target_arch)
+      expect(result.arch).toBe(process.arch)
     })
 
     test("should use default values when no config file is provided", async () => {