@napi-rs/cli 3.6.0 → 3.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.6.0",
+  "version": "3.6.2",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://napi.rs/",
@@ -75,7 +75,7 @@
   },
   "devDependencies": {
     "@emnapi/runtime": "^1.9.1",
-    "@oxc-node/core": "^0.0.35",
+    "@oxc-node/core": "^0.1.0",
     "@std/toml": "npm:@jsr/std__toml@^1.0.11",
     "@types/inquirer": "^9.0.9",
     "@types/js-yaml": "^4.0.9",
@@ -84,7 +84,7 @@
     "ava": "^7.0.0",
     "empathic": "^2.0.0",
     "env-paths": "^4.0.0",
-    "oxc-parser": "^0.121.0",
+    "oxc-parser": "^0.125.0",
     "prettier": "^3.6.2",
     "tsdown": "^0.21.0",
     "tslib": "^2.8.1",

package/src/api/build.ts

@@ -381,35 +381,11 @@ class Builder {
           set = true
         }
       } else {
-        if (
-          this.target.platform === 'linux' &&
-          process.platform === 'linux' &&
-          this.target.arch === process.arch &&
-          (function (abi: string | null) {
-            const glibcVersionRuntime =
-              // @ts-expect-error
-              process.report?.getReport()?.header?.glibcVersionRuntime
-            const libc = glibcVersionRuntime ? 'gnu' : 'musl'
-            return abi === libc
-          })(this.target.abi)
-        ) {
-          debug.warn(
-            'You are trying to cross compile to linux target on linux platform which is unnecessary.',
-          )
-        } else if (
-          this.target.platform === 'darwin' &&
-          process.platform === 'darwin'
-        ) {
-          debug.warn(
-            'You are trying to cross compile to darwin target on darwin platform which is unnecessary.',
-          )
-        } else {
-          // use cargo-zigbuild to cross compile to other platforms
-          debug('Use %i', 'cargo-zigbuild')
-          tryInstallCargoBinary('cargo-zigbuild', 'zigbuild')
-          this.args.push('zigbuild')
-          set = true
-        }
+        // use cargo-zigbuild to cross compile to other platforms
+        debug('Use %i', 'cargo-zigbuild')
+        tryInstallCargoBinary('cargo-zigbuild', 'zigbuild')
+        this.args.push('zigbuild')
+        set = true
       }
     }
 
@@ -566,7 +542,7 @@ class Builder {
       require.resolve('emnapi'),
       '..',
       'lib',
-      'wasm32-wasi-threads',
+      'wasm32-wasip1-threads',
     )
     this.envs.EMNAPI_LINK_DIR = emnapi
     const emnapiVersion = require('emnapi/package.json').version
@@ -617,15 +593,15 @@ class Builder {
       )
       this.setEnvIfNotExists(
         'TARGET_CFLAGS',
-        `--target=wasm32-wasi-threads --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -pthread -mllvm -wasm-enable-sjlj`,
+        `--target=wasm32-wasip1-threads --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -pthread -mllvm -wasm-enable-sjlj`,
       )
       this.setEnvIfNotExists(
         'TARGET_CXXFLAGS',
-        `--target=wasm32-wasi-threads --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -pthread -mllvm -wasm-enable-sjlj`,
+        `--target=wasm32-wasip1-threads --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -pthread -mllvm -wasm-enable-sjlj`,
       )
       this.setEnvIfNotExists(
         `TARGET_LDFLAGS`,
-        `-fuse-ld=${WASI_SDK_PATH}/bin/wasm-ld --target=wasm32-wasi-threads`,
+        `-fuse-ld=${WASI_SDK_PATH}/bin/wasm-ld --target=wasm32-wasip1-threads`,
       )
     }
   }
@@ -1117,19 +1093,21 @@ export async function generateTypeDef(
     return { exports: [], dts: '' }
   }
 
