cli: add alias for report-directory to make it consistent

Currently every other cli option uses "dir" to reference a directory so add an alias to allow for conistency. PR-URL: #33587 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Jun 18, 2020 · d194d20 · d194d20
1 parent c184929
commit d194d20
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -635,7 +635,7 @@ Write reports in a compact format, single-line JSON, more easily consumable
 by log processing systems than the default multi-line format designed for
 human consumption.
 
-### `--report-directory=directory`
+### --report-dir=directory`, `report-directory=directory`
 <!-- YAML
 added: v11.8.0
 changes:
@@ -1224,7 +1224,7 @@ Node.js options that are allowed are:
 * `--prof-process`
 * `--redirect-warnings`
 * `--report-compact`
-* `--report-directory`
+* `--report-dir`, `--report-directory`
 * `--report-filename`
 * `--report-on-fatalerror`
 * `--report-on-signal`

diff --git a/doc/node.1 b/doc/node.1
@@ -294,7 +294,7 @@ Write
 .Sy diagnostic reports
 in a compact format, single-line JSON.
 .
-.It Fl -report-directory
+.It Fl -report-dir Fl -report-directory
 Location at which the
 .Sy diagnostic report
 will be generated.

diff --git a/src/node_options.cc b/src/node_options.cc
@@ -664,11 +664,12 @@ PerProcessOptionsParser::PerProcessOptionsParser(
             "output compact single-line JSON",
             &PerProcessOptions::report_compact,
             kAllowedInEnvironment);
-  AddOption("--report-directory",
+  AddOption("--report-dir",
             "define custom report pathname."
-            " (default: current working directory of Node.js process)",
+            " (default: current working directory)",
             &PerProcessOptions::report_directory,
             kAllowedInEnvironment);
+  AddAlias("--report-directory", "--report-dir");
   AddOption("--report-filename",
             "define custom report file name."
             " (default: YYYYMMDD.HHMMSS.PID.SEQUENCE#.txt)",