@napi-rs/cli 3.0.0-alpha.1 → 3.0.0-alpha.100

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,9 +51,13 @@ 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`.',
+      'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.',
   })
 
   noJsBinding?: boolean = Option.Boolean('--no-js', {
@@ -59,7 +67,7 @@ export abstract class BaseBuildCommand extends Command {
 
   dts?: string = Option.String('--dts', {
     description:
-      'Path and filename of generated type def file. Relative to `--output_dir`',
+      'Path and filename of generated type def file. Relative to `--output-dir`',
   })
 
   dtsHeader?: string = Option.String('--dts-header', {
@@ -72,6 +80,15 @@ export abstract class BaseBuildCommand extends Command {
       'Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.',
   })
 
+  dtsCache = Option.Boolean('--dts-cache', true, {
+    description: 'Whether to enable the dts cache, default to true',
+  })
+
+  esm?: boolean = Option.Boolean('--esm', {
+    description:
+      'Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.',
+  })
+
   strip?: boolean = Option.Boolean('--strip,-s', {
     description: 'Whether strip the library to achieve the minimum file size',
   })
@@ -92,14 +109,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,22 +150,29 @@ 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,
       dtsHeader: this.dtsHeader,
       noDtsHeader: this.noDtsHeader,
+      dtsCache: this.dtsCache,
+      esm: this.esm,
       strip: this.strip,
       release: this.release,
       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 +182,7 @@ export abstract class BaseBuildCommand extends Command {
 }
 
 /**
- * Build the napi-rs project
+ * Build the NAPI-RS project
  */
 export interface BuildOptions {
   /**
@@ -159,6 +197,10 @@ export interface BuildOptions {
    * Path to `Cargo.toml`
    */
   manifestPath?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    */
@@ -180,7 +222,11 @@ export interface BuildOptions {
    */
   jsPackageName?: string
   /**
-   * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.
+   * 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`.
    */
   jsBinding?: string
   /**
@@ -188,7 +234,7 @@ export interface BuildOptions {
    */
   noJsBinding?: boolean
   /**
-   * Path and filename of generated type def file. Relative to `--output_dir`
+   * Path and filename of generated type def file. Relative to `--output-dir`
    */
   dts?: string
   /**
@@ -199,6 +245,16 @@ export interface BuildOptions {
    * Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.
    */
   noDtsHeader?: boolean
+  /**
+   * Whether to enable the dts cache, default to true
+   *
+   * @default true
+   */
+  dtsCache?: boolean
+  /**
+   * Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.
+   */
+  esm?: boolean
   /**
    * Whether strip the library to achieve the minimum file size
    */
@@ -219,12 +275,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
   /**
@@ -240,3 +308,10 @@ export interface BuildOptions {
    */
   noDefaultFeatures?: boolean
 }
+
+export function applyDefaultBuildOptions(options: BuildOptions) {
+  return {
+    dtsCache: true,
+    ...options,
+  }
+}

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

@@ -10,7 +10,7 @@ export abstract class BaseNewCommand extends Command {
     description: 'Create a new project with pre-configured boilerplate',
   })
 
-  $$path = Option.String({ required: true })
+  $$path = Option.String({ required: false })
 
   $$name?: string = Option.String('--name,-n', {
     description:
@@ -22,6 +22,10 @@ export abstract class BaseNewCommand extends Command {
     description: 'The minimum Node-API version to support',
   })
 
+  packageManager = Option.String('--package-manager', 'yarn', {
+    description: 'The package manager to use. Only support yarn 4.x for now.',
+  })
+
   license = Option.String('--license,-l', 'MIT', {
     description: 'License for open-sourced project',
   })
@@ -47,6 +51,11 @@ export abstract class BaseNewCommand extends Command {
     description: 'Whether generate preconfigured GitHub Actions workflow',
   })
 
+  testFramework = Option.String('--test-framework', 'ava', {
+    description:
+      'The JavaScript test framework to use, only support `ava` for now',
+  })
+
   dryRun = Option.Boolean('--dry-run', false, {
     description: 'Whether to run the command in dry-run mode',
   })
