lib: remove enableHelpPrinting option

Author: miguelmarcondesf

doc/api/util.md

@@ -2051,9 +2051,6 @@ changes:
     the tokens in different ways.
     **Default:** `false`.
   * `help` {string} General help text to display at the beginning of help output.
-  * `enableHelpPrinting` {boolean} When `true`, if any options have help text
-    configured and a `--help` entry was provided, the help will be printed to stdout and the process will exit
-    with code 0. **Default:** `false`.
 
 * Returns: {Object} The parsed command line arguments:
   * `values` {Object} A mapping of parsed option names with their {string}
@@ -2110,9 +2107,11 @@ console.log(values, positionals);
 
 ### `parseArgs` help text
 
-`parseArgs` can generate and display help text for command-line options. To enable
-this functionality, add `help` text to individual options and optionally provide
-general help text via the `help` config property.
+`parseArgs` supports automatic help text generation for command-line options. To use this feature, add a `help`
+property to each option and optionally provide general help text using the `help` config property.
+
+When both general help text is provided and `--help` is present in the `args`, `parseArgs`
+will automatically print the help message and exit with code 0.
 
 ```mjs
 import { parseArgs } from 'node:util';
@@ -2152,12 +2151,20 @@ if (result.printUsage) {
 }
 
 // Or automatically print help and exit
+const args = ['-h'];
 parseArgs({
+  args,
   options,
   help: 'My CLI Tool v1.0\n\nProcess files with various options.',
-  enableHelpPrinting: true,
 });
-// Prints help and exits with code 0
+// Prints:
+// My CLI Tool v1.0
+//
+// Process files with various options.
+// -v, --verbose             Enable verbose output
+// -h, --help.               Prints command line options
+// --output <arg>            Output directory
+// exit with code 0
 ```
 
 ```cjs
@@ -2180,7 +2187,7 @@ const options = {
   },
 };
 
-// Get help text in result
+// Get serialized help text in result
 const result = parseArgs({
   options,
   help: 'My CLI Tool v1.0\n\nProcess files with various options.',
@@ -2198,12 +2205,20 @@ if (result.printUsage) {
 }
 
 // Or automatically print help and exit
+const args = ['-h'];
 parseArgs({
+  args,
   options,
   help: 'My CLI Tool v1.0\n\nProcess files with various options.',
-  enableHelpPrinting: true,
 });
-// Prints help and exits with code 0
+// Prints:
+// My CLI Tool v1.0
+//
+// Process files with various options.
+// -v, --verbose             Enable verbose output
+// -h, --help.               Prints command line options
+// --output <arg>            Output directory
+// exit with code 0
 ```
 
 ### `parseArgs` `tokens`

lib/internal/util/parse_args/parse_args.js

@@ -350,7 +350,6 @@ const parseArgs = (config = kEmptyObject) => {
   const allowNegative = objectGetOwn(config, 'allowNegative') ?? false;
   const options = objectGetOwn(config, 'options') ?? { __proto__: null };
   const help = objectGetOwn(config, 'help') ?? '';
-  const enableHelpPrinting = objectGetOwn(config, 'enableHelpPrinting') ?? false;
   // Bundle these up for passing to strict-mode checks.
   const parseConfig = { args, strict, options, allowPositionals, allowNegative };
 
@@ -362,7 +361,6 @@ const parseArgs = (config = kEmptyObject) => {
   validateBoolean(allowNegative, 'allowNegative');
   validateObject(options, 'options');
   validateString(help, 'help');
-  validateBoolean(enableHelpPrinting, 'enableHelpPrinting');
   ArrayPrototypeForEach(
     ObjectEntries(options),
     ({ 0: longOption, 1: optionConfig }) => {
@@ -466,12 +464,10 @@ const parseArgs = (config = kEmptyObject) => {
   });
 
   const helpRequested = result.values.help;
-  if (enableHelpPrinting && helpRequested) {
+  if (help && helpRequested) {
     const console = require('internal/console/global');
-    if (printUsage.length > 0 || help) {
+    if (printUsage.length > 0) {
       console.log(printUsage);
-    } else {
-      console.log('No help text available.');
     }
     process.exit(0);
   } else if (printUsage.length > 0) {

test/parallel/test-parse-args.mjs

@@ -1138,17 +1138,6 @@ test('when help value is added, then add initial help text', () => {
   assert.deepStrictEqual(result, expected);
 });
 
-test('enableHelpPrinting config must be a boolean', () => {
-  const args = ['-f', 'bar'];
-  const options = { foo: { type: 'string', short: 'f', help: 'help text' } };
-  const help = 'Description for some awesome stuff:';
-  const enableHelpPrinting = 'not a boolean';
-  assert.throws(() => {
-    parseArgs({ args, options, help, enableHelpPrinting });
-  }, /The "enableHelpPrinting" argument must be of type boolean/
-  );
-});
-
 function setupConsoleAndExit() {
   const originalLog = console.log;
   const originalExit = process.exit;
@@ -1172,13 +1161,12 @@ function setupConsoleAndExit() {
   return { getOutput: () => output, getExitCode: () => exitCode, restore };
 }
 
-test('when enableHelpPrinting config is true, print all help text and exit', () => {
+test('when --help flag is present with help arg, prints all help text and exit', () => {
   const { getOutput, getExitCode, restore } = setupConsoleAndExit();
 
   try {
     const args = [
-      '-h', '-a', 'val1', '--beta', '-c', 'val3', '--delta', 'val4', '-e',
-      '--foxtrot', 'val6', '--golf', '--hotel', 'val8', '--india', 'val9', '-j',
+      '-h', '-a', 'val1',
     ];
     const options = {
       help: { type: 'boolean', short: 'h', help: 'Prints command line options' },
@@ -1200,7 +1188,7 @@ test('when enableHelpPrinting config is true, print all help text and exit', ()
     };
     const help = 'Description for some awesome stuff:';
 
-    parseArgs({ args, options, help, enableHelpPrinting: true });
+    parseArgs({ args, options, help });
   } finally {
     restore();
   }
@@ -1223,18 +1211,19 @@ test('when enableHelpPrinting config is true, print all help text and exit', ()
   assert.strictEqual(getOutput(), expectedOutput);
 });
 
-test('when enableHelpPrinting config is true, but no help text is available', () => {
+test('when --help flag is present with help arg but no help text is available, prints help text and exit', () => {
   const { getOutput, getExitCode, restore } = setupConsoleAndExit();
 
   try {
     const args = ['-a', 'val1', '--help'];
+    const help = 'Description for some awesome stuff:';
     const options = { alpha: { type: 'string', short: 'a' }, help: { type: 'boolean' } };
 
-    parseArgs({ args, options, enableHelpPrinting: true });
+    parseArgs({ args, options, help });
   } finally {
     restore();
   }
 
   assert.strictEqual(getExitCode(), 0);
-  assert.strictEqual(getOutput(), 'No help text available.\n');
+  assert.strictEqual(getOutput(), 'Description for some awesome stuff:\n');
 });