@napi-rs/cli 3.0.0-alpha.1 → 3.0.0-alpha.100

package/src/utils/__tests__/__snapshots__/version.spec.ts.md

@@ -9,12 +9,13 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     [
-      '>= 8.6.0',
-      '>= 8.10.0 && < 9 || >= 9.3.0',
-      '>= 6.14.2 && < 7 || >= 8.11.2 && < 9 || >= 9.11.0',
-      '>= 10.16.0 && < 11 || >= 11.8.0',
-      '>= 10.17.0 && < 11 || >= 12.11.0',
-      '>= 10.20.0 && < 11 || >= 12.17.0 && < 13 || >= 14.0.0',
-      '>= 10.23.0 && < 11 || >= 12.19.0 && < 13 || >= 14.12.0',
-      '>= 12.22.0 && < 13 || >= 14.17.0 && < 15 || >= 15.12.0',
+      '>= 8.6.0 < 9 || >= 9.0.0 < 10 || >= 10.0.0',
+      '>= 8.10.0 < 9 || >= 9.3.0 < 10 || >= 10.0.0',
+      '>= 6.14.2 < 7 || >= 8.11.2 < 9 || >= 9.11.0 < 10 || >= 10.0.0',
+      '>= 10.16.0 < 11 || >= 11.8.0 < 12 || >= 12.0.0',
+      '>= 10.17.0 < 11 || >= 12.11.0 < 13 || >= 13.0.0',
+      '>= 10.20.0 < 11 || >= 12.17.0 < 13 || >= 14.0.0',
+      '>= 10.23.0 < 11 || >= 12.19.0 < 13 || >= 14.12.0 < 15 || >= 15.0.0',
+      '>= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0',
+      '>= 18.17.0 < 19 || >= 20.3.0 < 21 || >= 21.1.0',
     ]

package/src/utils/__tests__/config.spec.ts

