@napi-rs/cli 3.0.0-alpha.23 → 3.0.0-alpha.25

package/src/api/templates/ci-template.ts

@@ -1,4 +1,6 @@
-export const YAML = () => `
+import type { SupportedPackageManager } from '../../utils/config.js'
+
+export const YAML = (packageManager: SupportedPackageManager) => `
 name: CI
 
 env:
@@ -32,82 +34,53 @@ jobs:
         settings:
           - host: macos-latest
             target: 'x86_64-apple-darwin'
-            build: |
-              yarn build --platform
-              strip -x *.node
+            build: ${packageManager} build --platform
           - host: windows-latest
-            build: yarn build --platform
+            build: ${packageManager} build --platform
             target: 'x86_64-pc-windows-msvc'
           - host: windows-latest
             build: |
-              yarn build --platform --target i686-pc-windows-msvc
-              yarn test
+              ${packageManager} build --platform --target i686-pc-windows-msvc
+              ${packageManager} test
             target: 'i686-pc-windows-msvc'
           - host: ubuntu-latest
             target: 'x86_64-unknown-linux-gnu'
-            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
-            build: >-
-              set -e &&\n
-              yarn build --platform --target x86_64-unknown-linux-gnu &&\n
-              strip *.node
+            build: ${packageManager} build --platform --target x86_64-unknown-linux-gnu --use-napi-cross
           - host: ubuntu-latest
             target: 'x86_64-unknown-linux-musl'
-            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
-            build: >-
-              set -e &&
-              yarn build --platform &&
-              strip *.node
+            build: ${packageManager} build --platform --target x86_64-unknown-linux-musl -x
           - host: macos-latest
             target: 'aarch64-apple-darwin'
-            build: |
-              yarn build --platform --target aarch64-apple-darwin
-              strip -x *.node
+            build: ${packageManager} build --platform --target aarch64-apple-darwin
           - host: ubuntu-latest
             target: 'aarch64-unknown-linux-gnu'
-            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian-aarch64
-            build: >-
-              set -e &&\n
-              yarn build --platform --target aarch64-unknown-linux-gnu &&\n
-              aarch64-unknown-linux-gnu-strip *.node
+            build: ${packageManager} build --platform --target aarch64-unknown-linux-gnu --use-napi-cross
           - host: ubuntu-latest
             target: 'armv7-unknown-linux-gnueabihf'
-            setup: |
-              sudo apt-get update
-              sudo apt-get install gcc-arm-linux-gnueabihf -y
-            build: |
-              yarn build --platform --target armv7-unknown-linux-gnueabihf --cross-compile
-              arm-linux-gnueabihf-strip *.node
+            build: ${packageManager} build --platform --target armv7-unknown-linux-gnueabihf --use-napi-cross
           - host: ubuntu-latest
             target: 'aarch64-linux-android'
