Merge pull request atom#25442 from claytonrcarter/fix-usage-message

Fix usage message (closes atom#25441)
soitun · Jun 23, 2022 · 17a31e3 · 17a31e3
2 parents ae14722 + 19b28ed
commit 17a31e3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 19 deletions.
diff --git a/src/main-process/main.js b/src/main-process/main.js
@@ -12,14 +12,10 @@ const CSON = require('season');
 const yargs = require('yargs');
 const { app } = require('electron');
 
-const version = `Atom    : ${app.getVersion()}
-Electron: ${process.versions.electron}
-Chrome  : ${process.versions.chrome}
-Node    : ${process.versions.node}`;
-
 const args = yargs(process.argv)
-  .alias('v', 'version')
-  .version(version)
+  // Don't handle --help or --version here; they will be handled later.
+  .help(false)
+  .version(false)
   .alias('d', 'dev')
   .alias('t', 'test')
   .alias('r', 'resource-path').argv;

diff --git a/src/main-process/parse-command-line.js b/src/main-process/parse-command-line.js
@@ -57,10 +57,7 @@ module.exports = function parseCommandLine(processArgs) {
     .alias('f', 'foreground')
     .boolean('f')
     .describe('f', 'Keep the main process in the foreground.');
-  options
-    .alias('h', 'help')
-    .boolean('h')
-    .describe('h', 'Print this usage message.');
+  options.help('help', 'Print this usage message.').alias('h', 'help');
   options
     .alias('l', 'log-file')
     .string('l')
@@ -136,7 +133,16 @@ module.exports = function parseCommandLine(processArgs) {
       'Enable low-level logging messages from Electron.'
     );
   options.boolean('uri-handler');
+  options
+    .version(
+      dedent`Atom    : ${version}
+             Electron: ${process.versions.electron}
+             Chrome  : ${process.versions.chrome}
+             Node    : ${process.versions.node}`
+    )
+    .alias('v', 'version');
 
+  // NB: if --help or --version are given, this also displays the relevant message and exits
   let args = options.argv;
 
   // If --uri-handler is set, then we parse NOTHING else
@@ -148,11 +154,6 @@ module.exports = function parseCommandLine(processArgs) {
     };
   }
 
-  if (args.help) {
-    process.stdout.write(options.help());
-    process.exit(0);
-  }
-
   const addToLastWindow = args['add'];
   const safeMode = args['safe'];
   const benchmark = args['benchmark'];

diff --git a/src/main-process/start.js b/src/main-process/start.js
@@ -37,15 +37,18 @@ module.exports = function start(resourcePath, devResourcePath, startTime) {
     }
   });
 
-  const previousConsoleLog = console.log;
-  console.log = nslog;
-
   // TodoElectronIssue this should be set to true before Electron 12 - https://github.com/electron/electron/issues/18397
   app.allowRendererProcessReuse = false;
 
   app.commandLine.appendSwitch('enable-experimental-web-platform-features');
 
   const args = parseCommandLine(process.argv.slice(1));
+
+  // This must happen after parseCommandLine() because yargs uses console.log
+  // to display the usage message.
+  const previousConsoleLog = console.log;
+  console.log = nslog;
+
   args.resourcePath = normalizeDriveLetterName(resourcePath);
   args.devResourcePath = normalizeDriveLetterName(devResourcePath);