@@ -56,12 +65,14 @@ export abstract class BaseNewCommand extends Command {
       path: this.$$path,
       name: this.$$name,
       minNodeApiVersion: this.minNodeApiVersion,
+      packageManager: this.packageManager,
       license: this.license,
       targets: this.targets,
       enableDefaultTargets: this.enableDefaultTargets,
       enableAllTargets: this.enableAllTargets,
       enableTypeDef: this.enableTypeDef,
       enableGithubActions: this.enableGithubActions,
+      testFramework: this.testFramework,
       dryRun: this.dryRun,
     }
   }
@@ -72,9 +83,9 @@ 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
+  path?: string
   /**
    * The name of the project, default to the name of the directory if not provided
    */
@@ -85,6 +96,12 @@ export interface NewOptions {
    * @default 4
    */
   minNodeApiVersion?: number
+  /**
+   * The package manager to use. Only support yarn 4.x for now.
+   *
+   * @default 'yarn'
+   */
+  packageManager?: string
   /**
    * License for open-sourced project
    *
@@ -121,6 +138,12 @@ export interface NewOptions {
    * @default true
    */
   enableGithubActions?: boolean
+  /**
+   * The JavaScript test framework to use, only support `ava` for now
+   *
+   * @default 'ava'
+   */
+  testFramework?: string
   /**
    * Whether to run the command in dry-run mode
    *
@@ -132,12 +155,14 @@ export interface NewOptions {
 export function applyDefaultNewOptions(options: NewOptions) {
   return {
     minNodeApiVersion: 4,
+    packageManager: 'yarn',
     license: 'MIT',
     targets: [],
     enableDefaultTargets: true,
     enableAllTargets: false,
     enableTypeDef: true,
     enableGithubActions: true,
+    testFramework: 'ava',
     dryRun: false,
     ...options,
   }

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,15 +15,19 @@ 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`',
   })
 
-  npmDir = Option.String('--npm-dir', 'npm', {
+  npmDir = Option.String('--npm-dir,-p', 'npm', {
     description: 'Path to the folder where the npm packages put',
   })
 
-  tagStyle = Option.String('--tag-style', 'lerna', {
+  tagStyle = Option.String('--tag-style,--tagstyle,-t', 'lerna', {
     description: 'git tag style, `npm` or `lerna`',
   })
 
@@ -39,6 +43,10 @@ export abstract class BasePrePublishCommand extends Command {
     description: 'Existing GitHub release id',
   })
 
+  skipOptionalPublish = Option.Boolean('--skip-optional-publish', false, {
+    description: 'Whether skip optionalDependencies packages publish',
+  })
+
   dryRun = Option.Boolean('--dry-run', false, {
     description: 'Dry run without touching file system',
   })
@@ -46,12 +54,14 @@ export abstract class BasePrePublishCommand extends Command {
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       npmDir: this.npmDir,
       tagStyle: this.tagStyle,
       ghRelease: this.ghRelease,
       ghReleaseName: this.ghReleaseName,
       ghReleaseId: this.ghReleaseId,
+      skipOptionalPublish: this.skipOptionalPublish,
       dryRun: this.dryRun,
     }
   }
@@ -67,6 +77,10 @@ export interface PrePublishOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *
@@ -99,6 +113,12 @@ export interface PrePublishOptions {
    * Existing GitHub release id
    */
   ghReleaseId?: string
+  /**
+   * Whether skip optionalDependencies packages publish
+   *
+   * @default false
+   */
+  skipOptionalPublish?: boolean
   /**
    * Dry run without touching file system
    *
@@ -114,6 +134,7 @@ export function applyDefaultPrePublishOptions(options: PrePublishOptions) {
     npmDir: 'npm',
     tagStyle: 'lerna',
     ghRelease: true,
+    skipOptionalPublish: false,
     dryRun: false,
     ...options,
   }

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'