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

package/dist/api/build.js

@@ -4,7 +4,7 @@ import { tmpdir } from 'os';
 import { parse, join, resolve } from 'path';
 import * as colors from 'colorette';
 import { CLI_VERSION, copyFileAsync, debugFactory, DEFAULT_TYPE_DEF_HEADER, fileExists, getSystemDefaultTarget, getTargetLinker, mkdirAsync, parseMetadata, parseTriple, processTypeDef, readNapiConfig, targetToEnvVar, tryInstallCargoBinary, unlinkAsync, writeFileAsync, } from '../utils/index.js';
-import { createJsBinding } from './templates/index.js';
+import { createCjsBinding } from './templates/index.js';
 const debug = debugFactory('build');
 export async function buildProject(options) {
     debug('napi build command receive options: %O', options);
@@ -89,6 +89,7 @@ class Builder {
         debug(`Start building crate: ${this.crate.name}`);
         debug('  %i', `cargo ${this.args.join(' ')}`);
         const controller = new AbortController();
+        const watch = this.options.watch;
         const buildTask = new Promise((resolve, reject) => {
             const command = process.env.CARGO ?? (this.options.useCross ? 'cross' : 'cargo');
             const buildProcess = spawn(command, this.args, {
@@ -96,7 +97,7 @@ class Builder {
                     ...process.env,
                     ...this.envs,
                 },
-                stdio: 'inherit',
+                stdio: watch ? ['inherit', 'inherit', 'pipe'] : 'inherit',
                 cwd: this.cwd,
                 signal: controller.signal,
             });
@@ -114,6 +115,14 @@ class Builder {
                     cause: e,
                 }));
             });
+            // 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 {
             task: buildTask.then(() => this.postBuild()),
@@ -133,7 +142,7 @@ class Builder {
                 // ===>
                 // cargo watch [...] -- build --target x86_64-unknown-linux-gnu
                 // cargo watch [...] -- zigbuild --target x86_64-unknown-linux-gnu
-                this.args.push('watch', '--why', '-i', '*.{js,ts,node}', '-w', this.crateDir, '--', 'cargo');
+                this.args.push('watch', '--why', '-i', '*.{js,ts,node}', '-w', this.crateDir, '--', 'cargo', 'build');
                 set = true;
             }
         }
@@ -325,8 +334,8 @@ class Builder {
         await this.copyArtifact();
         // only for cdylib
         if (this.cdyLibName) {
-            await this.generateTypeDef();
-            await this.writeJsBinding();
+            const idents = await this.generateTypeDef();
+            await this.writeJsBinding(idents);
         }
         return this.outputs;
     }