@@ -0,0 +1,81 @@
+import { unlink, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import ava, { TestFn } from 'ava'
+
+import {
+  CommonPackageJsonFields,
+  UserNapiConfig,
+  readNapiConfig,
+} from '../config.js'
+
+const NON_EXISTENT_FILE = 'non-existent-file'
+
+const test = ava as TestFn<{
+  configPath: string
+  packageJson: string
+  pkgJson: CommonPackageJsonFields
+  config: UserNapiConfig
+}>
+
+test.before(async (t) => {
+  const tmp = tmpdir()
+  const configPath = join(tmp, 'napi.json')
+  const packageJson = join(tmp, 'package.json')
+  const pkgJson = {
+    name: '@napi-rs/testing',
+    version: '0.0.0',
+    napi: {
+      binaryName: 'testing',
+      packageName: '@napi-rs/testing',
+      targets: [
+        'x86_64-unknown-linux-gnu',
+        'x86_64-pc-windows-msvc',
+        'x86_64-apple-darwin',
+      ],
+    },
+  }
+  await writeFile(packageJson, JSON.stringify(pkgJson, null, 2))
+  const config = {
+    binaryName: 'testing',
+    packageName: '@node-rs/testing',
+    targets: [
+      'x86_64-unknown-linux-gnu',
+      'x86_64-apple-darwin',
+      'aarch64-apple-darwin',
+    ],
+  }
+  await writeFile(configPath, JSON.stringify(config, null, 2))
+  t.context = { configPath, config, packageJson, pkgJson }
+})
+
+test.after(async (t) => {
+  await unlink(t.context.configPath)
+  await unlink(t.context.packageJson)
+})
+
+test('should throw if package.json not found', async (t) => {
+  await t.throwsAsync(() => readNapiConfig(NON_EXISTENT_FILE), {
+    message: `package.json not found at ${NON_EXISTENT_FILE}`,
+  })
+})
+
+test('should throw if napi.json not found', async (t) => {
+  const { packageJson } = t.context
+  await t.throwsAsync(() => readNapiConfig(packageJson, NON_EXISTENT_FILE), {
+    message: `NAPI-RS config not found at ${NON_EXISTENT_FILE}`,
+  })
+})
+
+test('should be able to read config from package.json', async (t) => {
+  const { packageJson } = t.context
+  const config = await readNapiConfig(packageJson)
+  t.snapshot(config)
+})
+
+test('should be able to read config from napi.json', async (t) => {
+  const { packageJson, configPath } = t.context
+  const config = await readNapiConfig(packageJson, configPath)
+  t.snapshot(config)
+})

package/src/utils/__tests__/typegen.spec.ts

@@ -18,13 +18,13 @@ test('should ident string correctly', (t) => {
     foo() {
       a = b
     }
-  
+
   bar = () => {
-  
+
   }
       boz = 1
     }
-  
+
   namespace B {
       namespace C {
   type D = A
@@ -36,13 +36,28 @@ test('should ident string correctly', (t) => {
 })
 
 test('should process type def correctly', async (t) => {
-  const dts = await processTypeDef(
+  const { dts } = await processTypeDef(
+    join(
+      fileURLToPath(import.meta.url),
+      '../',
+      '__fixtures__',
+      'napi_type_def',
+    ),
+    true,
+  )
+
+  t.snapshot(dts)
+})
+
+test('should process type def with noConstEnum correctly', async (t) => {
+  const { dts } = await processTypeDef(
     join(
       fileURLToPath(import.meta.url),
       '../',
       '__fixtures__',
       'napi_type_def',
     ),
+    false,
   )
 
   t.snapshot(dts)

package/src/utils/cargo.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { debug } from './log.js'
 
@@ -28,7 +28,7 @@ function detectCargoBinary(bin: string) {
     })
     debug('Cargo binary detected: %s', bin)
     return true
-  } catch (e) {
+  } catch {
     debug('Cargo binary not detected: %s', bin)
     return false
   }

package/src/utils/config.ts

@@ -1,9 +1,22 @@
+import { underline, yellow } from 'colorette'
 import { merge, omit } from 'lodash-es'
 
 import { fileExists, readFileAsync } from './misc.js'
 import { DEFAULT_TARGETS, parseTriple, Target } from './target.js'
 
-interface UserNapiConfig {
+export type ValueOfConstArray<T> = T[Exclude<keyof T, keyof Array<any>>]
+
+export const SupportedPackageManagers = ['yarn', 'pnpm'] as const
+export const SupportedTestFrameworks = ['ava'] as const
+
+export type SupportedPackageManager = ValueOfConstArray<
+  typeof SupportedPackageManagers
+>
+export type SupportedTestFramework = ValueOfConstArray<
+  typeof SupportedTestFrameworks
+>
+
+export interface UserNapiConfig {
   /**
    * Name of the binary to be generated, default to `index`
    */
@@ -24,6 +37,55 @@ interface UserNapiConfig {
    */
   npmClient?: string
 
+  /**
+   * Whether generate const enum for typescript bindings
+   */
+  constEnum?: boolean
+
+  /**
+   * dts header prepend to the generated dts file
+   */
+  dtsHeader?: string
+
+  /**
+   * dts header file path to be prepended to the generated dts file
+   * if both dtsHeader and dtsHeaderFile are provided, dtsHeaderFile will be used
+   */
+  dtsHeaderFile?: string
+
+  /**
+   * wasm compilation options
+   */
+  wasm?: {
+    /**
+     * https://developer.mozilla.org/en-US/docs/WebAssembly/JavaScript_interface/Memory
+     * @default 4000 pages (256MiB)
+     */
+    initialMemory?: number
+    /**
+     * @default 65536 pages (4GiB)
+     */
+    maximumMemory?: number
+
+    /**
+     * Browser wasm binding configuration
+     */
+    browser: {
+      /**
+       * Whether to use fs module in browser
+       */
+      fs?: boolean
+      /**
+       * Whether to initialize wasm asynchronously
+       */
+      asyncInit?: boolean
+      /**
+       * Whether to inject `buffer` to emnapi context
+       */
+      buffer?: boolean
+    }
+  }
+
   /**
    * @deprecated binaryName instead
    */
@@ -41,7 +103,7 @@ interface UserNapiConfig {
     /**
      * Whether enable default targets
      */
-    default: boolean
+    defaults: boolean
     /**
      * Additional targets to be compiled for
      */
@@ -49,7 +111,7 @@ interface UserNapiConfig {
   }
 }
 
-interface CommonPackageJsonFields {
+export interface CommonPackageJsonFields {
   name: string
   version: string
   description?: string
@@ -57,6 +119,10 @@ interface CommonPackageJsonFields {
   author?: string
   authors?: string[]
   license?: string
+  cpu?: string[]
+  os?: string[]
+  libc?: string[]
+  files?: string[]
   repository?: any
   homepage?: any
   engines?: Record<string, string>
@@ -64,18 +130,41 @@ interface CommonPackageJsonFields {
   bugs?: any
   // eslint-disable-next-line no-use-before-define
   napi?: UserNapiConfig
+  type?: 'module' | 'commonjs'
+  scripts?: Record<string, string>
+
+  // modules
+  main?: string
+  module?: string
+  types?: string
+  browser?: string
+  exports?: any
+
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+
+  ava?: {
+    timeout?: string
+  }
 }
 
 export type NapiConfig = Required<
   Pick<UserNapiConfig, 'binaryName' | 'packageName' | 'npmClient'>
-> & {
-  targets: Target[]
-  packageJson: CommonPackageJsonFields
-}
+> &
+  Pick<UserNapiConfig, 'wasm' | 'dtsHeader' | 'dtsHeaderFile' | 'constEnum'> & {
+    targets: Target[]
+    packageJson: CommonPackageJsonFields
+  }
 
-export async function readNapiConfig(path: string): Promise<NapiConfig> {
+export async function readNapiConfig(
+  path: string,
+  configPath?: string,
+): Promise<NapiConfig> {
+  if (configPath && !(await fileExists(configPath))) {
+    throw new Error(`NAPI-RS config not found at ${configPath}`)
+  }
   if (!(await fileExists(path))) {
-    throw new Error(`napi-rs config not found at ${path}`)
+    throw new Error(`package.json not found at ${path}`)
   }
   // May support multiple config sources later on.
   const content = await readFileAsync(path, 'utf8')
@@ -83,12 +172,34 @@ export async function readNapiConfig(path: string): Promise<NapiConfig> {
   try {
     pkgJson = JSON.parse(content) as CommonPackageJsonFields
   } catch (e) {
-    throw new Error('Failed to parse napi-rs config', {
+    throw new Error(`Failed to parse package.json at ${path}`, {
       cause: e,
     })
   }
 
+  let separatedConfig: UserNapiConfig | undefined
+  if (configPath) {
+    const configContent = await readFileAsync(configPath, 'utf8')
+    try {
+      separatedConfig = JSON.parse(configContent) as UserNapiConfig
+    } catch (e) {
+      throw new Error(`Failed to parse NAPI-RS config at ${configPath}`, {
+        cause: e,
+      })
+    }
+  }
+
   const userNapiConfig = pkgJson.napi ?? {}
+  if (pkgJson.napi && separatedConfig) {
+    const pkgJsonPath = underline(path)
+    const configPathUnderline = underline(configPath!)
+    console.warn(
+      yellow(
+        `Both napi field in ${pkgJsonPath} and [NAPI-RS config](${configPathUnderline}) file are found, the NAPI-RS config file will be used.`,
+      ),
+    )
+    Object.assign(userNapiConfig, separatedConfig)
+  }
   const napiConfig: NapiConfig = merge(
     {
       binaryName: 'index',
@@ -103,20 +214,43 @@ export async function readNapiConfig(path: string): Promise<NapiConfig> {
   let targets: string[] = userNapiConfig.targets ?? []
 
   // compatible with old config
-  if (userNapiConfig.package?.name) {
-    napiConfig.packageName = userNapiConfig.package.name
+  if (userNapiConfig?.name) {
+    console.warn(
+      yellow(
+        `[DEPRECATED] napi.name is deprecated, use napi.binaryName instead.`,
+      ),
+    )
+    napiConfig.binaryName = userNapiConfig.name
   }
 
   if (!targets.length) {
-    if (userNapiConfig.triples?.default) {
+    let deprecatedWarned = false
+    const warning = yellow(
+      `[DEPRECATED] napi.triples is deprecated, use napi.targets instead.`,
+    )
+    if (userNapiConfig.triples?.defaults) {
+      deprecatedWarned = true
+      console.warn(warning)
       targets = targets.concat(DEFAULT_TARGETS)
     }
 
     if (userNapiConfig.triples?.additional?.length) {
       targets = targets.concat(userNapiConfig.triples.additional)
+      if (!deprecatedWarned) {
+        console.warn(warning)
+      }
     }
   }
 
+  // find duplicate targets
+  const uniqueTargets = new Set(targets)
+  if (uniqueTargets.size !== targets.length) {
+    const duplicateTarget = targets.find(
+      (target, index) => targets.indexOf(target) !== index,
+    )
+    throw new Error(`Duplicate targets are not allowed: ${duplicateTarget}`)
+  }
+
   napiConfig.targets = targets.map(parseTriple)
 
   return napiConfig

package/src/utils/index.ts

@@ -1,4 +1,3 @@
-export * from './ci.js'
 export * from './log.js'
 export * from './misc.js'
 export * from './target.js'
@@ -7,3 +6,4 @@ export * from './metadata.js'
 export * from './config.js'
 export * from './cargo.js'
 export * from './typegen.js'
+export * from './read-config.js'

package/src/utils/log.ts

@@ -25,7 +25,7 @@ export const debugFactory = (namespace: string) => {
     console.error(
       colors.white(colors.bgRed(' ERROR ')),
       ...args.map((arg) =>
-        arg instanceof Error ? arg.stack ?? arg.message : arg,
+        arg instanceof Error ? (arg.stack ?? arg.message) : arg,
       ),
     )
 

package/src/utils/metadata.ts

@@ -1,5 +1,5 @@
-import { execSync } from 'child_process'
-import fs from 'fs'
+import { spawn } from 'node:child_process'
+import fs from 'node:fs'
 
 export type CrateTargetKind =
   | 'bin'
@@ -26,6 +26,18 @@ export interface Crate {
   targets: CrateTarget[]
   features: Record<string, string[]>
   manifest_path: string
+  dependencies: Array<{
+    name: string
+    source: string
+    req: string
+    kind: string | null
+    rename: string | null
+    optional: boolean
+    uses_default_features: boolean
+    features: string[]
+    target: string | null
+    registry: string | null
+  }>
 }
 
 export interface CargoWorkspaceMetadata {
@@ -36,24 +48,50 @@ export interface CargoWorkspaceMetadata {
   workspace_root: string
 }
 
-export function parseMetadata(manifestPath: string) {
+export async function parseMetadata(manifestPath: string) {
   if (!fs.existsSync(manifestPath)) {
     throw new Error(`No crate found in manifest: ${manifestPath}`)
   }
 
-  const cmd = `cargo metadata --manifest-path ${manifestPath} --format-version 1 --no-deps`
+  const childProcess = spawn(
+    'cargo',
+    ['metadata', '--manifest-path', manifestPath, '--format-version', '1'],
+    { stdio: 'pipe' },
+  )
 
-  try {
-    const output = execSync(cmd, {
-      encoding: 'utf-8',
+  let stdout = ''
+  let stderr = ''
+  let status = 0
+  let error = null
+
+  childProcess.stdout.on('data', (data) => {
+    stdout += data
+  })
+
+  childProcess.stderr.on('data', (data) => {
+    stderr += data
+  })
+
+  await new Promise<void>((resolve) => {
+    childProcess.on('close', (code) => {
+      status = code ?? 0
+      resolve()
+    })
+  })
+
+  if (error) {
+    throw new Error('cargo metadata failed to run', { cause: error })
+  }
+  if (status !== 0) {
+    const simpleMessage = `cargo metadata exited with code ${status}`
+    throw new Error(`${simpleMessage} and error message:\n\n${stderr}`, {
+      cause: new Error(simpleMessage),
     })
-    return JSON.parse(output) as CargoWorkspaceMetadata
+  }
+
+  try {
+    return JSON.parse(stdout) as CargoWorkspaceMetadata
   } catch (e) {
-    throw new Error(
-      `Failed to parse cargo metadata output by command: ${cmd}`,
-      {
-        cause: e,
-      },
-    )
+    throw new Error('Failed to parse cargo metadata JSON', { cause: e })
   }
 }

package/src/utils/misc.ts

@@ -1,12 +1,17 @@
-import { readFile, writeFile, copyFile, mkdir, unlink, stat, readdir } from 'fs'
-import { createRequire } from 'module'
-import { promisify } from 'util'
+import {
+  readFile,
+  writeFile,
+  copyFile,
+  mkdir,
+  unlink,
+  stat,
+  readdir,
+} from 'node:fs'
+import { promisify } from 'node:util'
 
+import pkgJson from '../../package.json' with { type: 'json' }
 import { debug } from './log.js'
 
-const require = createRequire(import.meta.url)
-const pkgJson = require('../../package.json')
-
 export const readFileAsync = promisify(readFile)
 export const writeFileAsync = promisify(writeFile)
 export const unlinkAsync = promisify(unlink)
@@ -22,6 +27,15 @@ export async function fileExists(path: string) {
   return exists
 }
 
+export async function dirExistsAsync(path: string) {
+  try {
+    const stats = await statAsync(path)
+    return stats.isDirectory()
+  } catch {
+    return false
+  }
+}
+
 export function pick<O, K extends keyof O>(o: O, ...keys: K[]): Pick<O, K> {
   return keys.reduce((acc, key) => {
     acc[key] = o[key]
@@ -38,7 +52,7 @@ export async function updatePackageJson(
     debug(`File not exists ${path}`)
     return
   }
-  const old = require(path)
+  const old = JSON.parse(await readFileAsync(path, 'utf8'))
   await writeFileAsync(path, JSON.stringify({ ...old, ...partial }, null, 2))
 }
 

package/src/utils/read-config.ts

@@ -0,0 +1,20 @@
+import { resolve } from 'node:path'
+
+import { readNapiConfig } from './config.js'
+
+interface MinimalNapiOptions {
+  cwd: string
+  configPath?: string
+  packageJsonPath?: string
+}
+
+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',
+    ),
+    options.configPath ? resolvePath(options.configPath) : undefined,
+  )
+  return config
+}