@napi-rs/cli 3.0.0-alpha.9 → 3.0.0-alpha.91

package/src/api/templates/wasi-worker-template.ts

@@ -0,0 +1,122 @@
+export const WASI_WORKER_TEMPLATE = `import fs from "node:fs";
+import { createRequire } from "node:module";
+import { parse } from "node:path";
+import { WASI } from "node:wasi";
+import { parentPort, Worker } from "node:worker_threads";
+
+const require = createRequire(import.meta.url);
+
+const { instantiateNapiModuleSync, MessageHandler, getDefaultContext } = require("@napi-rs/wasm-runtime");
+
+if (parentPort) {
+  parentPort.on("message", (data) => {
+    globalThis.onmessage({ data });
+  });
+}
+
+Object.assign(globalThis, {
+  self: globalThis,
+  require,
+  Worker,
+  importScripts: function (f) {
+    ;(0, eval)(fs.readFileSync(f, "utf8") + "//# sourceURL=" + f);
+  },
+  postMessage: function (msg) {
+    if (parentPort) {
+      parentPort.postMessage(msg);
+    }
+  },
+});
+
+const emnapiContext = getDefaultContext();
+
+const __rootDir = parse(process.cwd()).root;
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({
+      version: 'preview1',
+      env: process.env,
+      preopens: {
+        [__rootDir]: __rootDir,
+      },
+    });
+
+    return instantiateNapiModuleSync(wasmModule, {
+      childThread: true,
+      wasi,
+      context: emnapiContext,
+      overwriteImports(importObject) {
+        importObject.env = {
+          ...importObject.env,
+          ...importObject.napi,
+          ...importObject.emnapi,
+          memory: wasmMemory
+        };
+      },
+    });
+  },
+});
+
+globalThis.onmessage = function (e) {
+  handler.handle(e);
+};
+`
+
+export const createWasiBrowserWorkerBinding = (fs: boolean) => {
+  const fsImport = fs
+    ? `import { instantiateNapiModuleSync, MessageHandler, WASI, createFsProxy } from '@napi-rs/wasm-runtime'
+import { memfsExported as __memfsExported } from '@napi-rs/wasm-runtime/fs'
+
+const fs = createFsProxy(__memfsExported)`
+    : `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'`
+  const wasiCreation = fs
+    ? `const wasi = new WASI({
+      fs,
+      preopens: {
+        '/': '/',
+      },
+      print: function () {
+        // eslint-disable-next-line no-console
+        console.log.apply(console, arguments)
+      },
+      printErr: function() {
+        // eslint-disable-next-line no-console
+        console.error.apply(console, arguments)
+      },
+    })`
+    : `const wasi = new WASI({
+      print: function () {
+        // eslint-disable-next-line no-console
+        console.log.apply(console, arguments)
+      },
+      printErr: function() {
+        // eslint-disable-next-line no-console
+        console.error.apply(console, arguments)
+      },
+    })`
+  return `${fsImport}
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    ${wasiCreation}
+    return instantiateNapiModuleSync(wasmModule, {
+      childThread: true,
+      wasi,
+      overwriteImports(importObject) {
+        importObject.env = {
+          ...importObject.env,
+          ...importObject.napi,
+          ...importObject.emnapi,
+          memory: wasmMemory,
+        }
+      },
+    })
+  },
+})
+
+globalThis.onmessage = function (e) {
+  handler.handle(e)
+}
+`
+}

package/src/api/universalize.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
-import { join, resolve } from 'path'
+import { spawnSync } from 'node:child_process'
+import { join, resolve } from 'node:path'
 
 import {
   applyDefaultUniversalizeOptions,
@@ -27,7 +27,10 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
 
   const packageJsonPath = join(options.cwd, options.packageJsonPath)
 
-  const config = await readNapiConfig(packageJsonPath)
+  const config = await readNapiConfig(
+    packageJsonPath,
+    options.configPath ? resolve(options.cwd, options.configPath) : undefined,
+  )
 
   const target = config.targets.find(
     (t) => t.platform === process.platform && t.arch === 'universal',
@@ -39,8 +42,12 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
     )
   }
 