-  for (const file of files) {
-    if (!file.isFile()) {
-      continue
-    }
-
-    const { dts: fileDts, exports: fileExports } = await processTypeDef(
-      join(options.typeDefDir, file.name),
-      options.constEnum ?? true,
-    )
+  const typeDefFiles = files
+    .filter((file) => file.isFile())
+    .sort((a, b) => a.name.localeCompare(b.name))
+
+  const processedTypeDefs = await Promise.all(
+    typeDefFiles.map((file) =>
+      processTypeDef(
+        join(options.typeDefDir, file.name),
+        options.constEnum ?? true,
+      ),
+    ),
+  )
 
-    dts += fileDts
-    exports.push(...fileExports)
-  }
+  dts = processedTypeDefs.map(({ dts }) => dts).join('')
+  exports = processedTypeDefs.flatMap(({ exports }) => exports)
 
   if (dts.indexOf('ExternalObject<') > -1) {
     header += `

package/src/api/create-npm-dirs.ts

@@ -1,9 +1,10 @@
 import { createRequire } from 'node:module'
 import { join, resolve } from 'node:path'
 
-import { parse } from 'semver'
+import { Comparator, Range, minVersion, subset } from 'semver'
 
 const require = createRequire(import.meta.url)
+const minimumWasiNodeVersion = '>=14.0.0'
 
 import {
   applyDefaultCreateNpmDirsOptions,
@@ -25,6 +26,52 @@ export interface PackageMeta {
   'dist-tags': { [index: string]: string }
 }
 
+const WASM_RUNTIME_PACKAGE_NAME = '@napi-rs/wasm-runtime'
+
+async function getLatestWasmRuntimeVersion() {
+  const npmRegistryBase =
+    process.env.npm_config_registry?.replace(/\/?$/, '/') ??
+    'https://registry.npmjs.org/'
+  const packageMetadataUrl = `${npmRegistryBase}${WASM_RUNTIME_PACKAGE_NAME}`
+  let response: Response
+
+  try {
+    response = await fetch(packageMetadataUrl)
+  } catch (error) {
+    throw new Error(
+      `Failed to fetch ${packageMetadataUrl} while resolving ${WASM_RUNTIME_PACKAGE_NAME}. Check your network connection and npm registry availability.`,
+      { cause: error },
+    )
+  }
+
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch ${packageMetadataUrl} while resolving ${WASM_RUNTIME_PACKAGE_NAME}: npm registry responded with ${response.status} ${response.statusText || 'Unknown Status'}`,
+    )
+  }
+
+  let packageMeta: PackageMeta
+
+  try {
+    packageMeta = (await response.json()) as PackageMeta
+  } catch (error) {
+    throw new Error(
+      `Failed to parse npm registry metadata for ${WASM_RUNTIME_PACKAGE_NAME} from ${packageMetadataUrl}`,
+      { cause: error },
+    )
+  }
+
+  const latestVersion = packageMeta['dist-tags']?.latest
+
+  if (typeof latestVersion !== 'string' || latestVersion.trim().length === 0) {
+    throw new Error(
+      `npm registry metadata for ${WASM_RUNTIME_PACKAGE_NAME} from ${packageMetadataUrl} did not include a latest dist-tag`,
+    )
+  }
+
+  return latestVersion.trim()
+}
+
 export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
   const options = applyDefaultCreateNpmDirsOptions(userOptions)
 
@@ -60,6 +107,9 @@ export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
       packageJsonPath,
       options.configPath ? resolve(options.cwd, options.configPath) : undefined,
     )
+  const wasmRuntimeVersion = targets.some((target) => target.arch === 'wasm32')
+    ? await getLatestWasmRuntimeVersion()
+    : undefined
 
   for (const target of targets) {
     const targetDir = join(npmPath, `${target.platformArchABI}`)
@@ -107,30 +157,15 @@ export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
         `wasi-worker.mjs`,
         `wasi-worker-browser.mjs`,
       )
-      let needRestrictNodeVersion = true
-      if (scopedPackageJson.engines?.node) {
-        try {
-          const { major } = parse(scopedPackageJson.engines.node) ?? {
-            major: 0,
-          }
-          if (major >= 14) {
-            needRestrictNodeVersion = false
-          }
-        } catch {
-          // ignore
-        }
-      }
-      if (needRestrictNodeVersion) {
-        scopedPackageJson.engines = {
-          node: '>=14.0.0',
-        }
+      scopedPackageJson.engines = {
+        ...scopedPackageJson.engines,
+        node: scopedPackageJson.engines?.node
+          ? restrictWasiNodeEngine(scopedPackageJson.engines.node)
+          : minimumWasiNodeVersion,
       }
       const emnapiVersion = require('emnapi/package.json').version
-      const wasmRuntime = await fetch(
-        `https://registry.npmjs.org/@napi-rs/wasm-runtime`,
-      ).then((res) => res.json() as Promise<PackageMeta>)
       scopedPackageJson.dependencies = {
-        '@napi-rs/wasm-runtime': `^${wasmRuntime['dist-tags'].latest}`,
+        '@napi-rs/wasm-runtime': `^${wasmRuntimeVersion}`,
         '@emnapi/core': emnapiVersion,
         '@emnapi/runtime': emnapiVersion,
       }
@@ -160,3 +195,69 @@ function readme(packageName: string, target: Target) {
 This is the **${target.triple}** binary for \`${packageName}\`
 `
 }
+
+function restrictWasiNodeEngine(nodeRange: string) {
+  try {
+    if (subset(nodeRange, minimumWasiNodeVersion)) {
+      return nodeRange
+    }
+
+    if (subset(minimumWasiNodeVersion, nodeRange)) {
+      return minimumWasiNodeVersion
+    }
+
+    const minimumComparator = new Comparator(minimumWasiNodeVersion)
+    const restrictedRangeSets = new Range(nodeRange).set
+      .map((comparators) =>
+        normalizeComparatorSet([...comparators, minimumComparator]),
+      )
+      .filter(
+        (candidate): candidate is string =>
+          candidate !== undefined && minVersion(candidate) !== null,
+      )
+
+    if (restrictedRangeSets.length > 0) {
+      return restrictedRangeSets.join(' || ')
+    }
+  } catch {
+    // ignore
+  }
+
+  return minimumWasiNodeVersion
+}
+
+function normalizeComparatorSet(comparators: Comparator[]) {
+  const exactMatch = comparators.find(({ operator }) => operator === '')
+  if (exactMatch) {
+    return comparators.every((comparator) => comparator.test(exactMatch.semver))
+      ? exactMatch.value
+      : undefined
+  }
+
+  let lowerBound: Comparator | undefined
+  let upperBound: Comparator | undefined
+
+  for (const comparator of comparators) {
+    if (comparator.operator === '>' || comparator.operator === '>=') {
+      if (
+        !lowerBound ||
+        comparator.semver.compare(lowerBound.semver) > 0 ||
+        (comparator.semver.compare(lowerBound.semver) === 0 &&
+          comparator.operator === '>')
+      ) {
+        lowerBound = comparator
+      }
+    } else if (comparator.operator === '<' || comparator.operator === '<=') {
+      if (
+        !upperBound ||
+        comparator.semver.compare(upperBound.semver) < 0 ||
+        (comparator.semver.compare(upperBound.semver) === 0 &&
+          comparator.operator === '<')
+      ) {
+        upperBound = comparator
+      }
+    }
+  }
+
+  return [lowerBound?.value, upperBound?.value].filter(Boolean).join(' ')
+}

package/src/api/new.ts

@@ -4,6 +4,7 @@ import { homedir } from 'node:os'
 import path from 'node:path'
 import { promises as fs } from 'node:fs'
 
+import { parse as parseToml, stringify as stringifyToml } from '@std/toml'
 import { load as yamlLoad, dump as yamlDump } from 'js-yaml'
 
 import {
@@ -15,6 +16,7 @@ import {
   debugFactory,
   DEFAULT_TARGETS,
   mkdirAsync,
+  parseTriple,
   readdirAsync,
   statAsync,
   type SupportedPackageManager,
@@ -33,25 +35,18 @@ const TEMPLATE_REPOS = {
   pnpm: 'https://github.com/napi-rs/package-template-pnpm',
 } as const
 
+const WASI_TARGET = 'wasm32-wasip1-threads'
+
 async function checkGitCommand(): Promise<boolean> {
-  try {
-    await new Promise((resolve) => {
-      const cp = exec('git --version')
-      cp.on('error', () => {
-        resolve(false)
-      })
-      cp.on('exit', (code) => {
-        if (code === 0) {
-          resolve(true)
-        } else {
-          resolve(false)
-        }
-      })
+  return new Promise<boolean>((resolve) => {
+    const cp = exec('git --version')
+    cp.on('error', () => {
+      resolve(false)
     })
-    return true
-  } catch {
-    return false
-  }
+    cp.on('exit', (code) => {
+      resolve(code === 0)
+    })
+  })
 }
 
 async function ensureCacheDir(
@@ -132,9 +127,9 @@ async function copyDirectory(
         !includeWasiBindings &&
         (entry.name.endsWith('.wasi-browser.js') ||
           entry.name.endsWith('.wasi.cjs') ||
-          entry.name.endsWith('wasi-worker.browser.mjs ') ||
+          entry.name.endsWith('wasi-worker-browser.mjs') ||
           entry.name.endsWith('wasi-worker.mjs') ||
-          entry.name.endsWith('browser.js'))
+          entry.name === 'browser.js')
       ) {
         continue
       }
@@ -149,6 +144,7 @@ async function filterTargetsInPackageJson(
 ): Promise<void> {
   const content = await fs.readFile(filePath, 'utf-8')
   const packageJson = JSON.parse(content)
+  const includeWasiBindings = enabledTargets.includes(WASI_TARGET)
 
   // Filter napi.targets
   if (packageJson.napi?.targets) {
@@ -157,9 +153,63 @@ async function filterTargetsInPackageJson(
     )
   }
 
+  if (!includeWasiBindings) {
+    if (
+      packageJson.browser === 'browser.js' ||
+      packageJson.browser === './browser.js'
+    ) {
+      delete packageJson.browser
+    }
+
+    if (Array.isArray(packageJson.files)) {
+      packageJson.files = packageJson.files.filter(
+        (file: unknown) => file !== 'browser.js' && file !== './browser.js',
+      )
+    }
+  }
+
   await fs.writeFile(filePath, JSON.stringify(packageJson, null, 2) + '\n')
 }
 
+async function updateCargoTomlTypeDef(
+  filePath: string,
+  enableTypeDef: boolean,
+): Promise<void> {
+  if (enableTypeDef) {
+    return
+  }
+
+  const content = await fs.readFile(filePath, 'utf-8')
+  const cargoToml = parseToml(content) as Record<string, any>
+  const dependencies = cargoToml.dependencies
+
+  if (!dependencies || !dependencies['napi-derive']) {
+    return
+  }
+
+  const napiDeriveDependency = dependencies['napi-derive']
+  const dependencyConfig =
+    typeof napiDeriveDependency === 'string'
+      ? { version: napiDeriveDependency }
+      : { ...napiDeriveDependency }
+
+  const existingFeatures = Array.isArray(dependencyConfig.features)
+    ? dependencyConfig.features.filter(
+        (feature: unknown): feature is string => typeof feature === 'string',
+      )
+    : []
+
+  dependencyConfig['default-features'] = false
+  dependencyConfig.features = [
+    'strict',
+    ...existingFeatures.filter((feature) => feature !== 'strict'),
+  ].filter((feature) => feature !== 'type-def')
+
+  dependencies['napi-derive'] = dependencyConfig
+
+  await fs.writeFile(filePath, stringifyToml(cargoToml))
+}
+
 async function filterTargetsInGithubActions(
   filePath: string,
   enabledTargets: string[],
@@ -167,13 +217,6 @@ async function filterTargetsInGithubActions(
   const content = await fs.readFile(filePath, 'utf-8')
   const yaml = yamlLoad(content) as any
 
-  const macOSAndWindowsTargets = new Set([
-    'x86_64-pc-windows-msvc',
-    'x86_64-pc-windows-gnu',
-    'aarch64-pc-windows-msvc',
-    'x86_64-apple-darwin',
-  ])
-
   const linuxTargets = new Set([
     'x86_64-unknown-linux-gnu',
     'x86_64-unknown-linux-musl',
@@ -193,6 +236,10 @@ async function filterTargetsInGithubActions(
   const hasLinuxTargets = enabledTargets.some((target) =>
     linuxTargets.has(target),
   )
+  const hasMacOSOrWindowsTargets = enabledTargets.some((target) => {
+    const platform = parseTriple(target).platform
+    return platform === 'darwin' || platform === 'win32'
+  })
 
   // Filter the matrix configurations in the build job
   if (yaml?.jobs?.build?.strategy?.matrix?.settings) {
@@ -207,7 +254,7 @@ async function filterTargetsInGithubActions(
 
   const jobsToRemove: string[] = []
 
-  if (enabledTargets.every((target) => !macOSAndWindowsTargets.has(target))) {
+  if (!hasMacOSOrWindowsTargets) {
     jobsToRemove.push('test-macOS-windows-binding')
   } else {
     // Filter the matrix configurations in the test-macOS-windows-binding job
@@ -246,7 +293,7 @@ async function filterTargetsInGithubActions(
     }
   }
 
-  if (!enabledTargets.includes('wasm32-wasip1-threads')) {
+  if (!enabledTargets.includes(WASI_TARGET)) {
     jobsToRemove.push('test-wasi')
   }
 
@@ -322,11 +369,9 @@ function processOptions(options: RawNewOptions) {
     const out = execSync(`rustup target list`, {
       encoding: 'utf8',
     })
-    if (out.includes('wasm32-wasip1-threads')) {
+    if (out.includes(WASI_TARGET)) {
       options.targets = options.targets.map((target) =>
-        target === 'wasm32-wasi-preview1-threads'
-          ? 'wasm32-wasip1-threads'
-          : target,
+        target === 'wasm32-wasi-preview1-threads' ? WASI_TARGET : target,
       )
     }
   }
@@ -366,7 +411,7 @@ export async function newProject(userOptions: RawNewOptions) {
       await copyDirectory(
         templatePath,
         options.path,
-        options.targets.includes('wasm32-wasip1-threads'),
+        options.targets.includes(WASI_TARGET),
       )
 
       // Rename project using the rename API
@@ -376,6 +421,11 @@ export async function newProject(userOptions: RawNewOptions) {
         binaryName: getBinaryName(options.name),
       })
 
+      const cargoTomlPath = path.join(options.path, 'Cargo.toml')
+      if (existsSync(cargoTomlPath)) {
+        await updateCargoTomlTypeDef(cargoTomlPath, options.enableTypeDef)
+      }
+
       // Filter targets in package.json
       const packageJsonPath = path.join(options.path, 'package.json')
       if (existsSync(packageJsonPath)) {

package/src/api/pre-publish.ts

@@ -85,6 +85,7 @@ export async function prePublish(userOptions: PrePublishOptions) {
 
   function getRepoInfo(packageName: string, version: string) {
     const headCommit = execSync('git log -1 --pretty=%B', {
+      cwd: options.cwd,
       encoding: 'utf-8',
     }).trim()
 

package/src/api/rename.ts

@@ -41,12 +41,32 @@ export async function renameProject(userOptions: RenameOptions) {
     },
   )
 
+  if (options.repository) {
+    if (
+      packageJsonData.repository &&
+      typeof packageJsonData.repository === 'object' &&
+      !Array.isArray(packageJsonData.repository)
+    ) {
+      packageJsonData.repository.url = options.repository
+    } else {
+      packageJsonData.repository = options.repository
+    }
+  }
+
   if (options.configPath) {
     const configPath = resolve(options.cwd, options.configPath)
     const configContent = await readFileAsync(configPath, 'utf8')
     const configData = JSON.parse(configContent)
-    configData.binaryName = options.binaryName
-    configData.packageName = options.packageName
+    merge(
+      configData,
+      omitBy(
+        {
+          binaryName: options.binaryName,
+          packageName: options.packageName,
+        },
+        isNil,
+      ),
+    )
     await writeFileAsync(configPath, JSON.stringify(configData, null, 2))
   }
 
@@ -73,7 +93,7 @@ export async function renameProject(userOptions: RenameOptions) {
   const updatedTomlContent = stringifyToml(cargoToml)
 
   await writeFileAsync(cargoTomlPath, updatedTomlContent)
-  if (oldName !== options.binaryName) {
+  if (options.binaryName && oldName !== options.binaryName) {
     const githubActionsPath = find.dir('.github', {
       cwd: options.cwd,
     })

package/src/api/universalize.ts

@@ -1,5 +1,5 @@
 import { spawnSync } from 'node:child_process'
-import { join, resolve } from 'node:path'
+import { resolve } from 'node:path'
 
 import {
   applyDefaultUniversalizeOptions,
@@ -25,7 +25,7 @@ const universalizers: Partial<
 export async function universalizeBinaries(userOptions: UniversalizeOptions) {
   const options = applyDefaultUniversalizeOptions(userOptions)
 
-  const packageJsonPath = join(options.cwd, options.packageJsonPath)
+  const packageJsonPath = resolve(options.cwd, options.packageJsonPath)
 
   const config = await readNapiConfig(
     packageJsonPath,

package/src/commands/build.ts

@@ -35,6 +35,7 @@ export class BuildCommand extends BaseBuildCommand {
         } catch (e) {
           debug.error(`Failed to pipe output file ${output.path} to command`)
           debug.error(e)
+          throw e
         }
       }
     }

package/src/commands/new.ts

@@ -11,10 +11,20 @@ import {
   DEFAULT_TARGETS,
   type TargetTriple,
 } from '../utils/index.js'
-import { napiEngineRequirement } from '../utils/version.js'
+import {
+  napiEngineRequirement,
+  SUPPORTED_NAPI_VERSIONS,
+} from '../utils/version.js'
 
 const debug = debugFactory('new')
 
+export function getNapiVersionChoices() {
+  return SUPPORTED_NAPI_VERSIONS.map((version) => ({
+    name: `napi${version} (${napiEngineRequirement(version)})`,
+    value: version,
+  }))
+}
+
 export class NewCommand extends BaseNewCommand {
   interactive = Option.Boolean('--interactive,-i', true, {
     description:
@@ -77,10 +87,7 @@ export class NewCommand extends BaseNewCommand {
       message: 'Minimum node-api version (with node version requirement)',
       loop: false,
       pageSize: 10,
-      choices: Array.from({ length: 8 }, (_, i) => ({
-        name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
-        value: i + 1,
-      })),
+      choices: getNapiVersionChoices(),
       // choice index
       default: this.minNodeApiVersion - 1,
     })

package/src/utils/metadata.ts

@@ -62,7 +62,7 @@ export async function parseMetadata(manifestPath: string) {
   let stdout = ''
   let stderr = ''
   let status = 0
-  let error = null
+  let error: Error | null = null
 
   childProcess.stdout.on('data', (data) => {
     stdout += data
@@ -72,6 +72,10 @@ export async function parseMetadata(manifestPath: string) {
     stderr += data
   })
 
+  childProcess.on('error', (err) => {
+    error = err
+  })
+
   await new Promise<void>((resolve) => {
     childProcess.on('close', (code) => {
       status = code ?? 0