@napi-rs/cli 3.0.0-alpha.5 → 3.0.0-alpha.51

package/src/api/templates/package.json.ts

@@ -1,12 +1,21 @@
-import { CommonPackageJsonFields } from '../../utils/config.js'
+import type {
+  CommonPackageJsonFields,
+  SupportedTestFramework,
+} from '../../utils/config.js'
+import { UNIVERSAL_TARGETS } from '../../utils/target.js'
 
-export const createPackageJson = ({
+export interface PackageMeta {
+  'dist-tags': { [index: string]: string }
+}
+
+export const createPackageJson = async ({
   name,
   binaryName,
   targets,
   license,
   engineRequirement,
   cliVersion,
+  testFramework,
 }: {
   name: string
   binaryName: string
@@ -14,10 +23,24 @@ export const createPackageJson = ({
   license: string
   engineRequirement: string
   cliVersion: string
+  testFramework: SupportedTestFramework
 }) => {
+  const hasWasmTarget = targets.some((t) => t.includes('wasm'))
+  const universalTargets = targets.filter(
+    (t) => t in UNIVERSAL_TARGETS,
+  ) as (keyof typeof UNIVERSAL_TARGETS)[]
+  const unifiedtargets = universalTargets.length
+    ? targets.filter(
+        (target) =>
+          !universalTargets.some((t) => {
+            // @ts-expect-error
+            return UNIVERSAL_TARGETS[t].includes(target)
+          }),
+      )
+    : targets
   const content: CommonPackageJsonFields = {
     name,
-    version: '1.0.0',
+    version: '0.0.0',
     license,
     engines: {
       node: engineRequirement,
@@ -25,14 +48,15 @@ export const createPackageJson = ({
     type: 'commonjs',
     main: 'index.js',
     types: 'index.d.ts',
+    browser: 'browser.js',
     module: undefined,
     exports: undefined,
     napi: {
       binaryName,
-      targets,
+      targets: unifiedtargets,
     },
     scripts: {
-      test: 'node -e "assert(require(\'.\').sum(1, 2) === 3)"',
+      test: testFramework,
       build: 'napi build --release --platform --strip',
       'build:debug': 'napi build',
       prepublishOnly: 'napi prepublish -t npm',
@@ -44,5 +68,23 @@ export const createPackageJson = ({
     },
   }
 
+  if (testFramework === 'ava') {
+    const avaMeta = await fetch(`https://registry.npmjs.org/ava`).then(
+      (res) => res.json() as Promise<PackageMeta>,
+    )
+    content.devDependencies!['ava'] = `^${avaMeta['dist-tags'].latest}`
+    content.ava = {
+      timeout: '1m',
+    }
+  }
+
+  if (hasWasmTarget) {
+    const wasmRuntime = await fetch(
+      `https://registry.npmjs.org/@napi-rs/wasm-runtime`,
+    ).then((res) => res.json() as Promise<PackageMeta>)
+    const latest = wasmRuntime['dist-tags'].latest
+    content.devDependencies!['@napi-rs/wasm-runtime'] = `^${latest}`
+  }
+
   return JSON.stringify(content, null, 2)
 }

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

@@ -0,0 +1,103 @@
+export const WASI_WORKER_TEMPLATE = `import fs from "node:fs";
+import { createRequire } from "node:module";
+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 handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({
+      version: 'preview1',
+      env: process.env,
+      preopens: {
+        '/': '/',
+      },
+    });
+
+    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 WASI_WORKER_BROWSER_TEMPLATE = `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'
+import { Volume, createFsFromVolume } from '@napi-rs/wasm-runtime/fs'
+
+const fs = createFsFromVolume(
+  Volume.fromJSON({
+    '/': null,
+  }),
+)
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({
+      fs,
+      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 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',
@@ -40,7 +43,7 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
   }
 
   const srcFiles = UniArchsByPlatform[process.platform]?.map(
-    (arch) => `${config.binaryName}.${process.platform}-${arch}.node`,
+    (arch) => resolve(options.cwd, options.outputDir, `${config.binaryName}.${process.platform}-${arch}.node`),
   )
 
   if (!srcFiles || !universalizers[process.platform]) {
@@ -53,7 +56,7 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
   debug('  %O', srcFiles)
 
   const srcFileLookup = await Promise.all(
-    srcFiles.map((f) => fileExists(resolve(options.cwd, options.outputDir, f))),
+    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,4 +1,4 @@
-import path from 'path'
+import path from 'node:path'
 
 import { Option } from 'clipanion'
 import inquirer from 'inquirer'
@@ -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,14 +58,14 @@ export class NewCommand extends BaseNewCommand {
   private async fetchName(defaultName: string): Promise<string> {
     return (
       this.$$name ??
-      (await inquirer
+      inquirer
         .prompt({
           type: 'input',
           name: 'name',
           message: 'Package name (the name field in your package.json file)',
           default: defaultName,
         })
-        .then(({ name }) => name))
+        .then(({ name }) => name)
     )
   }
 
@@ -83,7 +87,7 @@ export class NewCommand extends BaseNewCommand {
         name: 'minNodeApiVersion',
         message: 'Minimum node-api version (with node version requirement)',
         loop: false,
-        choices: new Array(8).fill(0).map((_, i) => ({
+        choices: Array.from({ length: 8 }, (_, i) => ({
           name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
           value: i + 1,
         })),
@@ -132,3 +136,18 @@ export class NewCommand extends BaseNewCommand {
     return enableGithubActions
   }
 }
+
+async function inquirerProjectPath(): Promise<string> {
+  return inquirer
+    .prompt({
+      type: 'input',
+      name: 'path',
+      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`',
   })
@@ -47,6 +51,10 @@ export abstract class BaseBuildCommand extends Command {
       'Package name in generated js binding file. Only works with `--platform` flag',
   })
 
+  constEnum?: boolean = Option.Boolean('--const-enum', {
+    description: 'Whether generate const enum for typescript bindings',
+  })
+
   jsBinding?: string = Option.String('--js', {
     description:
       'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.',
@@ -106,9 +114,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', {
@@ -128,11 +141,13 @@ 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,
       platform: this.platform,
       jsPackageName: this.jsPackageName,
+      constEnum: this.constEnum,
       jsBinding: this.jsBinding,
       noJsBinding: this.noJsBinding,
       dts: this.dts,
@@ -146,6 +161,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,
@@ -155,7 +171,7 @@ export abstract class BaseBuildCommand extends Command {
 }
 
 /**
- * Build the napi-rs project
+ * Build the NAPI-RS project
  */
 export interface BuildOptions {
   /**
@@ -170,6 +186,10 @@ export interface BuildOptions {
    * Path to `Cargo.toml`
    */
   manifestPath?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    */
@@ -190,6 +210,10 @@ export interface BuildOptions {
    * Package name in generated js binding file. Only works with `--platform` flag
    */
   jsPackageName?: string
+  /**
+   * Whether generate const enum for typescript bindings
+   */
+  constEnum?: boolean
   /**
    * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.
    */
@@ -243,7 +267,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
   /**

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`
    *

package/src/def/new.ts

@@ -10,7 +10,7 @@ export abstract class BaseNewCommand extends Command {
     description: 'Create a new project with pre-configured boilerplate',
   })
 
-  $$path = Option.String({ required: true })
+  $$path = Option.String({ required: false })
 
   $$name?: string = Option.String('--name,-n', {
     description:
@@ -22,6 +22,10 @@ export abstract class BaseNewCommand extends Command {
     description: 'The minimum Node-API version to support',
   })
 
+  packageManager = Option.String('--package-manager', 'yarn', {
+    description: 'The package manager to use. Only support yarn 4.x for now.',
+  })
+
   license = Option.String('--license,-l', 'MIT', {
     description: 'License for open-sourced project',
   })
@@ -47,6 +51,11 @@ export abstract class BaseNewCommand extends Command {
     description: 'Whether generate preconfigured GitHub Actions workflow',
   })
 
+  testFramework = Option.String('--test-framework', 'ava', {
+    description:
+      'The JavaScript test framework to use, only support `ava` for now',
+  })
+
   dryRun = Option.Boolean('--dry-run', false, {
     description: 'Whether to run the command in dry-run mode',
   })
@@ -56,12 +65,14 @@ export abstract class BaseNewCommand extends Command {
       path: this.$$path,
       name: this.$$name,
       minNodeApiVersion: this.minNodeApiVersion,
+      packageManager: this.packageManager,
       license: this.license,
       targets: this.targets,
       enableDefaultTargets: this.enableDefaultTargets,
       enableAllTargets: this.enableAllTargets,
       enableTypeDef: this.enableTypeDef,
       enableGithubActions: this.enableGithubActions,
+      testFramework: this.testFramework,
       dryRun: this.dryRun,
     }
   }
@@ -72,9 +83,9 @@ export abstract class BaseNewCommand extends Command {
  */
 export interface NewOptions {
   /**
-   * The path where the napi-rs project will be created.
+   * The path where the NAPI-RS project will be created.
    */
-  path: string
+  path?: string
   /**
    * The name of the project, default to the name of the directory if not provided
    */
@@ -85,6 +96,12 @@ export interface NewOptions {
    * @default 4
    */
   minNodeApiVersion?: number
+  /**
+   * The package manager to use. Only support yarn 4.x for now.
+   *
+   * @default 'yarn'
+   */
+  packageManager?: string
   /**
    * License for open-sourced project
    *
@@ -121,6 +138,12 @@ export interface NewOptions {
    * @default true
    */
   enableGithubActions?: boolean
+  /**
+   * The JavaScript test framework to use, only support `ava` for now
+   *
+   * @default 'ava'
+   */
+  testFramework?: string
   /**
    * Whether to run the command in dry-run mode
    *
@@ -132,12 +155,14 @@ export interface NewOptions {
 export function applyDefaultNewOptions(options: NewOptions) {
   return {
     minNodeApiVersion: 4,
+    packageManager: 'yarn',
     license: 'MIT',
     targets: [],
     enableDefaultTargets: true,
     enableAllTargets: false,
     enableTypeDef: true,
     enableGithubActions: true,
+    testFramework: 'ava',
     dryRun: false,
     ...options,
   }