@napi-rs/cli 3.0.0-alpha.3 → 3.0.0-alpha.31

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'

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,18 @@ 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',
+      },
+      {
+        abi: 'wasi',
+        arch: 'wasm32',
+        platform: 'wasi',
+        platformArchABI: 'wasm32-wasi',
+        triple: 'wasm32-wasi-preview1-threads',
+      },
     ]