@napi-rs/cli 3.8.6 → 3.9.1

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

@@ -13,11 +13,11 @@ let __emnapiWasmEnvCleanupDrained = false
 let __emnapiWasmEnvCleanupDrainPromise
 let __wasiDisposed = false
 let __wasiDisposePromise
-let __completeWasiDisposal = function() {}
+let __completeWasiDisposal = function () {}
 // Overridden by loader flavors that have a last-resort reclaim for a rollback
 // that stopped short of destroying the context. See
 // \`__rollbackWasiInitialization\`.
-let __retainWasiRollbackForRetry = function() {}
+let __retainWasiRollbackForRetry = function () {}
 
 function __isThenable(value) {
   return (
@@ -1923,6 +1923,7 @@ function __createWasiWorker(filename) {
       return new Worker(filename, {
         env: process.env,
         execArgv: __workerExecArgv,
+        workerData: { hostRoot: __hostRoot, rootDir: __rootDir },
       })
     } catch (error) {
       if (!error || error.code !== 'ERR_WORKER_INVALID_EXEC_ARGV') {
@@ -1944,7 +1945,7 @@ function __createWasiWorker(filename) {
     : ''
   const memoryName = threads ? '__sharedMemory' : '__wasmMemory'
   const asyncWorkOptions = threads
-    ? `    asyncWorkPoolSize: (function() {
+    ? `    asyncWorkPoolSize: (function () {
       const threadsSizeFromEnv = Number(process.env.NAPI_RS_ASYNC_WORK_POOL_SIZE ?? process.env.UV_THREADPOOL_SIZE)
       // NaN > 0 is false
       if (threadsSizeFromEnv > 0) {
@@ -1980,21 +1981,21 @@ function __createWasiWorker(filename) {
       // According to https://github.com/nodejs/node/blob/19e0d472728c79d418b74bddff588bea70a403d0/lib/internal/worker.js#L415,
       // a worker is consist of two handles: kPublicPort and kHandle.
       {
-        const kPublicPort = Object.getOwnPropertySymbols(worker).find(s =>
-          s.toString().includes("kPublicPort")
-        );
+        const kPublicPort = Object.getOwnPropertySymbols(worker).find((s) =>
+          s.toString().includes('kPublicPort'),
+        )
         if (kPublicPort) {
-          worker[kPublicPort].ref = () => {};
+          worker[kPublicPort].ref = () => {}
         }
 
-        const kHandle = Object.getOwnPropertySymbols(worker).find(s =>
-          s.toString().includes("kHandle")
-        );
+        const kHandle = Object.getOwnPropertySymbols(worker).find((s) =>
+          s.toString().includes('kHandle'),
+        )
         if (kHandle) {
-          worker[kHandle].ref = () => {};
+          worker[kHandle].ref = () => {}
         }
 
-        worker.unref();
+        worker.unref()
       }
       return worker
     },
@@ -2002,8 +2003,6 @@ function __createWasiWorker(filename) {
     : ''
 
   return `/* eslint-disable */
-/* prettier-ignore */
-
 /* auto-generated by NAPI-RS */
 
 const __nodeFs = require('node:fs')
@@ -2019,14 +2018,18 @@ ${workerRuntimeImport}\
 const { createContext: __emnapiCreateContext } = require('@emnapi/runtime')
 ${workerExecArgv}\
 
-const __rootDir = __nodePath.parse(process.cwd()).root
+const __cwd = process.cwd()
+const __rootDir = __nodePath.parse(__cwd).root
+const __hostRoot =
+  process.platform === 'android' ? __cwd : __rootDir
 
 const __wasi = new __nodeWASI({
   version: 'preview1',
   env: process.env,
   preopens: {
-    [__rootDir]: __rootDir,
-  }
+    [__rootDir]: __hostRoot,
+    [__hostRoot]: __hostRoot,
+  },
 })
 
 const ${memoryName} = new WebAssembly.Memory({

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

@@ -1,10 +1,10 @@
-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";
+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, workerData } from 'node:worker_threads'
 
-const require = createRequire(import.meta.url);
+const require = createRequire(import.meta.url)
 
 const {
   instantiateNapiModuleSync,
@@ -12,12 +12,12 @@ const {
   getDefaultContext,
   emnapiAsyncWorkPlugin,
   emnapiTSFNPlugin,
-} = require("@napi-rs/wasm-runtime");
+} = require('@napi-rs/wasm-runtime')
 
 if (parentPort) {
-  parentPort.on("message", (data) => {
-    globalThis.onmessage({ data });
-  });
+  parentPort.on('message', (data) => {
+    globalThis.onmessage({ data })
+  })
 }
 
 Object.assign(globalThis, {
@@ -25,18 +25,25 @@ Object.assign(globalThis, {
   require,
   Worker,
   importScripts: function (f) {
-    ;(0, eval)(fs.readFileSync(f, "utf8") + "//# sourceURL=" + f);
+    // oxlint-disable-next-line no-eval -- WASI importScripts polyfill
+    ;(0, eval)(fs.readFileSync(f, 'utf8') + '//# sourceURL=' + f)
   },
   postMessage: function (msg) {
     if (parentPort) {
-      parentPort.postMessage(msg);
+      parentPort.postMessage(msg)
     }
   },
-});
+})
 
-const emnapiContext = getDefaultContext();
+const emnapiContext = getDefaultContext()
 
-const __rootDir = parse(process.cwd()).root;
+const __cwd = process.cwd()
+const __rootDir =
+  (workerData && typeof workerData.rootDir === 'string' && workerData.rootDir) ||
+  parse(__cwd).root
+const __hostRoot =
+  (workerData && typeof workerData.hostRoot === 'string' && workerData.hostRoot) ||
+  (process.platform === 'android' ? __cwd : __rootDir)
 
 const handler = new MessageHandler({
   onLoad({ wasmModule, wasmMemory }) {
@@ -44,9 +51,10 @@ const handler = new MessageHandler({
       version: 'preview1',
       env: process.env,
       preopens: {
-        [__rootDir]: __rootDir,
+        [__rootDir]: __hostRoot,
+        [__hostRoot]: __hostRoot,
       },
-    });
+    })
 
     return instantiateNapiModuleSync(wasmModule, {
       childThread: true,
@@ -62,16 +70,16 @@ const handler = new MessageHandler({
           ...importObject.env,
           ...importObject.napi,
           ...importObject.emnapi,
-          memory: wasmMemory
-        };
+          memory: wasmMemory,
+        }
       },
-    });
+    })
   },
-});
+})
 
 globalThis.onmessage = function (e) {
-  handler.handle(e);
-};
+  handler.handle(e)
+}
 `
 
 export const createWasiBrowserWorkerBinding = (
@@ -110,10 +118,9 @@ const fs = createFsProxy(__memfsExported)`
         // eslint-disable-next-line no-console
         console.log.apply(console, arguments)
       },
-      printErr: function() {
+      printErr: function () {
         // eslint-disable-next-line no-console
-        console.error.apply(console, arguments)
-        ${errorOutputsAppend}
+        console.error.apply(console, arguments)${errorOutputsAppend}
       },
     })`
     : `const wasi = new WASI({
@@ -121,10 +128,9 @@ const fs = createFsProxy(__memfsExported)`
         // eslint-disable-next-line no-console
         console.log.apply(console, arguments)
       },
-      printErr: function() {
+      printErr: function () {
         // eslint-disable-next-line no-console
-        console.error.apply(console, arguments)
-        ${errorOutputsAppend}
+        console.error.apply(console, arguments)${errorOutputsAppend}
       },
     })`
   const errorHandler = errorEvent
@@ -156,8 +162,7 @@ const handler = new MessageHandler({
         }
       },
     })
-  },
-  ${errorHandler}
+  },${errorHandler ? `\n  ${errorHandler}` : ''}
 })
 
 globalThis.onmessage = function (e) {

package/src/commands/__tests__/build.spec.ts

@@ -0,0 +1,24 @@
+import test from 'ava'
+
+import { createBuildCommand } from '../../index.js'
+
+test('build supports explicit format and compatibility aliases', (t) => {
+  const explicit = createBuildCommand([
+    '--format',
+    'esm',
+    '--js-binding',
+    'index.mjs',
+  ])
+
+  t.is(explicit.format, 'esm')
+  t.is(explicit.jsBinding, 'index.mjs')
+
+  t.true(createBuildCommand(['--esm']).esm)
+  t.true(createBuildCommand(['--commonjs']).commonjs)
+})
+
+test('build rejects unsupported formats', (t) => {
+  t.throws(() => createBuildCommand(['--format', 'umd']), {
+    message: /Invalid value for --format/,
+  })
+})

package/src/commands/build.ts

@@ -11,7 +11,7 @@ const debug = debugFactory('build')
 export class BuildCommand extends BaseBuildCommand {
   pipe = Option.String('--pipe', {
     description:
-      'Pipe all outputs file to given command. e.g. `napi build --pipe "npx prettier --write"`',
+      'Pipe all outputs file to given command. e.g. `napi build --pipe "npx oxfmt"`',
   })
 
   cargoOptions = Option.Rest()

package/src/def/build.ts

@@ -1,6 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion'
+import * as typanion from 'typanion'
 
 export abstract class BaseBuildCommand extends Command {
   static paths = [['build']]
@@ -60,7 +61,7 @@ export abstract class BaseBuildCommand extends Command {
       'Emit `#[napi(string_enum)]` enums as runtime enums (`export declare enum`) under `--no-const-enum`. Default: type-only union.',
   })
 
-  jsBinding?: string = Option.String('--js', {
+  jsBinding?: string = Option.String('--js,--js-binding', {
     description:
       'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.',
   })
@@ -89,9 +90,21 @@ export abstract class BaseBuildCommand extends Command {
     description: 'Whether to enable the dts cache, default to true',
   })
 
-  esm?: boolean = Option.Boolean('--esm', {
+  format?: 'esm' | 'commonjs' = Option.String('--format', {
+    validator: typanion.isOneOf([
+      typanion.isLiteral('esm'),
+      typanion.isLiteral('commonjs'),
+    ]),
     description:
-      'Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.',
+      'The module format of the generated JS binding file. Only works with `--platform` flag. Defaults to `commonjs`.',
+  })
+
+  esm?: boolean = Option.Boolean('--esm', {
+    description: 'Alias for `--format esm`.',
+  })
+
+  commonjs?: boolean = Option.Boolean('--commonjs', {
+    description: 'Alias for `--format commonjs`.',
   })
 
   strip?: boolean = Option.Boolean('--strip,-s', {
@@ -150,6 +163,9 @@ export abstract class BaseBuildCommand extends Command {
     description: 'Do not activate the `default` feature',
   })
 
+  /**
+   * Return the parsed build options.
+   */
   getOptions() {
     return {
       target: this.target,
@@ -169,7 +185,9 @@ export abstract class BaseBuildCommand extends Command {
       dtsHeader: this.dtsHeader,
       noDtsHeader: this.noDtsHeader,
       dtsCache: this.dtsCache,
+      format: this.format,
       esm: this.esm,
+      commonjs: this.commonjs,
       strip: this.strip,
       release: this.release,
       verbose: this.verbose,
@@ -262,9 +280,17 @@ export interface BuildOptions {
    */
   dtsCache?: boolean
   /**
-   * Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.
+   * The module format of the generated JS binding file. Only works with `--platform` flag. Defaults to `commonjs`.
+   */
+  format?: 'esm' | 'commonjs'
+  /**
+   * Alias for `--format esm`.
    */
   esm?: boolean
+  /**
+   * Alias for `--format commonjs`.
+   */
+  commonjs?: boolean
   /**
    * Whether strip the library to achieve the minimum file size
    */

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

@@ -142,9 +142,7 @@ Generated by [AVA](https://avajs.dev).
     }␊
     export type Blake2bHasher = Blake2BHasher␊
     ␊
-    export declare class Blake2BKey {␊
-    ␊
-    }␊
+    export declare class Blake2BKey {}␊
     export type Blake2bKey = Blake2BKey␊
     ␊
     export declare class ClassWithFactory {␊
@@ -257,7 +255,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export declare const enum ALIAS {␊
       A = 0,␊
-      B = 1␊
+      B = 1,␊
     }␊
     ␊
     export interface AliasedStruct {␊
@@ -345,7 +343,7 @@ Generated by [AVA](https://avajs.dev).
       Six = 6,␊
       Eight = 8,␊
       Nine = 9,␊
-      Ten = 10␊
+      Ten = 10,␊
     }␊
     ␊
     export declare function customStatusCode(): void␊
@@ -358,7 +356,7 @@ Generated by [AVA](https://avajs.dev).
     export declare function dateToNumber(input: Date): number␊
     ␊
     /** This is a const */␊
-    export const DEFAULT_COST: number␊
+    export declare const DEFAULT_COST: number␊
     ␊
     export declare function derefUint8Array(a: Uint8Array, b: Uint8ClampedArray): number␊
     ␊
@@ -374,9 +372,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export declare function eitherStringOrNumber(input: string | number): number␊
     ␊
-    export declare const enum Empty {␊
-    ␊
-    }␊
+    export declare const enum Empty {}␊
     ␊
     export declare function enumToI32(e: CustomNumEnum): number␊
     ␊
@@ -422,7 +418,7 @@ Generated by [AVA](https://avajs.dev).
       /** Kills birds */␊
       Cat = 1,␊
       /** Tasty */␊
-      Duck = 2␊
+      Duck = 2,␊
     }␊
     ␊
     export declare function listObjKeys(obj: object): Array<string>␊
@@ -519,7 +515,7 @@ Generated by [AVA](https://avajs.dev).
     export declare const enum Status {␊
       Pristine = 'Pristine',␊
       Loading = 'Loading',␊
-      Ready = 'Ready'␊
+      Ready = 'Ready',␊
     }␊
     ␊
     export interface StrictObject {␊
@@ -695,9 +691,7 @@ Generated by [AVA](https://avajs.dev).
     }␊
     export type Blake2bHasher = Blake2BHasher␊
     ␊
-    export declare class Blake2BKey {␊
-    ␊
-    }␊
+    export declare class Blake2BKey {}␊
     export type Blake2bKey = Blake2BKey␊
     ␊
     export declare class ClassWithFactory {␊
@@ -810,7 +804,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export declare enum ALIAS {␊
       A = 0,␊
-      B = 1␊
+      B = 1,␊
     }␊
     ␊
     export interface AliasedStruct {␊
@@ -898,7 +892,7 @@ Generated by [AVA](https://avajs.dev).
       Six = 6,␊
       Eight = 8,␊
       Nine = 9,␊
-      Ten = 10␊
+      Ten = 10,␊
     }␊
     ␊
     export declare function customStatusCode(): void␊
@@ -911,7 +905,7 @@ Generated by [AVA](https://avajs.dev).
     export declare function dateToNumber(input: Date): number␊
     ␊
     /** This is a const */␊
-    export const DEFAULT_COST: number␊
+    export declare const DEFAULT_COST: number␊
     ␊
     export declare function derefUint8Array(a: Uint8Array, b: Uint8ClampedArray): number␊
     ␊
@@ -927,9 +921,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export declare function eitherStringOrNumber(input: string | number): number␊
     ␊
-    export declare enum Empty {␊
-    ␊
-    }␊
+    export declare enum Empty {}␊
     ␊
     export declare function enumToI32(e: CustomNumEnum): number␊
     ␊
@@ -975,7 +967,7 @@ Generated by [AVA](https://avajs.dev).
       /** Kills birds */␊
       Cat = 1,␊
       /** Tasty */␊
-      Duck = 2␊
+      Duck = 2,␊
     }␊
     ␊
     export declare function listObjKeys(obj: object): Array<string>␊
@@ -1069,9 +1061,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export declare function setSymbolInObj(symbol: symbol): object␊
     ␊
-    export type Status =  'Pristine'|␊
-    'Loading'|␊
-    'Ready';␊
+    export type Status = 'Pristine' | 'Loading' | 'Ready'␊
     ␊
     export interface StrictObject {␊
       name: string␊
@@ -1172,12 +1162,12 @@ Generated by [AVA](https://avajs.dev).
 
     `export declare enum Priority {␊
       Low = 0,␊
-      High = 1␊
+      High = 1,␊
     }␊
     ␊
     export declare enum Status {␊
       Active = 'Active',␊
-      Inactive = 'Inactive'␊
+      Inactive = 'Inactive',␊
     }␊
     `
 
@@ -1187,11 +1177,11 @@ Generated by [AVA](https://avajs.dev).
 
     `export declare const enum Priority {␊
       Low = 0,␊
-      High = 1␊
+      High = 1,␊
     }␊
     ␊
     export declare const enum Status {␊
       Active = 'Active',␊
-      Inactive = 'Inactive'␊
+      Inactive = 'Inactive',␊
     }␊
     `

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

@@ -71,6 +71,10 @@ test('updatePackageJson merges nested objects instead of overwriting them', asyn
     fsevents: '^2.3.3',
     '@napi-rs/fixture-darwin-arm64': '1.0.1',
   })
+
+  const written = await readFile(packageJsonPath, 'utf8')
+  t.true(written.endsWith('\n'))
+  t.false(written.endsWith('\n\n'))
 })
 
 test('statIdentitiesMatch distinguishes inodes that collide as lossy Numbers', (t) => {

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

@@ -0,0 +1,55 @@
+import test from 'ava'
+
+import { serializeJson, serializeToml, serializeYaml } from '../serialize.js'
+
+test('serializeJson uses 2-space indent and a trailing newline', (t) => {
+  t.is(
+    serializeJson({ name: 'pkg', files: ['a.node'] }),
+    `{
+  "name": "pkg",
+  "files": [
+    "a.node"
+  ]
+}
+`,
+  )
+})
+
+test('serializeJson always ends with exactly one newline', (t) => {
+  const serialized = serializeJson({ ok: true })
+  t.true(serialized.endsWith('\n'))
+  t.false(serialized.endsWith('\n\n'))
+})
+
+test('serializeToml strips the leading blank line @std/toml inserts', (t) => {
+  const serialized = serializeToml({
+    package: { name: 'demo', version: '0.1.0' },
+    dependencies: {
+      napi: { version: '3.0.0', features: ['napi4'] },
+    },
+  })
+  t.false(serialized.startsWith('\n'))
+  t.true(serialized.startsWith('[package]\n'))
+  t.true(serialized.endsWith('\n'))
+  t.false(serialized.endsWith('\n\n'))
+})
+
+test('serializeYaml always ends with a trailing newline', (t) => {
+  const serialized = serializeYaml({ on: { push: null } })
+  t.true(serialized.endsWith('\n'))
+  t.false(serialized.endsWith('\n\n'))
+})
+
+test('serializeToml does not rewrite commas inside quoted strings', (t) => {
+  const serialized = serializeToml({
+    lib: { include: ['src/a,b.rs'] },
+    package: {
+      name: 'demo',
+      description: 'uses = [a,b] in a scalar',
+    },
+  })
+  t.true(serialized.includes('include = ["src/a,b.rs"]'))
+  t.true(serialized.includes('description = "uses = [a,b] in a scalar"'))
+  t.false(serialized.includes('src/a, b.rs'))
+  t.false(serialized.includes('= [a, b]'))
+})