@napi-rs/cli 3.0.0-alpha.8 → 3.0.0-alpha.81

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`',
   })
 
@@ -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'