-            build: |
-              yarn build --platform --target aarch64-linux-android
-              \${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-strip *.node
+            build: ${packageManager} build --platform --target aarch64-linux-android
           - host: ubuntu-latest
             target: 'armv7-linux-androideabi'
-            build: |
-              yarn build --platform --target armv7-linux-androideabi
-              \${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-strip *.node
+            build: ${packageManager} build --platform --target armv7-linux-androideabi
           - host: ubuntu-latest
             target: 'aarch64-unknown-linux-musl'
-            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
-            build: >-
-              set -e &&\n
-              rustup target add aarch64-unknown-linux-musl &&\n
-              yarn build --platform --target aarch64-unknown-linux-musl &&\n
-              /aarch64-linux-musl-cross/bin/aarch64-linux-musl-strip *.node
+            build: ${packageManager} build --platform --target aarch64-unknown-linux-musl -x
           - host: windows-latest
             target: 'aarch64-pc-windows-msvc'
-            build: yarn build --platform --target aarch64-pc-windows-msvc
+            build: ${packageManager} build --platform --target aarch64-pc-windows-msvc
           - host: ubuntu-latest
             target: 'riscv64gc-unknown-linux-gnu'
             setup: |
               sudo apt-get update
               sudo apt-get install gcc-riscv64-linux-gnu -y
-            build: |
-              yarn build --platform --target riscv64gc-unknown-linux-gnu
-              riscv64-linux-gnu-strip *.node
+            build: ${packageManager} build --platform --target riscv64gc-unknown-linux-gnu
+          - host: ubuntu-latest
+            target: 'wasm32-wasi-preview1-threads'
+            build: ${packageManager} build --platform --target wasm32-wasi-preview1-threads
 
-    name: stable - \${{ matrix.settings.target }} - node@18
+    name: stable - \${{ matrix.settings.target }} - node@20
     runs-on: \${{ matrix.settings.host }}
 
     steps:
@@ -115,14 +88,12 @@ jobs:
 
       - name: Setup node
         uses: actions/setup-node@v4
-        if: \${{ !matrix.settings.docker }}
         with:
-          node-version: 18
-          cache: yarn
+          node-version: 20
+          cache: ${packageManager}
 
       - name: Install
         uses: dtolnay/rust-toolchain@stable
-        if: \${{ !matrix.settings.docker }}
         with:
           toolchain: stable
           targets: \${{ matrix.settings.target }}
@@ -134,12 +105,13 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
+            ~/.napi-rs
             .cargo-cache
             target/
           key: \${{ matrix.settings.target }}-cargo-\${{ matrix.settings.host }}
 
       - uses: goto-bus-stop/setup-zig@v2
-        if: \${{ matrix.settings.target == 'armv7-unknown-linux-gnueabihf' }}
+        if: \${{ contains(matrix.settings.target, 'musl') }}
         with:
           version: 0.11.0
 
@@ -154,36 +126,35 @@ jobs:
         shell: bash
 
       - name: 'Install dependencies'
-        run: yarn install
+        run: ${packageManager} install
 
       - name: Setup node x86
         uses: actions/setup-node@v4
         if: matrix.settings.target == 'i686-pc-windows-msvc'
         with:
-          node-version: 18
-          cache: yarn
+          node-version: 20
           architecture: x86
 
-      - name: Build in docker
-        uses: addnab/docker-run-action@v3
-        if: \${{ matrix.settings.docker }}
-        with:
-          image: \${{ matrix.settings.docker }}
-          options: --user 0:0 -v \${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v \${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v \${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v \${{ github.workspace }}:/build -w /build
-          run: \${{ matrix.settings.build }}
-
       - name: 'Build'
         run: \${{ matrix.settings.build }}
-        if: \${{ !matrix.settings.docker }}
         shell: bash
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
+        if: matrix.settings.target != 'wasm32-wasi-preview1-threads'
         with:
           name: bindings-\${{ matrix.settings.target }}
           path: "*.node"
           if-no-files-found: error
 
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        if: matrix.settings.target == 'wasm32-wasi-preview1-threads'
+        with:
+          name: bindings-\${{ matrix.settings.target }}
+          path: "*.wasm"
+          if-no-files-found: error
+
   build-freebsd:
     runs-on: macos-12
     name: Build FreeBSD
@@ -191,7 +162,8 @@ jobs:
       - uses: actions/checkout@v4
       - name: Build
         id: build
-        uses: cross-platform-actions/action@v0.21.0
+        uses: cross-platform-actions/action@v0.21.1
+        timeout-minutes: 30
         env:
           DEBUG: 'napi:*'
           RUSTUP_IO_THREADS: 1
@@ -202,9 +174,9 @@ jobs:
           cpu_count: 3
           environment_variables: 'DEBUG RUSTUP_IO_THREADS'
           shell: bash
-          prepare: |
+          run: |
             sudo pkg install -y -f curl node libnghttp2 npm
-            sudo npm install -g yarn --ignore-scripts
+            sudo npm install -g ${packageManager} --ignore-scripts
             curl https://sh.rustup.rs -sSf --output rustup.sh
             sh rustup.sh -y --profile minimal --default-toolchain stable
             source "$HOME/.cargo/env"
@@ -219,15 +191,15 @@ jobs:
             whoami
             env
             freebsd-version
-            yarn install
-            yarn build
+            ${packageManager} install
+            ${packageManager} build
             strip -x *.node
             yarn test
             rm -rf node_modules
             rm -rf target
             rm -rf .yarn/cache
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: bindings-freebsd
           path: "*.node"
@@ -255,13 +227,13 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: \${{ matrix.node }}
-          cache: 'yarn'
+          cache: '${packageManager}'
 
       - name: 'Install dependencies'
-        run: yarn install
+        run: ${packageManager} install
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-\${{ matrix.settings.target }}
           path: .
@@ -271,7 +243,7 @@ jobs:
         shell: bash
 
       - name: Test bindings
-        run: yarn test
+        run: ${packageManager} test
 
   test-linux-x64-gnu-binding:
     name: Test bindings on Linux-x64-gnu - node@\${{ matrix.node }}
@@ -290,13 +262,13 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: \${{ matrix.node }}
-          cache: 'yarn'
+          cache: '${packageManager}'
 
       - name: 'Install dependencies'
-        run: yarn install
+        run: ${packageManager} install
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-unknown-linux-gnu
           path: .
@@ -330,10 +302,10 @@ jobs:
       - name: 'Install dependencies'
         run: |
           yarn config set supportedArchitectures.libc "musl"
-          yarn install
+          ${packageManager} install
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-unknown-linux-musl
           path: .
@@ -352,14 +324,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['18', '20']
+        node: ['20']
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-aarch64-unknown-linux-gnu
           path: .
@@ -372,7 +344,7 @@ jobs:
         run: |
           yarn config set supportedArchitectures.cpu "arm64"
           yarn config set supportedArchitectures.libc "glibc"
-          yarn install
+          ${packageManager} install
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -385,10 +357,7 @@ jobs:
         with:
           image: node:\${{ matrix.node }}-slim
           options: --platform linux/arm64 -v \${{ github.workspace }}:/build -w /build
-          run: |
-            set -e
-            yarn test
-            ls -la
+          run: yarn test
 
   test-linux-aarch64-musl-binding:
     name: Test bindings on aarch64-unknown-linux-musl - node@\${{ matrix.node }}
@@ -405,7 +374,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-aarch64-unknown-linux-musl
           path: .
@@ -418,7 +387,7 @@ jobs:
         run: |
           yarn config set supportedArchitectures.cpu "arm64"
           yarn config set supportedArchitectures.libc "musl"
-          yarn install
+          ${packageManager} install
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -431,9 +400,7 @@ jobs:
         with:
           image: node:\${{ matrix.node }}-alpine
           options: --platform linux/arm64 -v \${{ github.workspace }}:/build -w /build
-          run: |
-            set -e
-            yarn test
+          run: yarn test
 
   test-linux-arm-gnueabihf-binding:
     name: Test bindings on armv7-unknown-linux-gnueabihf - node@\${{ matrix.node }}
@@ -449,7 +416,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-armv7-unknown-linux-gnueabihf
           path: .
@@ -461,7 +428,7 @@ jobs:
       - name: Install dependencies
         run: |
           yarn config set supportedArchitectures.cpu "arm"
-          yarn install
+          ${packageManager} install
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -474,10 +441,7 @@ jobs:
         with:
           image: node:\${{ matrix.node }}-bullseye-slim
           options: --platform linux/arm/v7 -v \${{ github.workspace }}:/build -w /build
-          run: |
-            set -e
-            yarn test
-            ls -la
+          run: ${packageManager} test
 
   universal-macOS:
     name: Build universal macOS binary
@@ -491,33 +455,62 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 18
-          cache: yarn
+          node-version: 20
+          cache: ${packageManager}
 
       - name: 'Install dependencies'
-        run: yarn install
+        run: ${packageManager} install
 
       - name: Download macOS x64 artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-apple-darwin
           path: .
       - name: Download macOS arm64 artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bindings-aarch64-apple-darwin
           path: .
 
       - name: Combine binaries
-        run: yarn napi universalize
+        run: ${packageManager} napi universalize
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: bindings-universal-apple-darwin
           path: "*.node"
           if-no-files-found: error
 
+  test-wasi-nodejs:
+    name: Test bindings on wasi - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['18', '20']
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-wasm32-wasi-preview1-threads
+          path: .
+      - name: List packages
+        run: ls -R .
+      - uses: actions/setup-node@v4
+        with:
+          node-version: \${{ matrix.node }}
+          cache: ${packageManager}
+      - name: 'Install dependencies'
+        run: ${packageManager} install
+      - name: Test
+        run: ${packageManager} test
+        env:
+          NAPI_RS_FORCE_WASI: true
+
   publish:
     name: Publish
     runs-on: ubuntu-latest
@@ -528,6 +521,7 @@ jobs:
       - test-linux-arm-gnueabihf-binding
       - test-macOS-windows-binding
       - test-linux-aarch64-musl-binding
+      - test-wasi-nodejs
       - build-freebsd
 
     steps:
@@ -536,15 +530,15 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 18
-          cache: 'yarn'
+          node-version: 20
+          cache: '${packageManager}'
           registry-url: 'https://registry.npmjs.org'
 
       - name: 'Install dependencies'
-        run: yarn install
+        run: ${packageManager} install
 
       - name: Download all artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: artifacts
 

package/src/api/templates/ci.yml.ts

@@ -2,6 +2,7 @@ import { load, dump } from 'js-yaml'
 
 import {
   NodeArchToCpu,
+  type SupportedPackageManager,
   UniArchsByPlatform,
   parseTriple,
 } from '../../utils/index.js'
@@ -15,9 +16,13 @@ const TEST_LINUX_X64_MUSL = 'test-linux-x64-musl-binding'
 const TEST_LINUX_AARCH64_GNU = 'test-linux-aarch64-gnu-binding'
 const TEST_LINUX_AARCH64_MUSL = 'test-linux-aarch64-musl-binding'
 const TEST_LINUX_ARM_GNUEABIHF = 'test-linux-arm-gnueabihf-binding'
+const TEST_WASI = 'test-wasi-nodejs'
 const UNIVERSAL_MACOS = 'universal-macOS'
 
-export const createGithubActionsCIYml = (targets: string[]) => {
+export const createGithubActionsCIYml = (
+  targets: string[],
+  packageManager: SupportedPackageManager,
+) => {
   const allTargets = new Set(
     targets.flatMap((t) => {
       const platform = parseTriple(t)
@@ -31,7 +36,7 @@ export const createGithubActionsCIYml = (targets: string[]) => {
     }),
   )
 
-  const fullTemplate = load(YAML()) as any
+  const fullTemplate = load(YAML(packageManager)) as any
 
   const requiredSteps = []
   const enableWindowsX86 = allTargets.has('x86_64-pc-windows-msvc')
@@ -43,6 +48,7 @@ export const createGithubActionsCIYml = (targets: string[]) => {
   const enableLinuxArm7 = allTargets.has('armv7-unknown-linux-gnueabihf')
   const enableFreeBSD = allTargets.has('x86_64-unknown-freebsd')
   const enableMacOSUni = allTargets.has('universal-apple-darwin')
+  const enableWasi = allTargets.has('wasm32-wasi-preview1-threads')
   fullTemplate.jobs.build.strategy.matrix.settings =
     fullTemplate.jobs.build.strategy.matrix.settings.filter(
       ({ target }: { target: string }) => allTargets.has(target),
@@ -111,6 +117,12 @@ export const createGithubActionsCIYml = (targets: string[]) => {
     requiredSteps.push(UNIVERSAL_MACOS)
   }
 
+  if (!enableWasi) {
+    delete fullTemplate.jobs[TEST_WASI]
+  } else {
+    requiredSteps.push(TEST_WASI)
+  }
+
   fullTemplate.jobs.publish.needs = requiredSteps
 
   return dump(fullTemplate, {

package/src/api/templates/js-binding.ts

@@ -311,6 +311,21 @@ switch (platform) {
     throw new Error(\`Unsupported OS: \${platform}, architecture: \${arch}\`)
 }
 
+if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  try {
+    localFileExisted = existsSync(
+      join(__dirname, '${localName}.wasm32-wasi.wasm')
+    ) && existsSync(join(__dirname, '${localName}.wasi.cjs'))
+    if (localFileExisted) {
+      nativeBinding = require('./${localName}.wasi.cjs')
+    } else {
+      nativeBinding = require('${pkgName}-wasm32-wasi')
+    }
+  } catch {
+    // ignore
+  }
+}
+
 if (!nativeBinding) {
   if (loadError) {
     throw loadError

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 = ({
+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,
@@ -29,10 +52,10 @@ export const createPackageJson = ({
     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 +67,28 @@ 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 emnapiCoreMeta = await fetch(
+      `https://registry.npmjs.org/@emnapi/core`,
+    ).then((res) => res.json() as Promise<PackageMeta>)
+    const latest = emnapiCoreMeta['dist-tags'].latest
+    content.devDependencies!['@emnapi/core'] = `^${latest}`
+    const emnapiRuntimeMeta = await fetch(
+      `https://registry.npmjs.org/@emnapi/runtime`,
+    ).then((res) => res.json() as Promise<PackageMeta>)
+    const runtimeLatest = emnapiRuntimeMeta['dist-tags'].latest
+    content.devDependencies!['@emnapi/runtime'] = `^${runtimeLatest}`
+  }
+
   return JSON.stringify(content, null, 2)
 }

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,

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 {

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'