@napi-rs/cli 3.0.0-alpha.3 → 3.0.0-alpha.31

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'
 

package/src/utils/ci.ts

@@ -99,4 +99,13 @@ export const CIConfig: Partial<
     ],
     test: false,
   },
+  'riscv64gc-unknown-linux-gnu': {
+    host: 'ubuntu-latest',
+    build_setup: [
+      'sudo apt-get update',
+      'sudo apt-get install g++-riscv64-linux-gnu gcc-riscv64-linux-gnu -y',
+    ],
+    // No official nodejs docker image for riscv64
+    test: 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'] 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,11 @@ interface UserNapiConfig {
    */
   npmClient?: string
 
+  /**
+   * Whether generate const enum for typescript bindings
+   */
+  constEnum?: boolean
+
   /**
    * @deprecated binaryName instead
    */
@@ -41,7 +59,7 @@ interface UserNapiConfig {
     /**
      * Whether enable default targets
      */
-    default: boolean
+    defaults: boolean
     /**
      * Additional targets to be compiled for
      */
@@ -49,7 +67,7 @@ interface UserNapiConfig {
   }
 }
 
-interface CommonPackageJsonFields {
+export interface CommonPackageJsonFields {
   name: string
   version: string
   description?: string
@@ -64,6 +82,21 @@ 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
+  exports?: any
+
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+
+  ava?: {
+    timeout?: string
+  }
 }
 
 export type NapiConfig = Required<
@@ -73,9 +106,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')
@@ -83,12 +122,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,17 +164,31 @@ 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)
+      }
     }
   }
 

package/src/utils/metadata.ts

@@ -1,5 +1,5 @@
-import { execSync } from 'child_process'
-import fs from 'fs'
+import { execSync } from 'node:child_process'
+import fs from 'node:fs'
 
 export type CrateTargetKind =
   | 'bin'

package/src/utils/misc.ts

@@ -1,6 +1,14 @@
-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 { createRequire } from 'node:module'
+import { promisify } from 'node:util'
 
 import { debug } from './log.js'
 

package/src/utils/target.ts