-  const srcFiles = UniArchsByPlatform[process.platform]?.map(
-    (arch) => `${config.binaryName}.${process.platform}-${arch}.node`,
+  const srcFiles = UniArchsByPlatform[process.platform]?.map((arch) =>
+    resolve(
+      options.cwd,
+      options.outputDir,
+      `${config.binaryName}.${process.platform}-${arch}.node`,
+    ),
   )
 
   if (!srcFiles || !universalizers[process.platform]) {
@@ -52,9 +59,7 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
   debug(`Looking up source binaries to combine: `)
   debug('  %O', srcFiles)
 
-  const srcFileLookup = await Promise.all(
-    srcFiles.map((f) => fileExists(resolve(options.cwd, options.outputDir, f))),
-  )
+  const srcFileLookup = await Promise.all(srcFiles.map((f) => fileExists(f)))
 
   const notFoundFiles = srcFiles.filter((_, i) => !srcFileLookup[i])
 

package/src/api/version.ts

@@ -1,4 +1,4 @@
-import { join, resolve } from 'path'
+import { join, resolve } from 'node:path'
 
 import { applyDefaultVersionOptions, VersionOptions } from '../def/version.js'
 import {
@@ -13,7 +13,10 @@ export async function version(userOptions: VersionOptions) {
   const options = applyDefaultVersionOptions(userOptions)
   const packageJsonPath = resolve(options.cwd, options.packageJsonPath)
 
-  const config = await readNapiConfig(packageJsonPath)
+  const config = await readNapiConfig(
+    packageJsonPath,
+    options.configPath ? resolve(options.cwd, options.configPath) : undefined,
+  )
 
   for (const target of config.targets) {
     const pkgDir = resolve(options.cwd, options.npmDir, target.platformArchABI)

package/src/commands/artifacts.ts

@@ -8,9 +8,9 @@ export class ArtifactsCommand extends BaseArtifactsCommand {
     description: 'Copy artifacts from Github Actions into specified dir',
     examples: [
       [
-        '$0 artifacts --dir . --dist ./npm',
+        '$0 artifacts --output-dir ./artifacts --dist ./npm',
         `Copy [binaryName].[platform].node under current dir(.) into packages under npm dir.
-e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.node`,
+e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.linux-x64-gnu.node`,
       ],
     ],
   })

package/src/commands/build.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { Option } from 'clipanion'
 

package/src/commands/new.ts

@@ -1,7 +1,7 @@
-import path from 'path'
+import path from 'node:path'
 
+import { input, select, checkbox, confirm } from '@inquirer/prompts'
 import { Option } from 'clipanion'
-import inquirer from 'inquirer'
 
 import { newProject } from '../api/new.js'
 import { BaseNewCommand } from '../def/new.js'
@@ -16,7 +16,7 @@ import { napiEngineRequirement } from '../utils/version.js'
 const debug = debugFactory('new')
 
 export class NewCommand extends BaseNewCommand {
-  interactive = Option.Boolean('--interactive,-i', false, {
+  interactive = Option.Boolean('--interactive,-i', true, {
     description:
       'Ask project basic information interactively without just using the default.',
   })
@@ -37,9 +37,13 @@ export class NewCommand extends BaseNewCommand {
     const cmdOptions = super.getOptions()
 
     if (this.interactive) {
+      const targetPath: string = cmdOptions.path
+        ? cmdOptions.path
+        : await inquirerProjectPath()
+      cmdOptions.path = targetPath
       return {
         ...cmdOptions,
-        name: await this.fetchName(path.parse(cmdOptions.path).base),
+        name: await this.fetchName(path.parse(targetPath).base),
         minNodeApiVersion: await this.fetchNapiVersion(),
         targets: await this.fetchTargets(),
         license: await this.fetchLicense(),
@@ -54,43 +58,31 @@ export class NewCommand extends BaseNewCommand {
   private async fetchName(defaultName: string): Promise<string> {
     return (
       this.$$name ??
-      (await inquirer
-        .prompt({
-          type: 'input',
-          name: 'name',
-          message: 'Package name (the name field in your package.json file)',
-          default: defaultName,
-        })
-        .then(({ name }) => name))
+      input({
+        message: 'Package name (the name field in your package.json file)',
+        default: defaultName,
+      })
     )
   }
 
   private async fetchLicense(): Promise<string> {
-    return inquirer
-      .prompt({
-        type: 'input',
-        name: 'license',
-        message: 'License for open-sourced project',
-        default: this.license,
-      })
-      .then(({ license }) => license)
+    return input({
+      message: 'License for open-sourced project',
+      default: this.license,
+    })
   }
 
   private async fetchNapiVersion(): Promise<number> {
-    return inquirer
-      .prompt({
-        type: 'list',
-        name: 'minNodeApiVersion',
-        message: 'Minimum node-api version (with node version requirement)',
-        loop: false,
-        choices: new Array(8).fill(0).map((_, i) => ({
-          name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
-          value: i + 1,
-        })),
-        // choice index
-        default: this.minNodeApiVersion - 1,
-      })
-      .then(({ minNodeApiVersion }) => minNodeApiVersion)
+    return select({
+      message: 'Minimum node-api version (with node version requirement)',
+      loop: false,
+      choices: Array.from({ length: 8 }, (_, i) => ({
+        name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
+        value: i + 1,
+      })),
+      // choice index
+      default: this.minNodeApiVersion - 1,
+    })
   }
 
   private async fetchTargets(): Promise<TargetTriple[]> {
@@ -98,22 +90,22 @@ export class NewCommand extends BaseNewCommand {
       return AVAILABLE_TARGETS.concat()
     }
 
-    const { targets } = await inquirer.prompt({
-      name: 'targets',
-      type: 'checkbox',
+    const targets = await checkbox({
       loop: false,
       message: 'Choose target(s) your crate will be compiled to',
-      default: this.enableDefaultTargets ? DEFAULT_TARGETS : [],
-      choices: AVAILABLE_TARGETS,
+      choices: AVAILABLE_TARGETS.map((target) => ({
+        name: target,
+        value: target,
+        // @ts-expect-error
+        checked: DEFAULT_TARGETS.includes(target),
+      })),
     })
 
     return targets
   }
 
   private async fetchTypeDef(): Promise<boolean> {
-    const { enableTypeDef } = await inquirer.prompt({
-      name: 'enableTypeDef',
-      type: 'confirm',
+    const enableTypeDef = await confirm({
       message: 'Enable type definition auto-generation',
       default: this.enableTypeDef,
     })
@@ -122,9 +114,7 @@ export class NewCommand extends BaseNewCommand {
   }
 
   private async fetchGithubActions(): Promise<boolean> {
-    const { enableGithubActions } = await inquirer.prompt({
-      name: 'enableGithubActions',
-      type: 'confirm',
+    const enableGithubActions = await confirm({
       message: 'Enable Github Actions CI',
       default: this.enableGithubActions,
     })
@@ -132,3 +122,14 @@ export class NewCommand extends BaseNewCommand {
     return enableGithubActions
   }
 }
+
+async function inquirerProjectPath(): Promise<string> {
+  return input({
+    message: 'Target path to create the project, relative to cwd.',
+  }).then((path) => {
+    if (!path) {
+      return inquirerProjectPath()
+    }
+    return path
+  })
+}

package/src/def/artifacts.ts

@@ -15,11 +15,15 @@ export abstract class BaseArtifactsCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
 
-  outputDir = Option.String('--output-dir,-o', './', {
+  outputDir = Option.String('--output-dir,-o,-d', './artifacts', {
     description:
       'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
   })
@@ -28,12 +32,19 @@ export abstract class BaseArtifactsCommand extends Command {
     description: 'Path to the folder where the npm packages put',
   })
 
+  buildOutputDir?: string = Option.String('--build-output-dir', {
+    description:
+      'Path to the build output dir, only needed when targets contains `wasm32-wasi-*`',
+  })
+
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       outputDir: this.outputDir,
       npmDir: this.npmDir,
+      buildOutputDir: this.buildOutputDir,
     }
   }
 }
@@ -48,6 +59,10 @@ export interface ArtifactsOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *
@@ -57,7 +72,7 @@ export interface ArtifactsOptions {
   /**
    * Path to the folder where all built `.node` files put, same as `--output-dir` of build command
    *
-   * @default './'
+   * @default './artifacts'
    */
   outputDir?: string
   /**
@@ -66,13 +81,17 @@ export interface ArtifactsOptions {
    * @default 'npm'
    */
   npmDir?: string
+  /**
+   * Path to the build output dir, only needed when targets contains `wasm32-wasi-*`
+   */
+  buildOutputDir?: string
 }
 
 export function applyDefaultArtifactsOptions(options: ArtifactsOptions) {
   return {
     cwd: process.cwd(),
     packageJsonPath: 'package.json',
-    outputDir: './',
+    outputDir: './artifacts',
     npmDir: 'npm',
     ...options,
   }

package/src/def/build.ts

@@ -6,7 +6,7 @@ export abstract class BaseBuildCommand extends Command {
   static paths = [['build']]
 
   static usage = Command.Usage({
-    description: 'Build the napi-rs project',
+    description: 'Build the NAPI-RS project',
   })
 
   target?: string = Option.String('--target,-t', {
@@ -23,6 +23,10 @@ export abstract class BaseBuildCommand extends Command {
     description: 'Path to `Cargo.toml`',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath?: string = Option.String('--package-json-path', {
     description: 'Path to `package.json`',
   })
@@ -53,7 +57,7 @@ export abstract class BaseBuildCommand extends Command {
 
   jsBinding?: string = Option.String('--js', {
     description:
-      'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.',
+      'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.',
   })
 
   noJsBinding?: boolean = Option.Boolean('--no-js', {
@@ -63,7 +67,7 @@ export abstract class BaseBuildCommand extends Command {
 
   dts?: string = Option.String('--dts', {
     description:
-      'Path and filename of generated type def file. Relative to `--output_dir`',
+      'Path and filename of generated type def file. Relative to `--output-dir`',
   })
 
   dtsHeader?: string = Option.String('--dts-header', {
@@ -76,6 +80,15 @@ export abstract class BaseBuildCommand extends Command {
       'Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.',
   })
 
+  dtsCache = Option.Boolean('--dts-cache', true, {
+    description: 'Whether to enable the dts cache, default to true',
+  })
+
+  esm?: boolean = Option.Boolean('--esm', {
+    description:
+      'Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.',
+  })
+
   strip?: boolean = Option.Boolean('--strip,-s', {
     description: 'Whether strip the library to achieve the minimum file size',
   })
@@ -110,9 +123,14 @@ export abstract class BaseBuildCommand extends Command {
       '[experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`',
   })
 
+  useNapiCross?: boolean = Option.Boolean('--use-napi-cross', {
+    description:
+      '[experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.',
+  })
+
   watch?: boolean = Option.Boolean('--watch,-w', {
     description:
-      'watch the crate changes and build continiously with `cargo-watch` crates',
+      'watch the crate changes and build continuously with `cargo-watch` crates',
   })
 
   features?: string[] = Option.Array('--features,-F', {
@@ -132,6 +150,7 @@ export abstract class BaseBuildCommand extends Command {
       target: this.target,
       cwd: this.cwd,
       manifestPath: this.manifestPath,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       targetDir: this.targetDir,
       outputDir: this.outputDir,
@@ -143,6 +162,8 @@ export abstract class BaseBuildCommand extends Command {
       dts: this.dts,
       dtsHeader: this.dtsHeader,
       noDtsHeader: this.noDtsHeader,
+      dtsCache: this.dtsCache,
+      esm: this.esm,
       strip: this.strip,
       release: this.release,
       verbose: this.verbose,
@@ -151,6 +172,7 @@ export abstract class BaseBuildCommand extends Command {
       profile: this.profile,
       crossCompile: this.crossCompile,
       useCross: this.useCross,
+      useNapiCross: this.useNapiCross,
       watch: this.watch,
       features: this.features,
       allFeatures: this.allFeatures,
@@ -160,7 +182,7 @@ export abstract class BaseBuildCommand extends Command {
 }
 
 /**
- * Build the napi-rs project
+ * Build the NAPI-RS project
  */
 export interface BuildOptions {
   /**
@@ -175,6 +197,10 @@ export interface BuildOptions {
    * Path to `Cargo.toml`
    */
   manifestPath?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    */
@@ -200,7 +226,7 @@ export interface BuildOptions {
    */
   constEnum?: boolean
   /**
-   * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.
+   * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.
    */
   jsBinding?: string
   /**
@@ -208,7 +234,7 @@ export interface BuildOptions {
    */
   noJsBinding?: boolean
   /**
-   * Path and filename of generated type def file. Relative to `--output_dir`
+   * Path and filename of generated type def file. Relative to `--output-dir`
    */
   dts?: string
   /**
@@ -219,6 +245,16 @@ export interface BuildOptions {
    * Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.
    */
   noDtsHeader?: boolean
+  /**
+   * Whether to enable the dts cache, default to true
+   *
+   * @default true
+   */
+  dtsCache?: boolean
+  /**
+   * Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.
+   */
+  esm?: boolean
   /**
    * Whether strip the library to achieve the minimum file size
    */
@@ -252,7 +288,11 @@ export interface BuildOptions {
    */
   useCross?: boolean
   /**
-   * watch the crate changes and build continiously with `cargo-watch` crates
+   * [experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.
+   */
+  useNapiCross?: boolean
+  /**
+   * watch the crate changes and build continuously with `cargo-watch` crates
    */
   watch?: boolean
   /**
@@ -268,3 +308,10 @@ export interface BuildOptions {
    */
   noDefaultFeatures?: boolean
 }
+
+export function applyDefaultBuildOptions(options: BuildOptions) {
+  return {
+    dtsCache: true,
+    ...options,
+  }
+}

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

@@ -14,6 +14,10 @@ export abstract class BaseCreateNpmDirsCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -29,6 +33,7 @@ export abstract class BaseCreateNpmDirsCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
       dryRun: this.dryRun,
@@ -46,6 +51,10 @@ export interface CreateNpmDirsOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *