@napi-rs/cli 3.2.0 → 3.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://github.com/napi-rs/napi-rs",
@@ -25,7 +25,8 @@
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "!__tests__"
   ],
   "keywords": [
     "cli",
@@ -68,13 +69,11 @@
     "debug": "^4.4.1",
     "emnapi": "^1.5.0",
     "es-toolkit": "^1.39.10",
-    "find-up": "^7.0.0",
     "js-yaml": "^4.1.0",
     "semver": "^7.7.2",
     "typanion": "^3.14.0"
   },
   "devDependencies": {
-    "@emnapi/core": "^1.5.0",
     "@emnapi/runtime": "^1.5.0",
     "@oxc-node/core": "^0.0.32",
     "@std/toml": "npm:@jsr/std__toml@^1.0.10",
@@ -84,6 +83,7 @@
     "@types/node": "^24.3.1",
     "@types/semver": "^7.7.1",
     "ava": "^6.4.1",
+    "empathic": "^2.0.0",
     "env-paths": "^3.0.0",
     "prettier": "^3.6.2",
     "tsdown": "^0.15.0",
@@ -91,8 +91,7 @@
     "typescript": "^5.9.2"
   },
   "peerDependencies": {
-    "@emnapi/runtime": "^1.1.0",
-    "emnapi": "^1.1.0"
+    "@emnapi/runtime": "^1.5.0"
   },
   "peerDependenciesMeta": {
     "@emnapi/runtime": {

package/src/api/artifacts.ts

@@ -4,7 +4,7 @@ import * as colors from 'colorette'
 
 import {
   applyDefaultArtifactsOptions,
-  ArtifactsOptions,
+  type ArtifactsOptions,
 } from '../def/artifacts.js'
 import {
   readNapiConfig,

package/src/api/build.ts

@@ -7,31 +7,31 @@ import { parse, join, resolve } from 'node:path'
 
 import * as colors from 'colorette'
 
-import { BuildOptions as RawBuildOptions } from '../def/build.js'
+import type { BuildOptions as RawBuildOptions } from '../def/build.js'
 import {
   CLI_VERSION,
   copyFileAsync,
-  Crate,
+  type Crate,
   debugFactory,
   DEFAULT_TYPE_DEF_HEADER,
   fileExists,
   getSystemDefaultTarget,
   getTargetLinker,
   mkdirAsync,
-  NapiConfig,
+  type NapiConfig,
   parseMetadata,
   parseTriple,
   processTypeDef,
   readFileAsync,
   readNapiConfig,
-  Target,
+  type Target,
   targetToEnvVar,
   tryInstallCargoBinary,
   unlinkAsync,
   writeFileAsync,
   dirExistsAsync,
   readdirAsync,
-  CargoWorkspaceMetadata,
+  type CargoWorkspaceMetadata,
 } from '../utils/index.js'
 
 import { createCjsBinding, createEsmBinding } from './templates/index.js'
@@ -876,121 +876,42 @@ class Builder {
 
   private async generateTypeDef() {
     const typeDefDir = this.envs.NAPI_TYPE_DEF_TMP_FOLDER
-    if (!this.enableTypeDef || !(await dirExistsAsync(typeDefDir))) {
-      return []
-    }
-
-    const dest = join(this.outputDir, this.options.dts ?? 'index.d.ts')
-
-    let header = ''
-    let dts = ''
-    let exports: string[] = []
-
-    if (!this.options.noDtsHeader) {
-      const dtsHeader = this.options.dtsHeader ?? this.config.dtsHeader
-      // `dtsHeaderFile` in config > `dtsHeader` in cli flag > `dtsHeader` in config
-      if (this.config.dtsHeaderFile) {
-        try {
-          header = await readFileAsync(
-            join(this.options.cwd, this.config.dtsHeaderFile),
-            'utf-8',
-          )
-        } catch (e) {
-          debug.warn(
-            `Failed to read dts header file ${this.config.dtsHeaderFile}`,
-            e,
-          )
-        }
-      } else if (dtsHeader) {
-        header = dtsHeader
-      } else {
-        header = DEFAULT_TYPE_DEF_HEADER
-      }
-    }
-
-    const files = await readdirAsync(typeDefDir, { withFileTypes: true })
-
-    if (!files.length) {
-      debug('No type def files found. Skip generating dts file.')
+    if (!this.enableTypeDef) {
       return []
     }
 
-    for (const file of files) {
-      if (!file.isFile()) {
-        continue
-      }
-
-      const { dts: fileDts, exports: fileExports } = await processTypeDef(
-        join(typeDefDir, file.name),
-        this.options.constEnum ?? this.config.constEnum ?? true,
-      )
-
-      dts += fileDts
-      exports.push(...fileExports)
-    }
-
-    if (dts.indexOf('ExternalObject<') > -1) {
-      header += `
-export declare class ExternalObject<T> {
-  readonly '': {
-    readonly '': unique symbol
-    [K: symbol]: T
-  }
-}
-`
-    }
-
-    if (dts.indexOf('TypedArray') > -1) {
-      header += `
-export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array
-`
-    }
-
-    dts = header + dts
+    const exports = await generateTypeDef({
+      typeDefDir,
+      outputDir: this.outputDir,
+      dts: this.options.dts,
+      noDtsHeader: this.options.noDtsHeader,
+      dtsHeader: this.options.dtsHeader,
+      configDtsHeader: this.config.dtsHeader,
+      configDtsHeaderFile: this.config.dtsHeaderFile,
+      constEnum: this.options.constEnum ?? this.config.constEnum,
+      cwd: this.options.cwd,
+    })
 
-    try {
-      debug('Writing type def to:')
-      debug('  %i', dest)
-      await writeFileAsync(dest, dts, 'utf-8')
+    if (exports.length > 0) {
+      const dest = join(this.outputDir, this.options.dts ?? 'index.d.ts')
       this.outputs.push({ kind: 'dts', path: dest })
-    } catch (e) {
-      debug.error('Failed to write type def file')
-      debug.error(e as Error)
     }
 
     return exports
   }
 
   private async writeJsBinding(idents: string[]) {
-    if (
-      !this.options.platform ||
-      // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-      this.options.noJsBinding ||
-      idents.length === 0
-    ) {
-      return
-    }
-
-    const name = this.options.jsBinding ?? 'index.js'
-
-    const createBinding = this.options.esm ? createEsmBinding : createCjsBinding
-    const binding = createBinding(
-      this.config.binaryName,
-      this.config.packageName,
+    return writeJsBinding({
+      platform: this.options.platform,
+      noJsBinding: this.options.noJsBinding,
       idents,
-      // in npm preversion hook
-      process.env.npm_new_version ?? this.config.packageJson.version,
-    )
-
-    try {
-      const dest = join(this.outputDir, name)
-      debug('Writing js binding to:')
-      debug('  %i', dest)
-      await writeFileAsync(dest, binding, 'utf-8')
-      return { kind: 'js', path: dest } satisfies Output
-    } catch (e) {
-      throw new Error('Failed to write js binding file', { cause: e })
-    }
+      jsBinding: this.options.jsBinding,
+      esm: this.options.esm,
+      binaryName: this.config.binaryName,
+      packageName: this.config.packageName,
+      version: process.env.npm_new_version ?? this.config.packageJson.version,
+      outputDir: this.outputDir,
+    })
   }
 
   private async writeWasiBinding(
@@ -1074,3 +995,149 @@ export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array
     }
   }
 }
+
+export interface WriteJsBindingOptions {
+  platform?: boolean
+  noJsBinding?: boolean
+  idents: string[]
+  jsBinding?: string
+  esm?: boolean
+  binaryName: string
+  packageName: string
+  version: string
+  outputDir: string
+}
+
+export async function writeJsBinding(
+  options: WriteJsBindingOptions,
+): Promise<Output | undefined> {
+  if (
+    !options.platform ||
+    // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+    options.noJsBinding ||
+    options.idents.length === 0
+  ) {
+    return
+  }
+
+  const name = options.jsBinding ?? 'index.js'
+
+  const createBinding = options.esm ? createEsmBinding : createCjsBinding
+  const binding = createBinding(
+    options.binaryName,
+    options.packageName,
+    options.idents,
+    // in npm preversion hook
+    options.version,
+  )
+
+  try {
+    const dest = join(options.outputDir, name)
+    debug('Writing js binding to:')
+    debug('  %i', dest)
+    await writeFileAsync(dest, binding, 'utf-8')
+    return { kind: 'js', path: dest } satisfies Output
+  } catch (e) {
+    throw new Error('Failed to write js binding file', { cause: e })
+  }
+}
+
+export interface GenerateTypeDefOptions {
+  typeDefDir: string
+  outputDir: string
+  dts?: string
+  noDtsHeader?: boolean
+  dtsHeader?: string
+  dtsHeaderFile?: string
+  configDtsHeader?: string
+  configDtsHeaderFile?: string
+  constEnum?: boolean
+  cwd: string
+}
+
+export async function generateTypeDef(
+  options: GenerateTypeDefOptions,
+): Promise<string[]> {
+  if (!(await dirExistsAsync(options.typeDefDir))) {
+    return []
+  }
+
+  const dest = join(options.outputDir, options.dts ?? 'index.d.ts')
+
+  let header = ''
+  let dts = ''
+  let exports: string[] = []
+
+  if (!options.noDtsHeader) {
+    const dtsHeader = options.dtsHeader ?? options.configDtsHeader
+    // `dtsHeaderFile` in config > `dtsHeader` in cli flag > `dtsHeader` in config
+    if (options.configDtsHeaderFile) {
+      try {
+        header = await readFileAsync(
+          join(options.cwd, options.configDtsHeaderFile),
+          'utf-8',
+        )
+      } catch (e) {
+        debug.warn(
+          `Failed to read dts header file ${options.configDtsHeaderFile}`,
+          e,
+        )
+      }
+    } else if (dtsHeader) {
+      header = dtsHeader
+    } else {
+      header = DEFAULT_TYPE_DEF_HEADER
+    }
+  }
+
+  const files = await readdirAsync(options.typeDefDir, { withFileTypes: true })
+
+  if (!files.length) {
+    debug('No type def files found. Skip generating dts file.')
+    return []
+  }
+
+  for (const file of files) {
+    if (!file.isFile()) {
+      continue
+    }
+
+    const { dts: fileDts, exports: fileExports } = await processTypeDef(
+      join(options.typeDefDir, file.name),
+      options.constEnum ?? true,
+    )
+
+    dts += fileDts
+    exports.push(...fileExports)
+  }
+
+  if (dts.indexOf('ExternalObject<') > -1) {
+    header += `
+export declare class ExternalObject<T> {
+  readonly '': {
+    readonly '': unique symbol
+    [K: symbol]: T
+  }
+}
+`
+  }
+
+  if (dts.indexOf('TypedArray') > -1) {
+    header += `
+export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array
+`
+  }
+
+  dts = header + dts
+
+  try {
+    debug('Writing type def to:')
+    debug('  %i', dest)
+    await writeFileAsync(dest, dts, 'utf-8')
+  } catch (e) {
+    debug.error('Failed to write type def file')
+    debug.error(e as Error)
+  }
+
+  return exports
+}

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

@@ -4,7 +4,7 @@ import { parse } from 'semver'
 
 import {
   applyDefaultCreateNpmDirsOptions,
-  CreateNpmDirsOptions,
+  type CreateNpmDirsOptions,
 } from '../def/create-npm-dirs.js'
 import {
   debugFactory,
@@ -12,7 +12,7 @@ import {
   mkdirAsync as rawMkdirAsync,
   pick,
   writeFileAsync as rawWriteFileAsync,
-  Target,
+  type Target,
   type CommonPackageJsonFields,
 } from '../utils/index.js'
 

package/src/api/new.ts

@@ -8,7 +8,7 @@ import { load as yamlLoad, dump as yamlDump } from 'js-yaml'
 
 import {
   applyDefaultNewOptions,
-  NewOptions as RawNewOptions,
+  type NewOptions as RawNewOptions,
 } from '../def/new.js'
 import {
   AVAILABLE_TARGETS,
@@ -17,7 +17,7 @@ import {
   mkdirAsync,
   readdirAsync,
   statAsync,
-  SupportedPackageManager,
+  type SupportedPackageManager,
 } from '../utils/index.js'
 import { napiEngineRequirement } from '../utils/version.js'
 import { renameProject } from './rename.js'
@@ -169,6 +169,7 @@ async function filterTargetsInGithubActions(
 
   const macOSAndWindowsTargets = new Set([
     'x86_64-pc-windows-msvc',
+    'x86_64-pc-windows-gnu',
     'aarch64-pc-windows-msvc',
     'x86_64-apple-darwin',
   ])
@@ -468,4 +469,4 @@ function getBinaryName(name: string): string {
   return name.split('/').pop()!
 }
 
-export { NewOptions }
+export type { NewOptions }

package/src/api/pre-publish.ts

@@ -6,7 +6,7 @@ import { Octokit } from '@octokit/rest'
 
 import {
   applyDefaultPrePublishOptions,
-  PrePublishOptions,
+  type PrePublishOptions,
 } from '../def/pre-publish.js'
 import {
   readFileAsync,

package/src/api/rename.ts

@@ -5,9 +5,9 @@ import { resolve, join } from 'node:path'
 import { parse as parseToml, stringify as stringifyToml } from '@std/toml'
 import { load as yamlParse, dump as yamlStringify } from 'js-yaml'
 import { isNil, merge, omitBy, pick } from 'es-toolkit'
-import { findUp } from 'find-up'
+import * as find from 'empathic/find'
 
-import { applyDefaultRenameOptions, RenameOptions } from '../def/rename.js'
+import { applyDefaultRenameOptions, type RenameOptions } from '../def/rename.js'
 import { readConfig, readFileAsync, writeFileAsync } from '../utils/index.js'
 
 export async function renameProject(userOptions: RenameOptions) {
@@ -74,9 +74,8 @@ export async function renameProject(userOptions: RenameOptions) {
 
   await writeFileAsync(cargoTomlPath, updatedTomlContent)
   if (oldName !== options.binaryName) {
-    const githubActionsPath = await findUp('.github', {
+    const githubActionsPath = find.dir('.github', {
       cwd: options.cwd,
-      type: 'directory',
     })
     if (githubActionsPath) {
       const githubActionsCIYmlPath = join(

package/src/api/templates/js-binding.ts

@@ -146,7 +146,11 @@ function requireNative() {
     }
   } else if (process.platform === 'win32') {
     if (process.arch === 'x64') {
-      ${requireTuple('win32-x64-msvc')}
+      if (process.report?.getReport?.()?.header?.osName?.startsWith?.('MINGW')) {
+        ${requireTuple('win32-x64-gnu')}
+      } else {
+        ${requireTuple('win32-x64-msvc')}
+      }
     } else if (process.arch === 'ia32') {
       ${requireTuple('win32-ia32-msvc')}
     } else if (process.arch === 'arm64') {

package/src/api/universalize.ts

@@ -3,7 +3,7 @@ import { join, resolve } from 'node:path'
 
 import {
   applyDefaultUniversalizeOptions,
-  UniversalizeOptions,
+  type UniversalizeOptions,
 } from '../def/universalize.js'
 import { readNapiConfig } from '../utils/config.js'
 import { debugFactory } from '../utils/log.js'

package/src/api/version.ts

@@ -1,6 +1,9 @@
 import { join, resolve } from 'node:path'
 
-import { applyDefaultVersionOptions, VersionOptions } from '../def/version.js'
+import {
+  applyDefaultVersionOptions,
+  type VersionOptions,
+} from '../def/version.js'
 import {
   readNapiConfig,
   debugFactory,

package/src/cli.ts

@@ -1,31 +1,5 @@
 #!/usr/bin/env node
 
-import { Cli } from 'clipanion'
-
-import { ArtifactsCommand } from './commands/artifacts.js'
-import { BuildCommand } from './commands/build.js'
-import { CreateNpmDirsCommand } from './commands/create-npm-dirs.js'
-import { HelpCommand } from './commands/help.js'
-import { NewCommand } from './commands/new.js'
-import { PrePublishCommand } from './commands/pre-publish.js'
-import { RenameCommand } from './commands/rename.js'
-import { UniversalizeCommand } from './commands/universalize.js'
-import { VersionCommand } from './commands/version.js'
-import { CLI_VERSION } from './utils/misc.js'
-
-const cli = new Cli({
-  binaryName: 'napi',
-  binaryVersion: CLI_VERSION,
-})
-
-cli.register(NewCommand)
-cli.register(BuildCommand)
-cli.register(CreateNpmDirsCommand)
-cli.register(ArtifactsCommand)
-cli.register(UniversalizeCommand)
-cli.register(RenameCommand)
-cli.register(PrePublishCommand)
-cli.register(VersionCommand)
-cli.register(HelpCommand)
+import { cli } from './index.js'
 
 void cli.runExit(process.argv.slice(2))

package/src/commands/new.ts

@@ -9,7 +9,7 @@ import {
   AVAILABLE_TARGETS,
   debugFactory,
   DEFAULT_TARGETS,
-  TargetTriple,
+  type TargetTriple,
 } from '../utils/index.js'
 import { napiEngineRequirement } from '../utils/version.js'
 

package/src/index.ts

@@ -1,3 +1,5 @@
+import { Cli } from 'clipanion'
+
 import { collectArtifacts } from './api/artifacts.js'
 import { buildProject } from './api/build.js'
 import { createNpmDirs } from './api/create-npm-dirs.js'
@@ -6,6 +8,31 @@ import { prePublish } from './api/pre-publish.js'
 import { renameProject } from './api/rename.js'
 import { universalizeBinaries } from './api/universalize.js'
 import { version } from './api/version.js'
+import { ArtifactsCommand } from './commands/artifacts.js'
+import { BuildCommand } from './commands/build.js'
+import { CreateNpmDirsCommand } from './commands/create-npm-dirs.js'
+import { HelpCommand } from './commands/help.js'
+import { NewCommand } from './commands/new.js'
+import { PrePublishCommand } from './commands/pre-publish.js'
+import { RenameCommand } from './commands/rename.js'
+import { UniversalizeCommand } from './commands/universalize.js'
+import { VersionCommand } from './commands/version.js'
+import { CLI_VERSION } from './utils/misc.js'
+
+export const cli = new Cli({
+  binaryName: 'napi',
+  binaryVersion: CLI_VERSION,
+})
+
+cli.register(NewCommand)
+cli.register(BuildCommand)
+cli.register(CreateNpmDirsCommand)
+cli.register(ArtifactsCommand)
+cli.register(UniversalizeCommand)
+cli.register(RenameCommand)
+cli.register(PrePublishCommand)
+cli.register(VersionCommand)
+cli.register(HelpCommand)
 
 /**
  *
@@ -31,3 +58,9 @@ export class NapiCli {
 }
 
 export { parseTriple } from './utils/target.js'
+export {
+  type GenerateTypeDefOptions,
+  type WriteJsBindingOptions,
+  writeJsBinding,
+  generateTypeDef,
+} from './api/build.js'

package/src/utils/config.ts

@@ -2,7 +2,7 @@ import { underline, yellow } from 'colorette'
 import { merge, omit } from 'es-toolkit'
 
 import { fileExists, readFileAsync } from './misc.js'
-import { DEFAULT_TARGETS, parseTriple, Target } from './target.js'
+import { DEFAULT_TARGETS, parseTriple, type Target } from './target.js'
 
 export type ValueOfConstArray<T> = T[Exclude<keyof T, keyof Array<any>>]
 

package/src/utils/target.ts

@@ -17,6 +17,7 @@ export const AVAILABLE_TARGETS = [
   'aarch64-pc-windows-msvc',
   'x86_64-apple-darwin',
   'x86_64-pc-windows-msvc',
+  'x86_64-pc-windows-gnu',
   'x86_64-unknown-linux-gnu',
   'x86_64-unknown-linux-musl',
   'x86_64-unknown-linux-ohos',