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

package/src/def/build.ts

@@ -6,7 +6,7 @@ export abstract class BaseBuildCommand extends Command {
   static paths = [['build']]
 
   static usage = Command.Usage({
-    description: 'Build the napi-rs project',
+    description: 'Build the NAPI-RS project',
   })
 
   target?: string = Option.String('--target,-t', {
@@ -23,6 +23,10 @@ export abstract class BaseBuildCommand extends Command {
     description: 'Path to `Cargo.toml`',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath?: string = Option.String('--package-json-path', {
     description: 'Path to `package.json`',
   })
@@ -47,6 +51,10 @@ export abstract class BaseBuildCommand extends Command {
       'Package name in generated js binding file. Only works with `--platform` flag',
   })
 
+  constEnum?: boolean = Option.Boolean('--const-enum', {
+    description: 'Whether generate const enum for typescript bindings',
+  })
+
   jsBinding?: string = Option.String('--js', {
     description:
       'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.',
@@ -92,14 +100,28 @@ 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`',
+  })
+
+  useNapiCross?: boolean = Option.Boolean('--use-napi-cross', {
+    description:
+      '[experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.',
+  })
+
   watch?: boolean = Option.Boolean('--watch,-w', {
     description:
-      'watch the crate changes and build continiously with `cargo-watch` crates',
+      'watch the crate changes and build continuously with `cargo-watch` crates',
   })
 
   features?: string[] = Option.Array('--features,-F', {
@@ -119,11 +141,13 @@ export abstract class BaseBuildCommand extends Command {
       target: this.target,
       cwd: this.cwd,
       manifestPath: this.manifestPath,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       targetDir: this.targetDir,
       outputDir: this.outputDir,
       platform: this.platform,
       jsPackageName: this.jsPackageName,
+      constEnum: this.constEnum,
       jsBinding: this.jsBinding,
       noJsBinding: this.noJsBinding,
       dts: this.dts,
@@ -134,7 +158,10 @@ export abstract class BaseBuildCommand extends Command {
       verbose: this.verbose,
       bin: this.bin,
       package: this.package,
+      profile: this.profile,
       crossCompile: this.crossCompile,
+      useCross: this.useCross,
+      useNapiCross: this.useNapiCross,
       watch: this.watch,
       features: this.features,
       allFeatures: this.allFeatures,
@@ -144,7 +171,7 @@ export abstract class BaseBuildCommand extends Command {
 }
 
 /**
- * Build the napi-rs project
+ * Build the NAPI-RS project
  */
 export interface BuildOptions {
   /**
@@ -159,6 +186,10 @@ export interface BuildOptions {
    * Path to `Cargo.toml`
    */
   manifestPath?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    */
@@ -179,6 +210,10 @@ export interface BuildOptions {
    * Package name in generated js binding file. Only works with `--platform` flag
    */
   jsPackageName?: string
+  /**
+   * Whether generate const enum for typescript bindings
+   */
+  constEnum?: boolean
   /**
    * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.
    */
@@ -219,12 +254,24 @@ 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
   /**
-   * watch the crate changes and build continiously with `cargo-watch` crates
+   * [experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`
+   */
+  useCross?: boolean
+  /**
+   * [experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.
+   */
+  useNapiCross?: boolean
+  /**
+   * watch the crate changes and build continuously with `cargo-watch` crates
    */
   watch?: boolean
   /**

package/src/def/create-npm-dirs.ts

@@ -14,6 +14,10 @@ export abstract class BaseCreateNpmDirsCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -29,6 +33,7 @@ export abstract class BaseCreateNpmDirsCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
       dryRun: this.dryRun,
@@ -46,6 +51,10 @@ export interface CreateNpmDirsOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *

package/src/def/new.ts

@@ -72,7 +72,7 @@ export abstract class BaseNewCommand extends Command {
  */
 export interface NewOptions {
   /**
-   * The path where the napi-rs project will be created.
+   * The path where the NAPI-RS project will be created.
    */
   path: string
   /**

package/src/def/pre-publish.ts

@@ -3,7 +3,7 @@
 import { Command, Option } from 'clipanion'
 
 export abstract class BasePrePublishCommand extends Command {
-  static paths = [['pre-publish']]
+  static paths = [['pre-publish, prepublish']]
 
   static usage = Command.Usage({
     description:
@@ -15,6 +15,10 @@ export abstract class BasePrePublishCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -23,7 +27,7 @@ export abstract class BasePrePublishCommand extends Command {
     description: 'Path to the folder where the npm packages put',
   })
 
-  tagStyle = Option.String('--tag-style', 'lerna', {
+  tagStyle = Option.String('--tag-style,-t', 'lerna', {
     description: 'git tag style, `npm` or `lerna`',
   })
 
@@ -46,6 +50,7 @@ export abstract class BasePrePublishCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
       tagStyle: this.tagStyle,
@@ -67,6 +72,10 @@ export interface PrePublishOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *

package/src/def/rename.ts

@@ -6,7 +6,7 @@ export abstract class BaseRenameCommand extends Command {
   static paths = [['rename']]
 
   static usage = Command.Usage({
-    description: 'Rename the napi-rs project',
+    description: 'Rename the NAPI-RS project',
   })
 
   cwd = Option.String('--cwd', process.cwd(), {
@@ -14,6 +14,10 @@ export abstract class BaseRenameCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -49,6 +53,7 @@ export abstract class BaseRenameCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
       name: this.$$name,
@@ -62,7 +67,7 @@ export abstract class BaseRenameCommand extends Command {
 }
 
 /**
- * Rename the napi-rs project
+ * Rename the NAPI-RS project
  */
 export interface RenameOptions {
   /**
@@ -71,6 +76,10 @@ export interface RenameOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *

package/src/def/universalize.ts

@@ -14,6 +14,10 @@ export abstract class BaseUniversalizeCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -26,6 +30,7 @@ export abstract class BaseUniversalizeCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       outputDir: this.outputDir,
     }
@@ -42,6 +47,10 @@ export interface UniversalizeOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *

package/src/def/version.ts

@@ -14,6 +14,10 @@ export abstract class BaseVersionCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
@@ -25,6 +29,7 @@ export abstract class BaseVersionCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
     }
@@ -41,6 +46,10 @@ export interface VersionOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *

package/src/index.ts

@@ -29,3 +29,5 @@ export class NapiCli {
   universalize = universalizeBinaries
   version = version
 }
+
+export { parseTriple } from './utils/target.js'

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

@@ -0,0 +1,97 @@
+# Snapshot report for `src/utils/__tests__/config.spec.ts`
+
+The actual snapshot is saved in `config.spec.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## should be able to read config from package.json
+
+> Snapshot 1
+
+    {
+      binaryName: 'testing',
+      npmClient: 'npm',
+      packageJson: {
+        name: '@napi-rs/testing',
+        napi: {
+          binaryName: 'testing',
+          packageName: '@napi-rs/testing',
+          targets: [
+            'x86_64-unknown-linux-gnu',
+            'x86_64-pc-windows-msvc',
+            'x86_64-apple-darwin',
+          ],
+        },
+        version: '0.0.0',
+      },
+      packageName: '@napi-rs/testing',
+      targets: [
+        {
+          abi: 'gnu',
+          arch: 'x64',
+          platform: 'linux',
+          platformArchABI: 'linux-x64-gnu',
+          triple: 'x86_64-unknown-linux-gnu',
+        },
+        {
+          abi: 'msvc',
+          arch: 'x64',
+          platform: 'win32',
+          platformArchABI: 'win32-x64-msvc',
+          triple: 'x86_64-pc-windows-msvc',
+        },
+        {
+          abi: null,
+          arch: 'x64',
+          platform: 'darwin',
+          platformArchABI: 'darwin-x64',
+          triple: 'x86_64-apple-darwin',
+        },
+      ],
+    }
+
+## should be able to read config from napi.json
+
+> Snapshot 1
+
+    {
+      binaryName: 'testing',
+      npmClient: 'npm',
+      packageJson: {
+        name: '@napi-rs/testing',
+        napi: {
+          binaryName: 'testing',
+          packageName: '@node-rs/testing',
+          targets: [
+            'x86_64-unknown-linux-gnu',
+            'x86_64-apple-darwin',
+            'aarch64-apple-darwin',
+          ],
+        },
+        version: '0.0.0',
+      },
+      packageName: '@node-rs/testing',
+      targets: [
+        {
+          abi: 'gnu',
+          arch: 'x64',
+          platform: 'linux',
+          platformArchABI: 'linux-x64-gnu',
+          triple: 'x86_64-unknown-linux-gnu',
+        },
+        {
+          abi: null,
+          arch: 'x64',
+          platform: 'darwin',
+          platformArchABI: 'darwin-x64',
+          triple: 'x86_64-apple-darwin',
+        },
+        {
+          abi: null,
+          arch: 'arm64',
+          platform: 'darwin',
+          platformArchABI: 'darwin-arm64',
+          triple: 'aarch64-apple-darwin',
+        },
+      ],
+    }

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',
+      },
     ]