@@ -384,10 +393,10 @@ class Builder {
     }
     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(this.envs.TYPE_DEF_TMP_PATH, !this.options.noDtsHeader
+        const { dts, exports } = await processTypeDef(this.envs.TYPE_DEF_TMP_PATH, !this.options.noDtsHeader
             ? this.options.dtsHeader ?? DEFAULT_TYPE_DEF_HEADER
             : '');
         try {
@@ -403,17 +412,22 @@ class Builder {
             debug.error('Failed to write type def file');
             debug.error(e);
         }
+        return exports;
     }
-    async writeJsBinding() {
-        if (!this.options.platform || this.options.noJsBinding) {
+    async writeJsBinding(idents) {
+        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 js = createJsBinding(this.config.binaryName, this.config.packageName);
+        const name = parse(this.options.jsBinding ?? 'index.js').name;
+        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/dist/api/templates/ci-template.js

@@ -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/dist/api/templates/ci.yml.js

@@ -44,9 +44,15 @@ export const createGithubActionsCIYml = (binaryName, targets) => {
         delete fullTemplate.jobs[TEST_MACOS_WINDOWS];
     }
     else {
-        const filterTarget = enableWindowsX86 ? 'macos-latest' : 'windows-latest';
+        const filterTargets = new Set();
+        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 !== filterTarget);
+            fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings.filter(({ host }) => filterTargets.has(host));
         requiredSteps.push(TEST_MACOS_WINDOWS);
     }
     if (!enableLinuxX86Gnu) {

package/dist/api/templates/js-binding.d.ts

@@ -1 +1 @@
-export declare function createJsBinding(localName: string, pkgName: string): string;
+export declare function createCjsBinding(localName: string, pkgName: string, idents: string[]): string;

package/dist/api/templates/js-binding.js

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

package/dist/api/templates/package.json.js

@@ -1,29 +1,31 @@
 export const createPackageJson = ({ name, binaryName, targets, license, engineRequirement, cliVersion, }) => {
-    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 = {
+        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/dist/commands/artifacts.js

@@ -1,7 +1,7 @@
 import { Command } from 'clipanion';
 import { collectArtifacts } from '../api/artifacts.js';
 import { BaseArtifactsCommand } from '../def/artifacts.js';
-class ArtifactsCommand extends BaseArtifactsCommand {
+export class ArtifactsCommand extends BaseArtifactsCommand {
     static usage = Command.Usage({
         description: 'Copy artifacts from Github Actions into specified dir',
         examples: [
@@ -17,4 +17,3 @@ e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.node`,
         await collectArtifacts(this.getOptions());
     }
 }
-export { ArtifactsCommand };

package/dist/commands/help.js

@@ -4,10 +4,9 @@ import { Command } from 'clipanion';
  *
  * Paths: `-h`, `--help`
  */
-class HelpCommand extends Command {
+export class HelpCommand extends Command {
     static paths = [[`-h`], [`--help`]];
     async execute() {
         await this.context.stdout.write(this.cli.usage());
     }
 }
-export { HelpCommand };

package/dist/commands/new.js

@@ -75,9 +75,6 @@ export class NewCommand extends BaseNewCommand {
             .then(({ minNodeApiVersion }) => minNodeApiVersion);
     }
     async fetchTargets() {
-        if (this.enableDefaultTargets) {
-            return DEFAULT_TARGETS.concat();
-        }
         if (this.enableAllTargets) {
             return AVAILABLE_TARGETS.concat();
         }
@@ -86,7 +83,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,
         });
         return targets;

package/dist/def/artifacts.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseArtifactsCommand extends Command {
+export class BaseArtifactsCommand extends Command {
     static paths = [['artifacts']];
     static usage = Command.Usage({
         description: 'Copy artifacts from Github Actions into npm packages and ready to publish',
@@ -27,7 +27,6 @@ class BaseArtifactsCommand extends Command {
         };
     }
 }
-export { BaseArtifactsCommand };
 export function applyDefaultArtifactsOptions(options) {
     return {
         cwd: process.cwd(),

package/dist/def/build.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseBuildCommand extends Command {
+export class BaseBuildCommand extends Command {
     static paths = [['build']];
     static usage = Command.Usage({
         description: 'Build the napi-rs project',
@@ -111,4 +111,3 @@ class BaseBuildCommand extends Command {
         };
     }
 }
-export { BaseBuildCommand };

package/dist/def/create-npm-dirs.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseCreateNpmDirsCommand extends Command {
+export class BaseCreateNpmDirsCommand extends Command {
     static paths = [['create-npm-dirs']];
     static usage = Command.Usage({
         description: 'Create npm package dirs for different platforms',
@@ -27,7 +27,6 @@ class BaseCreateNpmDirsCommand extends Command {
         };
     }
 }
-export { BaseCreateNpmDirsCommand };
 export function applyDefaultCreateNpmDirsOptions(options) {
     return {
         cwd: process.cwd(),

package/dist/def/new.js

@@ -2,7 +2,7 @@
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
 import * as typanion from 'typanion';
-class BaseNewCommand extends Command {
+export class BaseNewCommand extends Command {
     static paths = [['new']];
     static usage = Command.Usage({
         description: 'Create a new project with pre-configured boilerplate',
@@ -51,7 +51,6 @@ class BaseNewCommand extends Command {
         };
     }
 }
-export { BaseNewCommand };
 export function applyDefaultNewOptions(options) {
     return {
         minNodeApiVersion: 4,

package/dist/def/pre-publish.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BasePrePublishCommand extends Command {
+export class BasePrePublishCommand extends Command {
     static paths = [['pre-publish']];
     static usage = Command.Usage({
         description: 'Update package.json and copy addons into per platform packages',
@@ -43,7 +43,6 @@ class BasePrePublishCommand extends Command {
         };
     }
 }
-export { BasePrePublishCommand };
 export function applyDefaultPrePublishOptions(options) {
     return {
         cwd: process.cwd(),

package/dist/def/rename.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseRenameCommand extends Command {
+export class BaseRenameCommand extends Command {
     static paths = [['rename']];
     static usage = Command.Usage({
         description: 'Rename the napi-rs project',
@@ -47,7 +47,6 @@ class BaseRenameCommand extends Command {
         };
     }
 }
-export { BaseRenameCommand };
 export function applyDefaultRenameOptions(options) {
     return {
         cwd: process.cwd(),

package/dist/def/universalize.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseUniversalizeCommand extends Command {
+export class BaseUniversalizeCommand extends Command {
     static paths = [['universalize']];
     static usage = Command.Usage({
         description: 'Combile built binaries into one universal binary',
@@ -23,7 +23,6 @@ class BaseUniversalizeCommand extends Command {
         };
     }
 }
-export { BaseUniversalizeCommand };
 export function applyDefaultUniversalizeOptions(options) {
     return {
         cwd: process.cwd(),

package/dist/def/version.js

@@ -1,7 +1,7 @@
 // This file is generated by codegen/index.ts
 // Do not edit this file manually
 import { Command, Option } from 'clipanion';
-class BaseVersionCommand extends Command {
+export class BaseVersionCommand extends Command {
     static paths = [['version']];
     static usage = Command.Usage({
         description: 'Update version in created npm packages',
@@ -23,7 +23,6 @@ class BaseVersionCommand extends Command {
         };
     }
 }
-export { BaseVersionCommand };
 export function applyDefaultVersionOptions(options) {
     return {
         cwd: process.cwd(),