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

package/dist/utils/__tests__/typegen.spec.js

@@ -32,6 +32,6 @@ test('should ident string correctly', (t) => {
     t.snapshot(correctStringIdent(input, 2), 'original ident is 2');
 });
 test('should process type def correctly', async (t) => {
-    const dts = await processTypeDef(join(fileURLToPath(import.meta.url), '../', '__fixtures__', 'napi_type_def'));
+    const { dts } = await processTypeDef(join(fileURLToPath(import.meta.url), '../', '__fixtures__', 'napi_type_def'));
     t.snapshot(dts);
 });

package/dist/utils/ci.js

@@ -83,4 +83,13 @@ export const CIConfig = {
         ],
         test: false,
     },
+    'riscv64gc-unknown-linux-gnu': {
+        host: 'ubuntu-latest',
+        build_setup: [
+            'sudo apt-get update',
+            'sudo apt-get install g++-riscv64-linux-gnu gcc-riscv64-linux-gnu -y',
+        ],
+        // No official nodejs docker image for riscv64
+        test: false,
+    },
 };

package/dist/utils/config.d.ts

@@ -42,7 +42,7 @@ interface UserNapiConfig {
         additional?: string[];
     };
 }
-interface CommonPackageJsonFields {
+export interface CommonPackageJsonFields {
     name: string;
     version: string;
     description?: string;
@@ -56,6 +56,14 @@ interface CommonPackageJsonFields {
     publishConfig?: any;
     bugs?: any;
     napi?: UserNapiConfig;
+    type?: 'module' | 'commonjs';
+    scripts?: Record<string, string>;
+    main?: string;
+    module?: string;
+    types?: string;
+    exports?: any;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
 }
 export type NapiConfig = Required<Pick<UserNapiConfig, 'binaryName' | 'packageName' | 'npmClient'>> & {
     targets: Target[];

package/dist/utils/target.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" resolution-mode="require"/>
-export declare const AVAILABLE_TARGETS: readonly ["aarch64-apple-darwin", "aarch64-linux-android", "aarch64-unknown-linux-gnu", "aarch64-unknown-linux-musl", "aarch64-pc-windows-msvc", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-unknown-freebsd", "i686-pc-windows-msvc", "armv7-unknown-linux-gnueabihf", "armv7-linux-androideabi", "universal-apple-darwin"];
+export declare const AVAILABLE_TARGETS: readonly ["aarch64-apple-darwin", "aarch64-linux-android", "aarch64-unknown-linux-gnu", "aarch64-unknown-linux-musl", "aarch64-pc-windows-msvc", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-unknown-freebsd", "i686-pc-windows-msvc", "armv7-unknown-linux-gnueabihf", "armv7-linux-androideabi", "universal-apple-darwin", "riscv64gc-unknown-linux-gnu"];
 export type TargetTriple = (typeof AVAILABLE_TARGETS)[number];
 export declare const DEFAULT_TARGETS: readonly ["x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu"];
 export declare const TARGET_LINKER: Record<string, string>;
-type NodeJSArch = 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64' | 'universal';
+type NodeJSArch = 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 'riscv64' | 's390' | 's390x' | 'x32' | 'x64' | 'universal';
 export declare const NodeArchToCpu: Record<string, string>;
 export declare const UniArchsByPlatform: Partial<Record<NodeJS.Platform, NodeJSArch[]>>;
 export interface Target {

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/dist/utils/typegen.d.ts

@@ -1,3 +1,6 @@
 export declare const DEFAULT_TYPE_DEF_HEADER = "/* auto-generated by NAPI-RS */\n/* eslint-disable */\n";
-export declare function processTypeDef(intermediateTypeFile: string, header?: string): Promise<string>;
+export declare function processTypeDef(intermediateTypeFile: string, header?: string): Promise<{
+    dts: string;
+    exports: string[];
+}>;
 export declare function correctStringIdent(src: string, ident: number): string;

package/dist/utils/typegen.js

@@ -34,6 +34,7 @@ function prettyPrint(line, ident) {
     return correctStringIdent(s, ident);
 }
 export async function processTypeDef(intermediateTypeFile, header) {
+    const exports = [];
     const defs = await readIntermediateTypeFile(intermediateTypeFile);
     const groupedDefs = preprocessTypeDef(defs);
     header = header ? header + '\n' : '';
@@ -42,9 +43,24 @@ export async function processTypeDef(intermediateTypeFile, header) {
         if (namespace === TOP_LEVEL_NAMESPACE) {
             for (const def of defs) {
                 dts += prettyPrint(def, 0) + '\n\n';
+                switch (def.kind) {
+                    case TypeDefKind.Const:
+                    case TypeDefKind.Enum:
+                    case TypeDefKind.Fn:
+                    case TypeDefKind.Struct: {
+                        exports.push(def.name);
+                        if (def.original_name && def.original_name !== def.name) {
+                            exports.push(def.original_name);
+                        }
+                        break;
+                    }
+                    default:
+                        break;
+                }
             }
         }
         else {
+            exports.push(namespace);
             dts += `export namespace ${namespace} {\n`;
             for (const def of defs) {
                 dts += prettyPrint(def, 2) + '\n';
@@ -62,7 +78,10 @@ export class ExternalObject<T> {
 }
 `;
     }
-    return header + dts;
+    return {
+        dts: header + dts,
+        exports,
+    };
 }
 async function readIntermediateTypeFile(file) {
     const content = await readFileAsync(file, 'utf8');

package/dist/utils/version.js

@@ -8,7 +8,7 @@ export var NapiVersion;
     NapiVersion[NapiVersion["Napi6"] = 6] = "Napi6";
     NapiVersion[NapiVersion["Napi7"] = 7] = "Napi7";
     NapiVersion[NapiVersion["Napi8"] = 8] = "Napi8";
-})(NapiVersion = NapiVersion || (NapiVersion = {}));
+})(NapiVersion || (NapiVersion = {}));
 /// because node support new napi version in some minor version updates, so we might meet such situation:
 /// `node v10.20.0` supports `napi5` and `napi6`, but `node v12.0.0` only support `napi4`,
 /// by which, we can not tell directly napi version supportness from node version directly.
@@ -52,7 +52,7 @@ function toEngineRequirement(versions) {
         req += `${i === 0 ? '' : ' || '}>= ${v.major}.${v.minor}.${v.patch}`;
         requirements.push(req);
     });
-    return requirements.join(' && ');
+    return requirements.join(' ');
 }
 export function napiEngineRequirement(napiVersion) {
     return toEngineRequirement(requiredNodeVersions(napiVersion));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.5",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://github.com/napi-rs/napi-rs",
@@ -67,24 +67,24 @@
     "url": "https://github.com/napi-rs/napi-rs/issues"
   },
   "dependencies": {
-    "@octokit/rest": "^19.0.7",
-    "clipanion": "^3.2.0",
-    "colorette": "^2.0.19",
+    "@octokit/rest": "^20.0.1",
+    "clipanion": "^3.2.1",
+    "colorette": "^2.0.20",
     "debug": "^4.3.4",
-    "inquirer": "^9.1.5",
+    "inquirer": "^9.2.8",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
-    "typanion": "^3.12.1"
+    "typanion": "^3.13.0"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.3",
     "@types/js-yaml": "^4.0.5",
-    "@types/lodash-es": "^4.17.6",
-    "ava": "^5.2.0",
-    "esbuild": "^0.17.14",
-    "prettier": "^2.8.7",
+    "@types/lodash-es": "^4.17.8",
+    "ava": "^5.3.1",
+    "esbuild": "^0.18.13",
+    "prettier": "^3.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^5.1.6"
   },
   "funding": {
     "type": "github",
@@ -94,7 +94,7 @@
     "codegen": "node --loader ts-node/esm/transpile-only ./codegen/index.ts",
     "build": "tsc && yarn build:cjs",
     "build:cjs": "node ./esbuild.mjs",
-    "test": "ava"
+    "test": "node --loader ts-node/esm/transpile-only ../node_modules/ava/entrypoints/cli.mjs"
   },
-  "gitHead": "b5c3c0575559f9c99d7747f3163476afe7e89a6c"
+  "gitHead": "cbed8fceb2996af195085aa13a94ff779879b999"
 }

package/src/api/artifacts.ts

@@ -30,8 +30,8 @@ export async function collectArtifacts(userOptions: ArtifactsOptions) {
   const universalSourceBins = new Set(
     targets
       .filter((platform) => platform.arch === 'universal')
-      .flatMap((p) =>
-        UniArchsByPlatform[p.platform]?.map((a) => `${p.platform}-${a}`),
+      .flatMap(
+        (p) => UniArchsByPlatform[p.platform]?.map((a) => `${p.platform}-${a}`),
       )
       .filter(Boolean) as string[],
   )

package/src/api/build.ts

@@ -28,7 +28,7 @@ import {
   writeFileAsync,
 } from '../utils/index.js'
 
-import { createJsBinding } from './templates/index.js'
+import { createCjsBinding } from './templates/index.js'
 
 const debug = debugFactory('build')
 
@@ -149,13 +149,16 @@ class Builder {
 
     const controller = new AbortController()
 
+    const watch = this.options.watch
     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,
         },
-        stdio: 'inherit',
+        stdio: watch ? ['inherit', 'inherit', 'pipe'] : 'inherit',
         cwd: this.cwd,
         signal: controller.signal,
       })
@@ -176,6 +179,15 @@ class Builder {
           }),
         )
       })
+
+      // watch mode only, they are piped through stderr
+      buildProcess.stderr?.on('data', (data) => {
+        const output = data.toString()
+        console.error(output)
+        if (/Finished\s(dev|release)/.test(output)) {
+          this.postBuild().catch(() => {})
+        }
+      })
     })
 
     return {
@@ -205,6 +217,7 @@ class Builder {
           this.crateDir,
           '--',
           'cargo',
+          'build',
         )
         set = true
       }
@@ -401,6 +414,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)
     }
@@ -446,8 +463,8 @@ class Builder {
 
     // only for cdylib
     if (this.cdyLibName) {
-      await this.generateTypeDef()
-      await this.writeJsBinding()
+      const idents = await this.generateTypeDef()
+      await this.writeJsBinding(idents)
     }
 
     return this.outputs
@@ -459,12 +476,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 {
@@ -519,12 +534,12 @@ class Builder {
 
   private async generateTypeDef() {
     if (!(await fileExists(this.envs.TYPE_DEF_TMP_PATH))) {
-      return
+      return []
     }
 
     const dest = join(this.outputDir, this.options.dts ?? 'index.d.ts')
 
-    const dts = await processTypeDef(
+    const { dts, exports } = await processTypeDef(
       this.envs.TYPE_DEF_TMP_PATH,
       !this.options.noDtsHeader
         ? this.options.dtsHeader ?? DEFAULT_TYPE_DEF_HEADER
@@ -543,21 +558,33 @@ class Builder {
       debug.error('Failed to write type def file')
       debug.error(e as Error)
     }
+
+    return exports
   }
 
-  private async writeJsBinding() {
-    if (!this.options.platform || this.options.noJsBinding) {
+  private async writeJsBinding(idents: string[]) {
+    if (
+      !this.options.platform ||
+      // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+      this.options.noJsBinding ||
+      idents.length === 0
+    ) {
       return
     }
 
-    const dest = join(this.outputDir, this.options.jsBinding ?? 'index.js')
+    const name = parse(this.options.jsBinding ?? 'index.js').name
 
-    const js = createJsBinding(this.config.binaryName, this.config.packageName)
+    const cjs = createCjsBinding(
+      this.config.binaryName,
+      this.config.packageName,
+      idents,
+    )
 
     try {
+      const dest = join(this.outputDir, `${name}.js`)
       debug('Writing js binding to:')
       debug('  %i', dest)
-      await writeFileAsync(dest, js, 'utf-8')
+      await writeFileAsync(dest, cjs, 'utf-8')
       this.outputs.push({
         kind: 'js',
         path: dest,

package/src/api/pre-publish.ts

@@ -129,11 +129,14 @@ export async function prePublish(userOptions: PrePublishOptions) {
   if (!options.dryRun) {
     await version(userOptions)
     await updatePackageJson(packageJsonPath, {
-      optionalDependencies: targets.reduce((deps, target) => {
-        deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
-
-        return deps
-      }, {} as Record<string, string>),
+      optionalDependencies: targets.reduce(
+        (deps, target) => {
+          deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
+
+          return deps
+        },
+        {} as Record<string, string>,
+      ),
     })
   }
 

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

@@ -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
 
@@ -192,9 +198,7 @@ jobs:
           usesh: true
           mem: 3000
           prepare: |
-            pkg install -y -f curl node libnghttp2
-            curl -qL https://www.npmjs.com/install.sh | sh
-            npm install --location=global --ignore-scripts yarn
+            pkg install -y -f curl node libnghttp2 npm yarn
             curl https://sh.rustup.rs -sSf --output rustup.sh
             sh rustup.sh -y --profile minimal --default-toolchain beta
             export PATH="/usr/local/cargo/bin:$PATH"
@@ -247,7 +251,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -283,7 +286,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -319,7 +321,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node }}
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'
@@ -368,7 +369,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:
@@ -483,7 +484,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          check-latest: true
           cache: yarn
 
       - name: 'Install dependencies'
@@ -529,7 +529,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          check-latest: true
           cache: 'yarn'
 
       - name: 'Install dependencies'

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

@@ -63,10 +63,16 @@ export const createGithubActionsCIYml = (
   if (!enableWindowsX86 && !enableMacOSX86) {
     delete fullTemplate.jobs[TEST_MACOS_WINDOWS]
   } else {
-    const filterTarget = enableWindowsX86 ? 'macos-latest' : 'windows-latest'
+    const filterTargets = new Set<string>()
+    if (enableWindowsX86) {
+      filterTargets.add('windows-latest')
+    }
+    if (enableMacOSUni || enableMacOSX86) {
+      filterTargets.add('macos-latest')
+    }
     fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings =
       fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings.filter(
-        ({ host }: { host: string; target: string }) => host !== filterTarget,
+        ({ host }: { host: string; target: string }) => filterTargets.has(host),
       )
 
     requiredSteps.push(TEST_MACOS_WINDOWS)