fix(cli): compatible with napi artifacts -d option (#1872)

napi-rs · Dec 28, 2023 · 72afe03 · 72afe03
1 parent 5825dcc
commit 72afe03
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/cli/codegen/commands.ts b/cli/codegen/commands.ts
@@ -319,7 +319,7 @@ const ARTIFACTS_OPTIONS: CommandSchema = {
       type: 'string',
       description:
         'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
-      short: ['o'],
+      short: ['o', 'd'],
       default: "'./artifacts'",
     },
     {

diff --git a/cli/docs/artifacts.md b/cli/docs/artifacts.md
@@ -28,5 +28,5 @@ new NapiCli().artifacts({
 | cwd             | --cwd               | string | false    | process.cwd()  | The working directory of where napi command will be executed in, all other paths options are relative to this path |
 | configPath      | --config-path,-c    | string | false    |                | Path to `napi` config json file                                                                                    |
 | packageJsonPath | --package-json-path | string | false    | 'package.json' | Path to `package.json`                                                                                             |
-| outputDir       | --output-dir,-o     | string | false    | './artifacts'  | Path to the folder where all built `.node` files put, same as `--output-dir` of build command                      |
+| outputDir       | --output-dir,-o,-d  | string | false    | './artifacts'  | Path to the folder where all built `.node` files put, same as `--output-dir` of build command                      |
 | npmDir          | --npm-dir           | string | false    | 'npm'          | Path to the folder where the npm packages put                                                                      |
diff --git a/cli/src/commands/artifacts.ts b/cli/src/commands/artifacts.ts
@@ -8,9 +8,9 @@ export class ArtifactsCommand extends BaseArtifactsCommand {
     description: 'Copy artifacts from Github Actions into specified dir',
     examples: [
       [
-        '$0 artifacts --dir . --dist ./npm',
+        '$0 artifacts --output-dir ./artifacts --dist ./npm',
         `Copy [binaryName].[platform].node under current dir(.) into packages under npm dir.
-e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.node`,
+e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.linux-x64-gnu.node`,
       ],
     ],
   })

diff --git a/cli/src/def/artifacts.ts b/cli/src/def/artifacts.ts
@@ -23,7 +23,7 @@ export abstract class BaseArtifactsCommand extends Command {
     description: 'Path to `package.json`',
   })
 
-  outputDir = Option.String('--output-dir,-o', './artifacts', {
+  outputDir = Option.String('--output-dir,-o,-d', './artifacts', {
     description:
       'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
   })