@napi-rs/cli 3.0.0-alpha.2 → 3.0.0-alpha.4

package/dist/utils/target.js

@@ -14,6 +14,7 @@ export const AVAILABLE_TARGETS = [
     'armv7-unknown-linux-gnueabihf',
     'armv7-linux-androideabi',
     'universal-apple-darwin',
+    'riscv64gc-unknown-linux-gnu',
 ];
 export const DEFAULT_TARGETS = [
     'x86_64-apple-darwin',
@@ -22,18 +23,21 @@ export const DEFAULT_TARGETS = [
 ];
 export const TARGET_LINKER = {
     'aarch64-unknown-linux-musl': 'aarch64-linux-musl-gcc',
+    'riscv64gc-unknown-linux-gnu': 'riscv64-linux-gnu-gcc',
 };
 const CpuToNodeArch = {
     x86_64: 'x64',
     aarch64: 'arm64',
     i686: 'ia32',
     armv7: 'arm',
+    riscv64gc: 'riscv64',
 };
 export const NodeArchToCpu = {
     x64: 'x86_64',
     arm64: 'aarch64',
     ia32: 'i686',
     arm: 'armv7',
+    riscv64: 'riscv64gc',
 };
 const SysToNodePlatform = {
     linux: 'linux',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.4",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://github.com/napi-rs/napi-rs",
@@ -79,12 +79,12 @@
   "devDependencies": {
     "@types/inquirer": "^9.0.3",
     "@types/js-yaml": "^4.0.5",
-    "@types/lodash-es": "^4.17.6",
+    "@types/lodash-es": "^4.17.7",
     "ava": "^5.2.0",
-    "esbuild": "^0.17.14",
+    "esbuild": "^0.17.16",
     "prettier": "^2.8.7",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^5.0.4"
   },
   "funding": {
     "type": "github",
@@ -96,5 +96,5 @@
     "build:cjs": "node ./esbuild.mjs",
     "test": "ava"
   },
-  "gitHead": "c3b49f0ca6a199029c4a8a893594d0b76c2a6d01"
+  "gitHead": "0302e564faad54dcfe6c91c9a7f26749a6a0d8e8"
 }

package/src/api/build.ts

@@ -150,7 +150,9 @@ class Builder {
     const controller = new AbortController()
 
     const buildTask = new Promise<void>((resolve, reject) => {
-      const buildProcess = spawn('cargo', this.args, {
+      const command =
+        process.env.CARGO ?? (this.options.useCross ? 'cross' : 'cargo')
+      const buildProcess = spawn(command, this.args, {
         env: {
           ...process.env,
           ...this.envs,
@@ -401,6 +403,10 @@ class Builder {
       this.args.push('--target-dir', this.options.targetDir)
     }
 
+    if (this.options.profile) {
+      this.args.push('--profile', this.options.profile)
+    }
+
     if (this.options.cargoOptions?.length) {
       this.args.push(...this.options.cargoOptions)
     }
@@ -459,12 +465,10 @@ class Builder {
       return
     }
 
-    const src = join(
-      this.targetDir,
-      this.target.triple,
-      this.options.release ? 'release' : 'debug',
-      srcName,
-    )
+    const profile =
+      this.options.profile ?? (this.options.release ? 'release' : 'debug')
+    const src = join(this.targetDir, this.target.triple, profile, srcName)
+    debug(`Copy artifact from: [${src}]`)
     const dest = join(this.outputDir, destName)
 
     try {

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

@@ -71,7 +71,7 @@ jobs:
               sudo apt-get update
               sudo apt-get install gcc-arm-linux-gnueabihf -y
             build: |
-              yarn build --platform --target armv7-unknown-linux-gnueabihf
+              yarn build --platform --target armv7-unknown-linux-gnueabihf --cross-compile
               arm-linux-gnueabihf-strip *.node
           - host: ubuntu-latest
             target: 'aarch64-linux-android'
@@ -94,6 +94,14 @@ jobs:
           - host: windows-latest
             target: 'aarch64-pc-windows-msvc'
             build: yarn 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
 
     name: stable - \${{ matrix.settings.target }} - node@18
     runs-on: \${{ matrix.settings.host }}
@@ -106,7 +114,6 @@ jobs:
         if: \${{ !matrix.settings.docker }}
         with:
           node-version: 18
-          check-latest: true
           cache: yarn
 
       - name: Install
@@ -150,7 +157,6 @@ jobs:
         if: matrix.settings.target == 'i686-pc-windows-msvc'
         with:
           node-version: 18
-          check-latest: true
           cache: yarn
           architecture: x86
 
@@ -237,7 +243,7 @@ jobs:
             target: 'x86_64-apple-darwin'
           - host: windows-latest
             target: 'x86_64-pc-windows-msvc'
-        node: ['14', '16', '18']
+        node: ['16', '18']
     runs-on: \${{ matrix.settings.host }}
 
     steps:
@@ -247,7 +253,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -273,7 +278,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['16', '18']
     runs-on: ubuntu-latest
 
     steps:
@@ -283,7 +288,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -309,7 +313,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['16', '18']
     runs-on: ubuntu-latest
 
     steps:
@@ -319,7 +323,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -347,7 +350,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['16', '18']
     runs-on: ubuntu-latest
 
     steps:
@@ -368,7 +371,7 @@ jobs:
           yarn config set supportedArchitectures.cpu "arm64"
           yarn config set supportedArchitectures.libc "glibc"
           yarn install
-      
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
         with:
@@ -433,7 +436,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['16', '18']
     runs-on: ubuntu-latest
 
     steps:
@@ -483,7 +486,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          check-latest: true
           cache: yarn
 
       - name: 'Install dependencies'
@@ -493,15 +495,15 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-x86_64-apple-darwin
-          path: artifacts
+          path: .
       - name: Download macOS arm64 artifact
         uses: actions/download-artifact@v3
         with:
           name: bindings-aarch64-apple-darwin
-          path: artifacts
+          path: .
 
       - name: Combine binaries
-        run: yarn universal
+        run: yarn napi universalize
 
       - name: Upload artifact
         uses: actions/upload-artifact@v3
@@ -529,7 +531,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'

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

@@ -1,130 +1,257 @@
-/* eslint-disable @typescript-eslint/switch-exhaustiveness-check */
+export function createJsBinding(localName: string, pkgName: string): string {
+  return `// prettier-ignore
+/* tslint:disable */
+/* eslint-disable */
 
-function loadNapiModule(binaryName: string, packageName: string) {
-  const { existsSync, readFileSync } = require('fs')
-  const { join } = require('path')
-  const { platform, arch } = process
+/* auto-generated by NAPI-RS */
 
-  const candidates: string[] = []
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
 
-  function isMusl() {
-    // For Node 10
-    if (!process.report || typeof process.report.getReport !== 'function') {
-      try {
-        const lddPath = require('child_process')
-          .execSync('which ldd')
-          .toString()
-          .trim()
-        return readFileSync(lddPath, 'utf8').includes('musl')
-      } catch (e) {
-        return true
-      }
-    } else {
-      // @ts-expect-error
-      const { glibcVersionRuntime } = process.report.getReport().header
-      return !glibcVersionRuntime
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
     }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
   }
+}
 
-  switch (platform) {
-    case 'android':
-      switch (arch) {
-        case 'arm64':
-          candidates.push('android-arm64')
-          break
-        case 'arm':
-          candidates.push('android-arm-eabi')
-          break
-      }
-      break
-    case 'win32':
-      switch (arch) {
-        case 'x64':
-          candidates.push('win32-x64-msvc')
-          break
-        case 'ia32':
-          candidates.push('win32-ia32-msvc')
-          break
-        case 'arm64':
-          candidates.push('win32-arm64-msvc')
-          break
-      }
-      break
-    case 'darwin':
-      candidates.push('darwin-universal')
-      switch (arch) {
-        case 'x64':
-          candidates.push('darwin-x64')
-          break
-        case 'arm64':
-          candidates.push('darwin-arm64')
-          break
-      }
-      break
-    case 'freebsd':
-      if (arch === 'x64') {
-        candidates.push('freebsd-x64')
-      }
-      break
-    case 'linux':
-      switch (arch) {
-        case 'x64':
-          if (isMusl()) {
-            candidates.push('linux-x64-musl')
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, '${localName}.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.android-arm64.node')
           } else {
-            candidates.push('linux-x64-gnu')
+            nativeBinding = require('${pkgName}-android-arm64')
           }
-          break
-        case 'arm64':
-          if (isMusl()) {
-            candidates.push('linux-arm64-musl')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, '${localName}.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.android-arm-eabi.node')
           } else {
-            candidates.push('linux-arm64-gnu')
+            nativeBinding = require('${pkgName}-android-arm-eabi')
           }
-          break
-        case 'arm':
-          candidates.push('linux-arm-gnueabihf')
-          break
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(\`Unsupported architecture on Android \${arch}\`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('${pkgName}-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('${pkgName}-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('${pkgName}-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(\`Unsupported architecture on Windows: \${arch}\`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, '${localName}.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./${localName}.darwin-universal.node')
+      } else {
+        nativeBinding = require('${pkgName}-darwin-universal')
       }
       break
-  }
-
-  let nativeBinding: any
-  let loadError: any
-
-  for (const suffix of candidates) {
-    const localPath = join(__dirname, `${binaryName}.${suffix}.node`)
-    const pkgPath = `${packageName}-${suffix}`
-
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, '${localName}.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.darwin-x64.node')
+          } else {
+            nativeBinding = require('${pkgName}-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.darwin-arm64.node')
+          } else {
+            nativeBinding = require('${pkgName}-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(\`Unsupported architecture on macOS: \${arch}\`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(\`Unsupported architecture on FreeBSD: \${arch}\`)
+    }
+    localFileExisted = existsSync(join(__dirname, '${localName}.freebsd-x64.node'))
     try {
-      if (existsSync(localPath)) {
-        nativeBinding = require(localPath)
+      if (localFileExisted) {
+        nativeBinding = require('./${localName}.freebsd-x64.node')
       } else {
-        nativeBinding = require(pkgPath)
+        nativeBinding = require('${pkgName}-freebsd-x64')
       }
     } catch (e) {
       loadError = e
-      continue
     }
-
-    loadError = null
     break
-  }
-
-  if (!nativeBinding) {
-    if (loadError) {
-      throw loadError
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('${pkgName}-linux-arm-gnueabihf')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(\`Unsupported architecture on Linux: \${arch}\`)
     }
+    break
+  default:
+    throw new Error(\`Unsupported OS: \${platform}, architecture: \${arch}\`)
+}
 
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
   }
-
-  return nativeBinding
+  throw new Error(\`Failed to load native binding\`)
 }
 
-export function createJsBinding(localName: string, pkgName: string): string {
-  return `${loadNapiModule.toString()}
-
-module.exports = loadNapiModule('${localName}', '${pkgName}')
 `
 }

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

@@ -29,12 +29,11 @@ export const createPackageJson = ({
     ]
   },
   "scripts": {
-    "test": "yarn build:debug --platform && node -e \\"assert(require('.').sum(1, 2) === 3)\\"",
+    "test": "node -e \\"assert(require('.').sum(1, 2) === 3)\\"",
     "build": "napi build --release --platform --strip",
     "build:debug": "napi build",
     "prepublishOnly": "napi prepublish -t npm",
     "artifacts": "napi artifacts",
-    "universal": "napi universal",
     "version": "napi version"
   },
   "devDependencies": {

package/src/def/build.ts

@@ -92,11 +92,20 @@ export abstract class BaseBuildCommand extends Command {
     description: 'Build the specified library or the one at cwd',
   })
 
+  profile?: string = Option.String('--profile', {
+    description: 'Build artifacts with the specified profile',
+  })
+
   crossCompile?: boolean = Option.Boolean('--cross-compile,-x', {
     description:
       '[experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform',
   })
 
+  useCross?: boolean = Option.Boolean('--use-cross', {
+    description:
+      '[experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`',
+  })
+
   watch?: boolean = Option.Boolean('--watch,-w', {
     description:
       'watch the crate changes and build continiously with `cargo-watch` crates',
@@ -134,7 +143,9 @@ export abstract class BaseBuildCommand extends Command {
       verbose: this.verbose,
       bin: this.bin,
       package: this.package,
+      profile: this.profile,
       crossCompile: this.crossCompile,
+      useCross: this.useCross,
       watch: this.watch,
       features: this.features,
       allFeatures: this.allFeatures,
@@ -219,10 +230,18 @@ export interface BuildOptions {
    * Build the specified library or the one at cwd
    */
   package?: string
+  /**
+   * Build artifacts with the specified profile
+   */
+  profile?: string
   /**
    * [experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform
    */
   crossCompile?: boolean
+  /**
+   * [experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`
+   */
+  useCross?: boolean
   /**
    * watch the crate changes and build continiously with `cargo-watch` crates
    */

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

@@ -107,4 +107,11 @@ Generated by [AVA](https://avajs.dev).
         platformArchABI: 'darwin-universal',
         triple: 'universal-apple-darwin',
       },
+      {
+        abi: 'gnu',
+        arch: 'riscv64',
+        platform: 'linux',
+        platformArchABI: 'linux-riscv64-gnu',
+        triple: 'riscv64gc-unknown-linux-gnu',
+      },
     ]