@napi-rs/cli 3.0.0-alpha.17 → 3.0.0-alpha.19

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

@@ -1,9 +1,10 @@
+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 interface UserNapiConfig {
   /**
    * Name of the binary to be generated, default to `index`
    */
@@ -89,9 +90,15 @@ export type NapiConfig = Required<
   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')
@@ -99,12 +106,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',
@@ -120,16 +149,26 @@ export async function readNapiConfig(path: string): Promise<NapiConfig> {
 
   // compatible with old config
   if (userNapiConfig?.name) {
+    console.warn(
+      `[DEPRECATED] napi.name is deprecated, use napi.binaryName instead.`,
+    )
     napiConfig.binaryName = userNapiConfig.name
   }
 
   if (!targets.length) {
+    let deprecatedWarned = false
+    const warning = `[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)
+      }
     }
   }
 

package/src/utils/version.ts

@@ -7,20 +7,22 @@ export enum NapiVersion {
   Napi6,
   Napi7,
   Napi8,
+  Napi9,
 }
 
 /// because node support new napi version in some minor version updates, so we might meet such situation:
 /// `node v10.20.0` supports `napi5` and `napi6`, but `node v12.0.0` only support `napi4`,
-/// by which, we can not tell directly napi version supportness from node version directly.
+/// by which, we can not tell directly napi version supportless from node version directly.
 const NAPI_VERSION_MATRIX = new Map<NapiVersion, string>([
-  [NapiVersion.Napi1, '8.6.0'],
-  [NapiVersion.Napi2, '8.10.0 | 9.3.0'],
-  [NapiVersion.Napi3, '6.14.2 | 8.11.2 | 9.11.0'],
-  [NapiVersion.Napi4, '10.16.0 | 11.8.0'],
-  [NapiVersion.Napi5, '10.17.0 | 12.11.0'],
+  [NapiVersion.Napi1, '8.6.0 | 9.0.0 | 10.0.0'],
+  [NapiVersion.Napi2, '8.10.0 | 9.3.0 | 10.0.0'],
+  [NapiVersion.Napi3, '6.14.2 | 8.11.2 | 9.11.0 | 10.0.0'],
+  [NapiVersion.Napi4, '10.16.0 | 11.8.0 | 12.0.0'],
+  [NapiVersion.Napi5, '10.17.0 | 12.11.0 | 13.0.0'],
   [NapiVersion.Napi6, '10.20.0 | 12.17.0 | 14.0.0'],
-  [NapiVersion.Napi7, '10.23.0 | 12.19.0 | 14.12.0'],
-  [NapiVersion.Napi8, '12.22.0 | 14.17.0 | 15.12.0'],
+  [NapiVersion.Napi7, '10.23.0 | 12.19.0 | 14.12.0 | 15.0.0'],
+  [NapiVersion.Napi8, '12.22.0 | 14.17.0 | 15.12.0 | 16.0.0'],
+  [NapiVersion.Napi9, '18.17.0 | 20.3.0 | 21.1.0'],
 ])
 
 interface NodeVersion {