@napi-rs/cli 3.0.0-alpha.4 → 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/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/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.4",
+  "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.7",
-    "ava": "^5.2.0",
-    "esbuild": "^0.17.16",
-    "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": "^5.0.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": "0302e564faad54dcfe6c91c9a7f26749a6a0d8e8"
+  "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,6 +149,7 @@ class Builder {
 
     const controller = new AbortController()
 
+    const watch = this.options.watch
     const buildTask = new Promise<void>((resolve, reject) => {
       const command =
         process.env.CARGO ?? (this.options.useCross ? 'cross' : 'cargo')
@@ -157,7 +158,7 @@ class Builder {
           ...process.env,
           ...this.envs,
         },
-        stdio: 'inherit',
+        stdio: watch ? ['inherit', 'inherit', 'pipe'] : 'inherit',
         cwd: this.cwd,
         signal: controller.signal,
       })
@@ -178,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 {
@@ -207,6 +217,7 @@ class Builder {
           this.crateDir,
           '--',
           'cargo',
+          'build',
         )
         set = true
       }
@@ -452,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
@@ -523,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
@@ -547,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

@@ -198,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"

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)

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

@@ -1,8 +1,10 @@
-export function createJsBinding(localName: string, pkgName: string): string {
+export function createCjsBinding(
+  localName: string,
+  pkgName: string,
+  idents: string[],
+): string {
   return `// prettier-ignore
-/* tslint:disable */
 /* eslint-disable */
-
 /* auto-generated by NAPI-RS */
 
 const { existsSync, readFileSync } = require('fs')
@@ -253,5 +255,8 @@ if (!nativeBinding) {
   throw new Error(\`Failed to load native binding\`)
 }
 
+${idents
+  .map((ident) => `module.exports.${ident} = binding.${ident}`)
+  .join('\n')}
 `
 }

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

@@ -1,3 +1,5 @@
+import { CommonPackageJsonFields } from '../../utils/config.js'
+
 export const createPackageJson = ({
   name,
   binaryName,
@@ -13,31 +15,34 @@ export const createPackageJson = ({
   engineRequirement: string
   cliVersion: string
 }) => {
-  return `{
-  "name": "${name}",
-  "version": "1.0.0",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "license": "${license}",
-  "engines": {
-    "node": "${engineRequirement}"
-  },
-  "napi": {
-    "binaryName": "${binaryName}",
-    "targets": [
-      ${targets.map((t) => `"${t}"`).join(',\n      ')}
-    ]
-  },
-  "scripts": {
-    "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",
-    "version": "napi version"
-  },
-  "devDependencies": {
-    "@napi-rs/cli": "^${cliVersion}"
+  const content: CommonPackageJsonFields = {
+    name,
+    version: '1.0.0',
+    license,
+    engines: {
+      node: engineRequirement,
+    },
+    type: 'commonjs',
+    main: 'index.js',
+    types: 'index.d.ts',
+    module: undefined,
+    exports: undefined,
+    napi: {
+      binaryName,
+      targets,
+    },
+    scripts: {
+      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',
+      version: 'napi version',
+    },
+    devDependencies: {
+      '@napi-rs/cli': `^${cliVersion}`,
+    },
   }
-}`
+
+  return JSON.stringify(content, null, 2)
 }

package/src/commands/new.ts

@@ -94,10 +94,6 @@ export class NewCommand extends BaseNewCommand {
   }
 
   private async fetchTargets(): Promise<TargetTriple[]> {
-    if (this.enableDefaultTargets) {
-      return DEFAULT_TARGETS.concat()
-    }
-
     if (this.enableAllTargets) {
       return AVAILABLE_TARGETS.concat()
     }
@@ -107,7 +103,7 @@ export class NewCommand extends BaseNewCommand {
       type: 'checkbox',
       loop: false,
       message: 'Choose target(s) your crate will be compiled to',
-      default: DEFAULT_TARGETS,
+      default: this.enableDefaultTargets ? DEFAULT_TARGETS : [],
       choices: AVAILABLE_TARGETS,
     })
 

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

@@ -10,11 +10,11 @@ Generated by [AVA](https://avajs.dev).
 
     [
       '>= 8.6.0',
-      '>= 8.10.0 && < 9 || >= 9.3.0',
-      '>= 6.14.2 && < 7 || >= 8.11.2 && < 9 || >= 9.11.0',
-      '>= 10.16.0 && < 11 || >= 11.8.0',
-      '>= 10.17.0 && < 11 || >= 12.11.0',
-      '>= 10.20.0 && < 11 || >= 12.17.0 && < 13 || >= 14.0.0',
-      '>= 10.23.0 && < 11 || >= 12.19.0 && < 13 || >= 14.12.0',
-      '>= 12.22.0 && < 13 || >= 14.17.0 && < 15 || >= 15.12.0',
+      '>= 8.10.0 < 9 || >= 9.3.0',
+      '>= 6.14.2 < 7 || >= 8.11.2 < 9 || >= 9.11.0',
+      '>= 10.16.0 < 11 || >= 11.8.0',
+      '>= 10.17.0 < 11 || >= 12.11.0',
+      '>= 10.20.0 < 11 || >= 12.17.0 < 13 || >= 14.0.0',
+      '>= 10.23.0 < 11 || >= 12.19.0 < 13 || >= 14.12.0',
+      '>= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0',
     ]

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

@@ -36,7 +36,7 @@ test('should ident string correctly', (t) => {
 })
 
 test('should process type def correctly', async (t) => {
-  const dts = await processTypeDef(
+  const { dts } = await processTypeDef(
     join(
       fileURLToPath(import.meta.url),
       '../',

package/src/utils/config.ts

@@ -49,7 +49,7 @@ interface UserNapiConfig {
   }
 }
 
-interface CommonPackageJsonFields {
+export interface CommonPackageJsonFields {
   name: string
   version: string
   description?: string
@@ -64,6 +64,17 @@ interface CommonPackageJsonFields {
   bugs?: any
   // eslint-disable-next-line no-use-before-define
   napi?: UserNapiConfig
+  type?: 'module' | 'commonjs'
+  scripts?: Record<string, string>
+
+  // modules
+  main?: string
+  module?: string
+  types?: string
+  exports?: any
+
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
 }
 
 export type NapiConfig = Required<

package/src/utils/typegen.ts

@@ -54,6 +54,7 @@ export async function processTypeDef(
   intermediateTypeFile: string,
   header?: string,
 ) {
+  const exports: string[] = []
   const defs = await readIntermediateTypeFile(intermediateTypeFile)
   const groupedDefs = preprocessTypeDef(defs)
 
@@ -65,8 +66,23 @@ export async function processTypeDef(
       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'
@@ -87,7 +103,10 @@ export class ExternalObject<T> {
 `
   }
 
-  return header + dts
+  return {
+    dts: header + dts,
+    exports,
+  }
 }
 
 async function readIntermediateTypeFile(file: string) {

package/src/utils/version.ts

@@ -68,7 +68,7 @@ function toEngineRequirement(versions: NodeVersion[]): string {
     requirements.push(req)
   })
 
-  return requirements.join(' && ')
+  return requirements.join(' ')
 }
 
 export function napiEngineRequirement(napiVersion: NapiVersion): string {