@napi-rs/cli 3.1.5 → 3.3.0

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'
 
@@ -76,6 +76,7 @@ export class NewCommand extends BaseNewCommand {
     return select({
       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,

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/misc.ts

@@ -1,30 +1,30 @@
 import {
   readFile,
   writeFile,
+  unlink,
   copyFile,
   mkdir,
-  unlink,
   stat,
   readdir,
-} from 'node:fs'
-import { promisify } from 'node:util'
+  access,
+} from 'node:fs/promises'
 
 import pkgJson from '../../package.json' with { type: 'json' }
 import { debug } from './log.js'
 
-export const readFileAsync = promisify(readFile)
-export const writeFileAsync = promisify(writeFile)
-export const unlinkAsync = promisify(unlink)
-export const copyFileAsync = promisify(copyFile)
-export const mkdirAsync = promisify(mkdir)
-export const statAsync = promisify(stat)
-export const readdirAsync = promisify(readdir)
+export const readFileAsync = readFile
+export const writeFileAsync = writeFile
+export const unlinkAsync = unlink
+export const copyFileAsync = copyFile
+export const mkdirAsync = mkdir
+export const statAsync = stat
+export const readdirAsync = readdir
 
-export async function fileExists(path: string) {
-  const exists = await statAsync(path)
-    .then(() => true)
-    .catch(() => false)
-  return exists
+export function fileExists(path: string): Promise<boolean> {
+  return access(path).then(
+    () => true,
+    () => false,
+  )
 }
 
 export async function dirExistsAsync(path: string) {

package/src/utils/read-config.ts

@@ -11,9 +11,7 @@ interface MinimalNapiOptions {
 export async function readConfig(options: MinimalNapiOptions) {
   const resolvePath = (...paths: string[]) => resolve(options.cwd, ...paths)
   const config = await readNapiConfig(
-    resolvePath(
-      options.configPath ?? options.packageJsonPath ?? 'package.json',
-    ),
+    resolvePath(options.packageJsonPath ?? 'package.json'),
     options.configPath ? resolvePath(options.configPath) : undefined,
   )
   return config

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',
@@ -26,6 +27,7 @@ export const AVAILABLE_TARGETS = [
   'armv7-unknown-linux-musleabihf',
   'armv7-linux-androideabi',
   'universal-apple-darwin',
+  'loongarch64-unknown-linux-gnu',
   'riscv64gc-unknown-linux-gnu',
   'powerpc64le-unknown-linux-gnu',
   's390x-unknown-linux-gnu',
@@ -44,6 +46,8 @@ export const DEFAULT_TARGETS = [
 
 export const TARGET_LINKER: Record<string, string> = {
   'aarch64-unknown-linux-musl': 'aarch64-linux-musl-gcc',
+  // TODO: Switch to loongarch64-linux-gnu-gcc when available
+  'loongarch64-unknown-linux-gnu': 'loongarch64-linux-gnu-gcc-13',
   'riscv64gc-unknown-linux-gnu': 'riscv64-linux-gnu-gcc',
   'powerpc64le-unknown-linux-gnu': 'powerpc64le-linux-gnu-gcc',
   's390x-unknown-linux-gnu': 's390x-linux-gnu-gcc',
@@ -54,6 +58,7 @@ type NodeJSArch =
   | 'arm'
   | 'arm64'
   | 'ia32'
+  | 'loong64'
   | 'mips'
   | 'mipsel'
   | 'ppc'
@@ -71,6 +76,7 @@ const CpuToNodeArch: Record<string, NodeJSArch> = {
   aarch64: 'arm64',
   i686: 'ia32',
   armv7: 'arm',
+  loongarch64: 'loong64',
   riscv64gc: 'riscv64',
   powerpc64le: 'ppc64',
 }
@@ -80,6 +86,7 @@ export const NodeArchToCpu: Record<string, string> = {
   arm64: 'aarch64',
   ia32: 'i686',
   arm: 'armv7',
+  loong64: 'loongarch64',
   riscv64: 'riscv64gc',
   ppc64: 'powerpc64le',
 }

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

@@ -1,210 +0,0 @@
-import { existsSync } from 'node:fs'
-import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
-import { tmpdir } from 'node:os'
-import { join } from 'node:path'
-
-import ava, { TestFn } from 'ava'
-
-import { createNpmDirs } from '../create-npm-dirs.js'
-
-const test = ava as TestFn<{
-  tmpDir: string
-  packageJsonPath: string
-}>
-
-test.beforeEach(async (t) => {
-  // Create a unique temp directory for tests
-  const timestamp = Date.now()
-  const random = Math.random().toString(36).substring(7)
-  const tmpDir = join(
-    tmpdir(),
-    'napi-rs-test',
-    `create-npm-dirs-${timestamp}-${random}`,
-  )
-  const packageJsonPath = join(tmpDir, 'package.json')
-
-  // Create the directory
-  await mkdir(tmpDir, { recursive: true })
-
-  t.context = { tmpDir, packageJsonPath }
-})
-
-test.afterEach.always(async (t) => {
-  // Clean up any created directories
-  if (existsSync(t.context.tmpDir)) {
-    await rm(t.context.tmpDir, { recursive: true, force: true })
-  }
-})
-
-test('should omit exports fields from publishConfig in scoped packages', async (t) => {
-  const { tmpDir, packageJsonPath } = t.context
-
-  // Create a package.json with publishConfig that includes exports field
-  const packageJson = {
-    name: 'test-package',
-    version: '1.0.0',
-    publishConfig: {
-      registry: 'https://custom-registry.com',
-      access: 'public',
-      exports: {
-        '.': './dist/index.js',
-        './package.json': './package.json',
-      },
-      tag: 'beta',
-    },
-    napi: {
-      binaryName: 'test-package',
-      targets: ['x86_64-unknown-linux-gnu'],
-    },
-  }
-
-  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
-
-  await createNpmDirs({
-    cwd: tmpDir,
-    packageJsonPath: 'package.json',
-  })
-
-  // Check that the scoped package directory was created
-  const scopedDir = join(tmpDir, 'npm', 'linux-x64-gnu')
-  t.true(existsSync(scopedDir))
-
-  // Read the generated package.json for the scoped package
-  const scopedPackageJsonPath = join(scopedDir, 'package.json')
-  t.true(existsSync(scopedPackageJsonPath))
-
-  const scopedPackageJson = JSON.parse(
-    await readFile(scopedPackageJsonPath, 'utf-8'),
-  )
-
-  // Verify that publishConfig only contains registry and access, not exports
-  t.truthy(scopedPackageJson.publishConfig)
-  t.is(scopedPackageJson.publishConfig.registry, 'https://custom-registry.com')
-  t.is(scopedPackageJson.publishConfig.access, 'public')
-  t.is(scopedPackageJson.publishConfig.exports, undefined)
-  t.is(scopedPackageJson.publishConfig.tag, undefined)
-})
-
-test('should handle package without publishConfig', async (t) => {
-  const { tmpDir, packageJsonPath } = t.context
-
-  // Create a package.json without publishConfig
-  const packageJson = {
-    name: 'test-package-no-config',
-    version: '1.0.0',
-    napi: {
-      binaryName: 'test-package-no-config',
-      targets: ['x86_64-unknown-linux-gnu'],
-    },
-  }
-
-  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
-
-  await createNpmDirs({
-    cwd: tmpDir,
-    packageJsonPath: 'package.json',
-  })
-
-  // Check that the scoped package directory was created
-  const scopedDir = join(tmpDir, 'npm', 'linux-x64-gnu')
-  t.true(existsSync(scopedDir))
-
-  // Read the generated package.json for the scoped package
-  const scopedPackageJsonPath = join(scopedDir, 'package.json')
-  const scopedPackageJson = JSON.parse(
-    await readFile(scopedPackageJsonPath, 'utf-8'),
-  )
-
-  // Verify that publishConfig is not present when not in source
-  t.is(scopedPackageJson.publishConfig, undefined)
-})
-
-test('should preserve only registry and access in publishConfig', async (t) => {
-  const { tmpDir, packageJsonPath } = t.context
-
-  // Create a package.json with minimal publishConfig
-  const packageJson = {
-    name: 'test-package-minimal',
-    version: '1.0.0',
-    publishConfig: {
-      registry: 'https://npm.company.com',
-      access: 'restricted',
-    },
-    napi: {
-      binaryName: 'test-package-minimal',
-      targets: ['aarch64-apple-darwin'],
-    },
-  }
-
-  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
-
-  await createNpmDirs({
-    cwd: tmpDir,
-    packageJsonPath: 'package.json',
-  })
-
-  // Check that the scoped package directory was created
-  const scopedDir = join(tmpDir, 'npm', 'darwin-arm64')
-  t.true(existsSync(scopedDir))
-
-  // Read the generated package.json for the scoped package
-  const scopedPackageJsonPath = join(scopedDir, 'package.json')
-  const scopedPackageJson = JSON.parse(
-    await readFile(scopedPackageJsonPath, 'utf-8'),
-  )
-
-  // Verify that publishConfig contains exactly registry and access
-  t.truthy(scopedPackageJson.publishConfig)
-  t.is(scopedPackageJson.publishConfig.registry, 'https://npm.company.com')
-  t.is(scopedPackageJson.publishConfig.access, 'restricted')
-  t.is(Object.keys(scopedPackageJson.publishConfig).length, 2)
-})
-
-test('should handle WASM targets correctly with publishConfig', async (t) => {
-  const { tmpDir, packageJsonPath } = t.context
-
-  // Create a package.json for WASM target
-  const packageJson = {
-    name: 'test-wasm-package',
-    version: '1.0.0',
-    publishConfig: {
-      registry: 'https://wasm-registry.com',
-      access: 'public',
-      exports: './wasm.js',
-      browser: './browser.js',
-    },
-    napi: {
-      binaryName: 'test-wasm-package',
-      targets: ['wasm32-wasi-preview1-threads'],
-    },
-  }
-
-  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
-
-  await createNpmDirs({
-    cwd: tmpDir,
-    packageJsonPath: 'package.json',
-  })
-
-  // Check that the scoped package directory was created
-  const scopedDir = join(tmpDir, 'npm', 'wasm32-wasi')
-  t.true(existsSync(scopedDir))
-
-  // Read the generated package.json for the scoped package
-  const scopedPackageJsonPath = join(scopedDir, 'package.json')
-  const scopedPackageJson = JSON.parse(
-    await readFile(scopedPackageJsonPath, 'utf-8'),
-  )
-
-  // Verify that publishConfig is correctly filtered for WASM too
-  t.truthy(scopedPackageJson.publishConfig)
-  t.is(scopedPackageJson.publishConfig.registry, 'https://wasm-registry.com')
-  t.is(scopedPackageJson.publishConfig.access, 'public')
-  t.is(scopedPackageJson.publishConfig.exports, undefined)
-  t.is(scopedPackageJson.publishConfig.browser, undefined)
-
-  // Verify WASM-specific fields are set correctly
-  t.truthy(scopedPackageJson.main)
-  t.truthy(scopedPackageJson.browser)
-  t.truthy(scopedPackageJson.dependencies)
-})