@@ -1,4 +1,10 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
+
+export type Platform = NodeJS.Platform | 'wasm' | 'wasi'
+
+export const UNIVERSAL_TARGETS = {
+  'universal-apple-darwin': ['aarch64-apple-darwin', 'x86_64-apple-darwin'],
+} as const
 
 export const AVAILABLE_TARGETS = [
   'aarch64-apple-darwin',
@@ -15,18 +21,22 @@ export const AVAILABLE_TARGETS = [
   'armv7-unknown-linux-gnueabihf',
   'armv7-linux-androideabi',
   'universal-apple-darwin',
+  'riscv64gc-unknown-linux-gnu',
+  'wasm32-wasi-preview1-threads',
 ] as const
 
 export type TargetTriple = (typeof AVAILABLE_TARGETS)[number]
 
 export const DEFAULT_TARGETS = [
   'x86_64-apple-darwin',
+  'aarch64-apple-darwin',
   'x86_64-pc-windows-msvc',
   'x86_64-unknown-linux-gnu',
 ] as const
 
 export const TARGET_LINKER: Record<string, string> = {
   'aarch64-unknown-linux-musl': 'aarch64-linux-musl-gcc',
+  'riscv64gc-unknown-linux-gnu': 'riscv64-linux-gnu-gcc',
 }
 
 // https://nodejs.org/api/process.html#process_process_arch
@@ -38,17 +48,20 @@ type NodeJSArch =
   | 'mipsel'
   | 'ppc'
   | 'ppc64'
+  | 'riscv64'
   | 's390'
   | 's390x'
   | 'x32'
   | 'x64'
   | 'universal'
+  | 'wasm32'
 
 const CpuToNodeArch: Record<string, NodeJSArch> = {
   x86_64: 'x64',
   aarch64: 'arm64',
   i686: 'ia32',
   armv7: 'arm',
+  riscv64gc: 'riscv64',
 }
 
 export const NodeArchToCpu: Record<string, string> = {
@@ -56,25 +69,24 @@ export const NodeArchToCpu: Record<string, string> = {
   arm64: 'aarch64',
   ia32: 'i686',
   arm: 'armv7',
+  riscv64: 'riscv64gc',
 }
 
-const SysToNodePlatform: Record<string, NodeJS.Platform> = {
+const SysToNodePlatform: Record<string, Platform> = {
   linux: 'linux',
   freebsd: 'freebsd',
   darwin: 'darwin',
   windows: 'win32',
 }
 
-export const UniArchsByPlatform: Partial<
-  Record<NodeJS.Platform, NodeJSArch[]>
-> = {
+export const UniArchsByPlatform: Partial<Record<Platform, NodeJSArch[]>> = {
   darwin: ['x64', 'arm64'],
 }
 
 export interface Target {
   triple: string
   platformArchABI: string
-  platform: NodeJS.Platform
+  platform: Platform
   arch: NodeJSArch
   abi: string | null
 }
@@ -90,6 +102,15 @@ export interface Target {
  *   - `abi` = The ABI, for example `gnu`, `android`, `eabi`, etc.
  */
 export function parseTriple(rawTriple: string): Target {
+  if (rawTriple === 'wasm32-wasi-preview1-threads') {
+    return {
+      triple: rawTriple,
+      platformArchABI: 'wasm32-wasi',
+      platform: 'wasi',
+      arch: 'wasm32',
+      abi: 'wasi',
+    }
+  }
   const triple = rawTriple.endsWith('eabi')
     ? `${rawTriple.slice(0, -4)}-eabi`
     : rawTriple
@@ -109,7 +130,7 @@ export function parseTriple(rawTriple: string): Target {
     ;[cpu, , sys, abi = null] = triples
   }
 
-  const platform = SysToNodePlatform[sys] ?? (sys as NodeJS.Platform)
+  const platform = SysToNodePlatform[sys] ?? (sys as Platform)
   const arch = CpuToNodeArch[cpu] ?? (cpu as NodeJSArch)
   return {
     triple: rawTriple,

package/src/utils/typegen.ts

@@ -25,7 +25,11 @@ interface TypeDefLine {
   js_mod?: string
 }
 
-function prettyPrint(line: TypeDefLine, ident: number): string {
+function prettyPrint(
+  line: TypeDefLine,
+  constEnum: boolean,
+  ident: number,
+): string {
   let s = line.js_doc ?? ''
   switch (line.kind) {
     case TypeDefKind.Interface:
@@ -33,7 +37,8 @@ function prettyPrint(line: TypeDefLine, ident: number): string {
       break
 
     case TypeDefKind.Enum:
-      s += `export const enum ${line.name} {\n${line.def}\n}`
+      const enumName = constEnum ? 'const enum' : 'enum'
+      s += `export ${enumName} ${line.name} {\n${line.def}\n}`
       break
 
     case TypeDefKind.Struct:
@@ -52,8 +57,10 @@ function prettyPrint(line: TypeDefLine, ident: number): string {
 
 export async function processTypeDef(
   intermediateTypeFile: string,
+  constEnum: boolean,
   header?: string,
 ) {
+  const exports: string[] = []
   const defs = await readIntermediateTypeFile(intermediateTypeFile)
   const groupedDefs = preprocessTypeDef(defs)
 
@@ -64,12 +71,27 @@ export async function processTypeDef(
     ([namespace, defs]) => {
       if (namespace === TOP_LEVEL_NAMESPACE) {
         for (const def of defs) {
-          dts += prettyPrint(def, 0) + '\n\n'
+          dts += prettyPrint(def, constEnum, 0) + '\n\n'
+          switch (def.kind) {
+            case TypeDefKind.Const:
+            case TypeDefKind.Enum:
+            case TypeDefKind.Fn:
+            case TypeDefKind.Struct: {
+              exports.push(def.name)
+              if (def.original_name && def.original_name !== def.name) {
+                exports.push(def.original_name)
+              }
+              break
+            }
+            default:
+              break
+          }
         }
       } else {
+        exports.push(namespace)
         dts += `export namespace ${namespace} {\n`
         for (const def of defs) {
-          dts += prettyPrint(def, 2) + '\n'
+          dts += prettyPrint(def, constEnum, 2) + '\n'
         }
         dts += '}\n\n'
       }
@@ -87,7 +109,10 @@ export class ExternalObject<T> {
 `
   }
 
-  return header + dts
+  return {
+    dts: header + dts,
+    exports,
+  }
 }
 
 async function readIntermediateTypeFile(file: string) {

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 {
@@ -68,7 +70,7 @@ function toEngineRequirement(versions: NodeVersion[]): string {
     requirements.push(req)
   })
 
-  return requirements.join(' && ')
+  return requirements.join(' ')
 }
 
 export function napiEngineRequirement(napiVersion: NapiVersion): string {

package/dist/def/commands/artifacts.d.ts

@@ -1,15 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseArtifactsCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    outputDir: string;
-    npmDir: string;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        outputDir: string;
-        npmDir: string;
-    };
-}

package/dist/def/commands/artifacts.js

@@ -1,29 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseArtifactsCommand extends Command {
-    static paths = [['artifacts']];
-    static usage = Command.Usage({
-        description: 'Copy artifacts from Github Actions into npm packages and ready to publish',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    outputDir = Option.String('--output-dir,-o', './', {
-        description: 'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            outputDir: this.outputDir,
-            npmDir: this.npmDir,
-        };
-    }
-}

package/dist/def/commands/build.d.ts

@@ -1,53 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseBuildCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    target?: string;
-    cwd?: string;
-    manifestPath?: string;
-    packageJsonPath?: string;
-    targetDir?: string;
-    outputDir?: string;
-    platform?: boolean;
-    jsPackageName?: string;
-    jsBinding?: string;
-    noJsBinding?: boolean;
-    dts?: string;
-    dtsHeader?: string;
-    noDtsHeader?: boolean;
-    strip?: boolean;
-    release?: boolean;
-    verbose?: boolean;
-    bin?: string;
-    package?: string;
-    crossCompile?: boolean;
-    watch?: boolean;
-    features?: string[];
-    allFeatures?: boolean;
-    noDefaultFeatures?: boolean;
-    getOptions(): {
-        target: string | undefined;
-        cwd: string | undefined;
-        manifestPath: string | undefined;
-        packageJsonPath: string | undefined;
-        targetDir: string | undefined;
-        outputDir: string | undefined;
-        platform: boolean | undefined;
-        jsPackageName: string | undefined;
-        jsBinding: string | undefined;
-        noJsBinding: boolean | undefined;
-        dts: string | undefined;
-        dtsHeader: string | undefined;
-        noDtsHeader: boolean | undefined;
-        strip: boolean | undefined;
-        release: boolean | undefined;
-        verbose: boolean | undefined;
-        bin: string | undefined;
-        package: string | undefined;
-        crossCompile: boolean | undefined;
-        watch: boolean | undefined;
-        features: string[] | undefined;
-        allFeatures: boolean | undefined;
-        noDefaultFeatures: boolean | undefined;
-    };
-}

package/dist/def/commands/build.js

@@ -1,105 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseBuildCommand extends Command {
-    static paths = [['build']];
-    static usage = Command.Usage({
-        description: 'Build the napi-rs project',
-    });
-    target = Option.String('--target,-t', {
-        description: 'Build for the target triple, bypassed to `cargo build --target`',
-    });
-    cwd = Option.String('--cwd', {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    manifestPath = Option.String('--manifest-path', {
-        description: 'Path to `Cargo.toml`',
-    });
-    packageJsonPath = Option.String('--package-json-path', {
-        description: 'Path to `package.json`',
-    });
-    targetDir = Option.String('--target-dir', {
-        description: 'Directory for all crate generated artifacts, see `cargo build --target-dir`',
-    });
-    outputDir = Option.String('--output-dir,-o', {
-        description: 'Path to where all the built files would be put. Default to the crate folder',
-    });
-    platform = Option.Boolean('--platform', {
-        description: 'Add platform triple to the generated nodejs binding file, eg: `[name].linux-x64-gnu.node`',
-    });
-    jsPackageName = Option.String('--js-package-name', {
-        description: 'Package name in generated js binding file. Only works with `--platform` flag',
-    });
-    jsBinding = Option.String('--js', {
-        description: 'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.',
-    });
-    noJsBinding = Option.Boolean('--no-js', {
-        description: 'Whether to disable the generation JS binding file. Only works with `--platform` flag.',
-    });
-    dts = Option.String('--dts', {
-        description: 'Path and filename of generated type def file. Relative to `--output_dir`',
-    });
-    dtsHeader = Option.String('--dts-header', {
-        description: 'Custom file header for generated type def file. Only works when `typedef` feature enabled.',
-    });
-    noDtsHeader = Option.Boolean('--no-dts-header', {
-        description: 'Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.',
-    });
-    strip = Option.Boolean('--strip,-s', {
-        description: 'Whether strip the library to achieve the minimum file size',
-    });
-    release = Option.Boolean('--release,-r', {
-        description: 'Build in release mode',
-    });
-    verbose = Option.Boolean('--verbose,-v', {
-        description: 'Verbosely log build command trace',
-    });
-    bin = Option.String('--bin', {
-        description: 'Build only the specified binary',
-    });
-    package = Option.String('--package,-p', {
-        description: 'Build the specified library or the one at cwd',
-    });
-    crossCompile = Option.Boolean('--cross-compile', {
-        description: '[experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform',
-    });
-    watch = Option.Boolean('--watch,-w', {
-        description: 'watch the crate changes and build continiously with `cargo-watch` crates',
-    });
-    features = Option.Array('--features,-F', {
-        description: 'Space-separated list of features to activate',
-    });
-    allFeatures = Option.Boolean('--all-features', {
-        description: 'Activate all available features',
-    });
-    noDefaultFeatures = Option.Boolean('--no-default-features', {
-        description: 'Do not activate the `default` feature',
-    });
-    getOptions() {
-        return {
-            target: this.target,
-            cwd: this.cwd,
-            manifestPath: this.manifestPath,
-            packageJsonPath: this.packageJsonPath,
-            targetDir: this.targetDir,
-            outputDir: this.outputDir,
-            platform: this.platform,
-            jsPackageName: this.jsPackageName,
-            jsBinding: this.jsBinding,
-            noJsBinding: this.noJsBinding,
-            dts: this.dts,
-            dtsHeader: this.dtsHeader,
-            noDtsHeader: this.noDtsHeader,
-            strip: this.strip,
-            release: this.release,
-            verbose: this.verbose,
-            bin: this.bin,
-            package: this.package,
-            crossCompile: this.crossCompile,
-            watch: this.watch,
-            features: this.features,
-            allFeatures: this.allFeatures,
-            noDefaultFeatures: this.noDefaultFeatures,
-        };
-    }
-}