@chromatic-com/cypress 0.13.0 → 0.13.1

package/embedded/node_modules/commander/Readme.md

@@ -11,7 +11,6 @@ Read this in other languages: English | [简体中文](./Readme_zh-CN.md)
 
 - [Commander.js](#commanderjs)
   - [Installation](#installation)
-  - [Quick Start](#quick-start)
   - [Declaring _program_ variable](#declaring-program-variable)
   - [Options](#options)
     - [Common option types, boolean and value](#common-option-types-boolean-and-value)
@@ -33,12 +32,9 @@ Read this in other languages: English | [简体中文](./Readme_zh-CN.md)
     - [Custom help](#custom-help)
     - [Display help after errors](#display-help-after-errors)
     - [Display help from code](#display-help-from-code)
-    - [.name](#name)
-    - [.usage](#usage)
-    - [.description and .summary](#description-and-summary)
+    - [.usage and .name](#usage-and-name)
     - [.helpOption(flags, description)](#helpoptionflags-description)
-    - [.helpCommand()](#helpcommand)
-    - [Help Groups](#help-groups)
+    - [.addHelpCommand()](#addhelpcommand)
     - [More configuration](#more-configuration-2)
   - [Custom event listeners](#custom-event-listeners)
   - [Bits and pieces](#bits-and-pieces)
@@ -49,10 +45,9 @@ Read this in other languages: English | [简体中文](./Readme_zh-CN.md)
     - [createCommand()](#createcommand)
     - [Node options such as `--harmony`](#node-options-such-as---harmony)
     - [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands)
-    - [npm run-script](#npm-run-script)
-    - [Display error](#display-error)
     - [Override exit and output handling](#override-exit-and-output-handling)
     - [Additional documentation](#additional-documentation)
+  - [Examples](#examples)
   - [Support](#support)
     - [Commander for enterprise](#commander-for-enterprise)
 
@@ -60,153 +55,60 @@ For information about terms used in this document see: [terminology](./docs/term
 
 ## Installation
 
-```sh
+```bash
 npm install commander
 ```
 
-## Quick Start
-
-You write code to describe your command line interface.
-Commander looks after parsing the arguments into options and command-arguments,
-displays usage errors for problems, and implements a help system.
-
-Commander is strict and displays an error for unrecognised options.
-The two most used option types are a boolean option, and an option which takes its value from the following argument.
-
-Example file: [split.js](./examples/split.js)
-
-```js
-const { program } = require('commander');
-
-program
-  .option('--first')
-  .option('-s, --separator <char>')
-  .argument('<string>');
-
-program.parse();
-
-const options = program.opts();
-const limit = options.first ? 1 : undefined;
-console.log(program.args[0].split(options.separator, limit));
-```
-
-```console
-$ node split.js -s / --fits a/b/c
-error: unknown option '--fits'
-(Did you mean --first?)
-$ node split.js -s / --first a/b/c
-[ 'a' ]
-```
-
-Here is a more complete program using a subcommand and with descriptions for the help. In a multi-command program, you have an action handler for each command (or stand-alone executables for the commands).
-
-Example file: [string-util.js](./examples/string-util.js)
-
-```js
-const { Command } = require('commander');
-const program = new Command();
-
-program
-  .name('string-util')
-  .description('CLI to some JavaScript string utilities')
-  .version('0.8.0');
-
-program.command('split')
-  .description('Split a string into substrings and display as an array')
-  .argument('<string>', 'string to split')
-  .option('--first', 'display just the first substring')
-  .option('-s, --separator <char>', 'separator character', ',')
-  .action((str, options) => {
-    const limit = options.first ? 1 : undefined;
-    console.log(str.split(options.separator, limit));
-  });
-
-program.parse();
-```
-
-```console
-$ node string-util.js help split
-Usage: string-util split [options] <string>
-
-Split a string into substrings and display as an array.
-
-Arguments:
-  string                  string to split
-
-Options:
-  --first                 display just the first substring
-  -s, --separator <char>  separator character (default: ",")
-  -h, --help              display help for command
-
-$ node string-util.js split --separator=/ a/b/c
-[ 'a', 'b', 'c' ]
-```
-
-More samples can be found in the [examples](https://github.com/tj/commander.js/tree/master/examples) directory.
-
 ## Declaring _program_ variable
 
 Commander exports a global object which is convenient for quick programs.
 This is used in the examples in this README for brevity.
 
 ```js
-// CommonJS (.cjs)
 const { program } = require('commander');
+program.version('0.0.1');
 ```
 
-For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local `Command` object to use.
+For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local Command object to use.
 
 ```js
-// CommonJS (.cjs)
 const { Command } = require('commander');
 const program = new Command();
+program.version('0.0.1');
 ```
 
+For named imports in ECMAScript modules, import from `commander/esm.mjs`.
+
 ```js
-// ECMAScript (.mjs)
-import { Command } from 'commander';
+// index.mjs
+import { Command } from 'commander/esm.mjs';
 const program = new Command();
 ```
 
+And in TypeScript:
+
 ```ts
-// TypeScript (.ts)
+// index.ts
 import { Command } from 'commander';
 const program = new Command();
 ```
 
 ## Options
 
-Options are defined with the `.option()` method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma, a space, or a vertical bar (`|`). To allow a wider range of short-ish flags than just single characters, you may also have two long options.
-
-```js
-program
-  .option('-p, --port <number>', 'server port number')
-  .option('--trace', 'add extra debugging output')
-  .option('--ws, --workspace <name>', 'use a custom workspace')
-```
+Options are defined with the `.option()` method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma or space or vertical bar ('|').
 
 The parsed options can be accessed by calling `.opts()` on a `Command` object, and are passed to the action handler.
+(You can also use `.getOptionValue()` and `.setOptionValue()` to work with a single option value,
+and `.getOptionValueSource()` and `.setOptionValueWithSource()` when it matters where the option value came from.)
 
-Multi-word options like `--template-engine` are normalized to camelCase option names, resulting in properties such as `program.opts().templateEngine`.
+Multi-word options such as "--template-engine" are camel-cased, becoming `program.opts().templateEngine` etc.
 
-An option and its option-argument can be separated by a space, or combined into the same argument. The option-argument can follow the short option directly, or follow an `=` for a long option.
-
-```sh
-serve -p 80
-serve -p80
-serve --port 80
-serve --port=80
-```
+Multiple short flags may optionally be combined in a single argument following the dash: boolean flags, followed by a single option taking a value (possibly followed by the value).
+For example `-a -b -p 80` may be written as `-ab -p80` or even `-abp80`.
 
 You can use `--` to indicate the end of the options, and any remaining arguments will be used without being interpreted.
 
-By default, options on the command line are not positional, and can be specified before or after other arguments.
-
-There are additional related routines for when `.opts()` is not enough:
-
-- `.optsWithGlobals()` returns merged local and global option values
-- `.getOptionValue()` and `.setOptionValue()` work with a single option value
-- `.getOptionValueSource()` and `.setOptionValueWithSource()` include where the option value came from
+By default options on the command line are not positional, and can be specified before or after other arguments.
 
 ### Common option types, boolean and value
 
@@ -230,7 +132,7 @@ if (options.small) console.log('- small pizza size');
 if (options.pizzaType) console.log(`- ${options.pizzaType}`);
 ```
 
-```console
+```bash
 $ pizza-options -p
 error: option '-p, --pizza-type <type>' argument missing
 $ pizza-options -d -s -p vegetarian
@@ -243,17 +145,11 @@ pizza details:
 - cheese
 ```
 
-Multiple boolean short options may be combined following the dash, and may be followed by a single short option taking a value.
-For example, `-d -s -p cheese` may be written as `-ds -p cheese` or even `-dsp cheese`.
-
-Options with an expected option-argument are greedy and will consume the following argument whatever the value.
-So `--id -xyz` reads `-xyz` as the option-argument.
-
 `program.parse(arguments)` processes the arguments, leaving any args not consumed by the program options in the `program.args` array. The parameter is optional and defaults to `process.argv`.
 
 ### Default option value
 
-You can specify a default value for an option.
+You can specify a default value for an option which takes a value.
 
 Example file: [options-defaults.js](./examples/options-defaults.js)
 
@@ -266,7 +162,7 @@ program.parse();
 console.log(`cheese: ${program.opts().cheese}`);
 ```
 
-```console
+```bash
 $ pizza-options
 cheese: blue
 $ pizza-options --cheese stilton
@@ -275,11 +171,11 @@ cheese: stilton
 
 ### Other option types, negatable boolean and boolean|value
 
-You can define a boolean option long name with a leading `no-` to set the option value to `false` when used.
-Defined alone, this also makes the option `true` by default.
+You can define a boolean option long name with a leading `no-` to set the option value to false when used.
+Defined alone this also makes the option true by default.
 
 If you define `--foo` first, adding `--no-foo` does not change the default value from what it would
-otherwise be.
+otherwise be. You can specify a default boolean value for a boolean option and it can be overridden on command line.
 
 Example file: [options-negatable.js](./examples/options-negatable.js)
 
@@ -296,7 +192,7 @@ const cheeseStr = (options.cheese === false) ? 'no cheese' : `${options.cheese}
 console.log(`You ordered a pizza with ${sauceStr} and ${cheeseStr}`);
 ```
 
-```console
+```bash
 $ pizza-options
 You ordered a pizza with sauce and mozzarella cheese
 $ pizza-options --sauce
@@ -308,7 +204,7 @@ You ordered a pizza with no sauce and no cheese
 ```
 
 You can specify an option which may be used as a boolean option but may optionally take an option-argument
-(declared with square brackets, like `--optional [value]`).
+(declared with square brackets like `--optional [value]`).
 
 Example file: [options-boolean-or-value.js](./examples/options-boolean-or-value.js)
 
@@ -324,7 +220,7 @@ else if (options.cheese === true) console.log('add cheese');
 else console.log(`add cheese type ${options.cheese}`);
 ```
 
-```console
+```bash
 $ pizza-options
 no cheese
 $ pizza-options --cheese
@@ -333,17 +229,11 @@ $ pizza-options --cheese mozzarella
 add cheese type mozzarella
 ```
 
-Options with an optional option-argument are not greedy and will ignore arguments starting with a dash.
-So `id` behaves as a boolean option for `--id -ABCD`, but you can use a combined form if needed like `--id=-ABCD`.
-Negative numbers are special and are accepted as an option-argument.
-
-For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-in-depth.md).
+For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-taking-varying-arguments.md).
 
 ### Required option
 
-You may specify a required (mandatory) option using `.requiredOption()`. The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (e.g., from environment). 
-
-The method is otherwise the same as `.option()` in format, taking flags and description, and optional default value or custom processing.
+You may specify a required (mandatory) option using `.requiredOption`. The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (say from environment). The method is otherwise the same as `.option` in format, taking flags and description, and optional default value or custom processing.
 
 Example file: [options-required.js](./examples/options-required.js)
 
@@ -354,7 +244,7 @@ program
 program.parse();
 ```
 
-```console
+```bash
 $ pizza
 error: required option '-c, --cheese <type>' not specified
 ```
@@ -364,7 +254,7 @@ error: required option '-c, --cheese <type>' not specified
 You may make an option variadic by appending `...` to the value placeholder when declaring the option. On the command line you
 can then specify multiple option-arguments, and the parsed option value will be an array. The extra arguments
 are read until the first argument starting with a dash. The special argument `--` stops option processing entirely. If a value
-is specified in the same argument as the option, then no further values are read.
+is specified in the same argument as the option then no further values are read.
 
 Example file: [options-variadic.js](./examples/options-variadic.js)
 
@@ -379,7 +269,7 @@ console.log('Options: ', program.opts());
 console.log('Remaining arguments: ', program.args);
 ```
 
-```console
+```bash
 $ collect -n 1 2 3 --letter a b c
 Options:  { number: [ '1', '2', '3' ], letter: [ 'a', 'b', 'c' ] }
 Remaining arguments:  []
@@ -391,23 +281,23 @@ Options:  { number: [ '1', '2', '3' ], letter: true }
 Remaining arguments:  [ 'operand' ]
 ```
 
-For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-in-depth.md).
+For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-taking-varying-arguments.md).
 
 ### Version option
 
-The optional `.version()` method adds handling for displaying the command version. The default option flags are `-V` and `--version`. When used, the command prints the version number and exits.
+The optional `version` method adds handling for displaying the command version. The default option flags are `-V` and `--version`, and when present the command prints the version number and exits.
 
 ```js
 program.version('0.0.1');
 ```
 
-```console
+```bash
 $ ./examples/pizza -V
 0.0.1
 ```
 
-You may change the flags and description by passing additional parameters to the `.version()` method, using
-the same syntax for flags as the `.option()` method.
+You may change the flags and description by passing additional parameters to the `version` method, using
+the same syntax for flags as the `option` method.
 
 ```js
 program.version('0.0.1', '-v, --vers', 'output the current version');
@@ -418,20 +308,17 @@ program.version('0.0.1', '-v, --vers', 'output the current version');
 You can add most options using the `.option()` method, but there are some additional features available
 by constructing an `Option` explicitly for less common cases.
 
-Example files: [options-extra.js](./examples/options-extra.js), [options-env.js](./examples/options-env.js), [options-conflicts.js](./examples/options-conflicts.js), [options-implies.js](./examples/options-implies.js)
+Example files: [options-extra.js](./examples/options-extra.js), [options-env.js](./examples/options-env.js)
 
 ```js
 program
   .addOption(new Option('-s, --secret').hideHelp())
   .addOption(new Option('-t, --timeout <delay>', 'timeout in seconds').default(60, 'one minute'))
   .addOption(new Option('-d, --drink <size>', 'drink size').choices(['small', 'medium', 'large']))
-  .addOption(new Option('-p, --port <number>', 'port number').env('PORT'))
-  .addOption(new Option('--donate [amount]', 'optional donation in dollars').preset('20').argParser(parseFloat))
-  .addOption(new Option('--disable-server', 'disables the server').conflicts('port'))
-  .addOption(new Option('--free-drink', 'small drink included free ').implies({ drink: 'small' }));
+  .addOption(new Option('-p, --port <number>', 'port number').env('PORT'));
 ```
 
-```console
+```bash
 $ extra --help
 Usage: help [options]
 
@@ -439,23 +326,15 @@ Options:
   -t, --timeout <delay>  timeout in seconds (default: one minute)
   -d, --drink <size>     drink cup size (choices: "small", "medium", "large")
   -p, --port <number>    port number (env: PORT)
-  --donate [amount]      optional donation in dollars (preset: "20")
-  --disable-server       disables the server
-  --free-drink           small drink included free
   -h, --help             display help for command
 
 $ extra --drink huge
 error: option '-d, --drink <size>' argument 'huge' is invalid. Allowed choices are small, medium, large.
 
-$ PORT=80 extra --donate --free-drink
-Options:  { timeout: 60, donate: 20, port: '80', freeDrink: true, drink: 'small' }
-
-$ extra --disable-server --port 8000
-error: option '--disable-server' cannot be used with option '-p, --port <number>'
+$ PORT=80 extra 
+Options:  { timeout: 60, port: '80' }
 ```
 
-Specify a required (mandatory) option using the `Option` method `.makeOptionMandatory()`. This matches the `Command` method [`.requiredOption()`](#required-option).
-
 ### Custom option processing
 
 You may specify a function to do custom processing of option-arguments. The callback function receives two parameters,
@@ -507,7 +386,7 @@ if (options.collect.length > 0) console.log(options.collect);
 if (options.list !== undefined) console.log(options.list);
 ```
 
-```console
+```bash
 $ custom -f 1e2
 float: 100
 $ custom --integer 2
@@ -522,9 +401,7 @@ $ custom --list x,y,z
 
 ## Commands
 
-You can specify (sub)commands using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an `.action()` handler attached to the command; or as a stand-alone executable file. (More detail about this later.)
-
-Subcommands may be nested. Example file: [nestedCommands.js](./examples/nestedCommands.js).
+You can specify (sub)commands using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested ([example](./examples/nestedCommands.js)).
 
 In the first parameter to `.command()` you specify the command name. You may append the command-arguments after the command name, or specify them separately using `.argument()`. The arguments may be `<required>` or `[optional]`, and the last argument may also be `variadic...`.
 
@@ -556,20 +433,15 @@ program
 
 Configuration options can be passed with the call to `.command()` and `.addCommand()`. Specifying `hidden: true` will
 remove the command from the generated help output. Specifying `isDefault: true` will run the subcommand if no other
-subcommand is specified. (Example file: [defaultCommand.js](./examples/defaultCommand.js).)
-
-You can add alternative names for a command with `.alias()`. (Example file: [alias.js](./examples/alias.js).)
-
-`.command()` automatically copies the inherited settings from the parent command to the newly created subcommand. This is only done during creation; any later setting changes to the parent are not inherited.
-
-For safety, `.addCommand()` does not automatically copy the inherited settings from the parent command. There is a helper routine `.copyInheritedSettings()` for copying the settings when they are wanted.
+subcommand is specified ([example](./examples/defaultCommand.js)).
 
 ### Command-arguments
 
 For subcommands, you can specify the argument syntax in the call to `.command()` (as shown above). This
-is the only method usable for subcommands implemented using a stand-alone executable.
+is the only method usable for subcommands implemented using a stand-alone executable, but for other subcommands
+you can instead use the following method.
 
-Alternatively, you can instead use the following method. To configure a command, you can use `.argument()` to specify each expected command-argument.
+To configure a command, you can use `.argument()` to specify each expected command-argument.
 You supply the argument name and an optional description. The argument may be `<required>` or `[optional]`.
 You can specify a default value for an optional command-argument.
 
@@ -586,10 +458,8 @@ program
   });
 ```
 
-The last argument of a command can be variadic, and _only_ the last argument.  To make an argument variadic, simply
-append `...` to the argument name.
-
-A variadic argument is passed to the action handler as an array.
+ The last argument of a command can be variadic, and only the last argument.  To make an argument variadic you
+ append `...` to the argument name. A variadic argument is passed to the action handler as an array. For example:
 
 ```js
 program
@@ -666,21 +536,7 @@ program
   });
 ```
 
-If you prefer, you can work with the command directly and skip declaring the parameters for the action handler. If you use a function expression (but not an arrow function), the `this` keyword is set to the running command.
-
-Example file: [action-this.js](./examples/action-this.js)
-
-```js
-program
-  .command('serve')
-  .argument('<script>')
-  .option('-p, --port <number>', 'port number', 80)
-  .action(function() {
-    console.error('Run script %s on port %s', this.args[0], this.opts().port);
-  });
-```
-
-You may supply an `async` action handler, in which case you call `.parseAsync()` rather than `.parse()`.
+You may supply an `async` action handler, in which case you call `.parseAsync` rather than `.parse`.
 
 ```js
 async function run() { /* code goes here */ }
@@ -693,16 +549,14 @@ async function main() {
 }
 ```
 
-A command's options and arguments on the command line are validated when the command is used. Any unknown options, missing arguments, or excess arguments will be reported as an error. 
-
-You can suppress the unknown option check with `.allowUnknownOption()`. You can suppress the excess arguments check with `.allowExcessArguments()`.
+A command's options and arguments on the command line are validated when the command is used. Any unknown options or missing arguments will be reported as an error. You can suppress the unknown option checks with `.allowUnknownOption()`. By default it is not an error to
+pass more arguments than declared, but you can make this an error with `.allowExcessArguments(false)`.
 
 ### Stand-alone executable (sub)commands
 
 When `.command()` is invoked with a description argument, this tells Commander that you're going to use stand-alone executables for subcommands.
-Commander will search the files in the directory of the entry script for a file with the name combination `command-subcommand` (like `pm-install` or `pm-search` in the example below). The search includes trying common file extensions, like `.js`.
-You may specify a custom name (and path) with the `executableFile` configuration option.
-You may specify a custom search directory for subcommands with `.executableDir()`.
+Commander will search the executables in the directory of the entry script (like `./examples/pm`) with the name `program-subcommand`, like `pm-install`, `pm-search`.
+You can specify a custom name with the `executableFile` configuration option.
 
 You handle the options for an executable (sub)command in the executable, and don't declare them at the top-level.
 
@@ -710,9 +564,8 @@ Example file: [pm](./examples/pm)
 
 ```js
 program
-  .name('pm')
   .version('0.1.0')
-  .command('install [package-names...]', 'install one or more packages')
+  .command('install [name]', 'install one or more packages')
   .command('search [query]', 'search with optional query')
   .command('update', 'update installed packages', { executableFile: 'myUpdateSubCommand' })
   .command('list', 'list packages installed', { isDefault: true });
@@ -740,16 +593,14 @@ program
   });
 ```
 
-The callback hook can be `async`, in which case you call `.parseAsync()` rather than `.parse()`. You can add multiple hooks per event.
+The callback hook can be `async`, in which case you call `.parseAsync` rather than `.parse`. You can add multiple hooks per event.
 
 The supported events are:
 
-| event name | when hook called | callback parameters |
-| :-- | :-- | :-- |
-| `preAction`, `postAction` |  before/after action handler for this command and its nested subcommands |   `(thisCommand, actionCommand)` |
-| `preSubcommand` | before parsing direct subcommand  | `(thisCommand, subcommand)` |
+- `preAction`: called before action handler for this command and its subcommands
+- `postAction`: called after action handler for this command and its subcommands
 
-For an overview of the life cycle events, see [parsing life cycle and hooks](./docs/parsing-and-hooks.md).
+The hook is passed the command it was added to, and the command running the action handler.
 
 ## Automated help
 
@@ -758,7 +609,7 @@ help option is `-h,--help`.
 
 Example file: [pizza](./examples/pizza)
 
-```console
+```bash
 $ node ./examples/pizza --help
 Usage: pizza [options]
 
@@ -774,7 +625,7 @@ Options:
 A `help` command is added by default if your command has subcommands. It can be used alone, or with a subcommand name to show
 further help for the subcommand. These are effectively the same if the `shell` program has implicit help:
 
-```sh
+```bash
 shell help
 shell --help
 
@@ -782,8 +633,6 @@ shell help spawn
 shell spawn --help
 ```
 
-Long descriptions are wrapped to fit the available width. (However, a description that includes a line-break followed by whitespace is assumed to be pre-formatted and not wrapped.)
-
 ### Custom help
 
 You can add extra text to be displayed along with the built-in help.
@@ -824,8 +673,8 @@ The positions "beforeAll" and "afterAll" apply to the command and all its subcom
 
 The second parameter can be a string, or a function returning a string. The function is passed a context object for your convenience. The properties are:
 
-- `error`: a boolean for whether the help is being displayed due to a usage error
-- `command`: the `Command` which is displaying the help
+- error: a boolean for whether the help is being displayed due to a usage error
+- command: the Command which is displaying the help
 
 ### Display help after errors
 
@@ -838,20 +687,19 @@ program.showHelpAfterError();
 program.showHelpAfterError('(add --help for additional information)');
 ```
 
-```console
+```sh
 $ pizza --unknown
 error: unknown option '--unknown'
 (add --help for additional information)
 ```
 
-The default behaviour is to suggest correct spelling after an error for an unknown command or option. You
-can disable this.
+You can also show suggestions after an error for an unknown command or option.
 
 ```js
-program.showSuggestionAfterError(false);
+program.showSuggestionAfterError();
 ```
 
-```console
+```sh
 $ pizza --hepl
 error: unknown option '--hepl'
 (Did you mean --help?)
@@ -865,25 +713,10 @@ error: unknown option '--hepl'
 
 `.helpInformation()`: get the built-in command help information as a string for processing or displaying yourself.
 
-### .name
-
-The command name appears in the help, and is also used for locating stand-alone executable subcommands.
-
-You may specify the program name using `.name()` or in the `Command` constructor. For the program, Commander will
-fall back to using the script name from the full arguments passed into `.parse()`. However, the script name varies
-depending on how your program is launched, so you may wish to specify it explicitly.
-
-```js
-program.name('pizza');
-const pm = new Command('pm');
-```
-
-Subcommands get a name when specified using `.command()`. If you create the subcommand yourself to use with `.addCommand()`,
-then set the name using `.name()` or in the `Command` constructor.
-
-### .usage
+### .usage and .name
 
-This allows you to customise the usage description in the first line of the help. Given:
+These allow you to customise the usage description in the first line of the help. The name is otherwise
+deduced from the (full) program arguments. Given:
 
 ```js
 program
@@ -897,65 +730,50 @@ The help will start with:
 Usage: my-command [global options] command
 ```
 
-### .description and .summary
-
-The description appears in the help for the command. You can optionally supply a shorter
-summary to use when listed as a subcommand of the program.
-
-```js
-program
-  .command("duplicate")
-  .summary("make a copy")
-  .description(`Make a copy of the current project.
-This may require additional disk space.
-  `);
-```
-
 ### .helpOption(flags, description)
 
-By default, every command has a help option. You may change the default help flags and description. Pass `false` to disable the built-in help option.
+By default every command has a help option. Override the default help flags and description. Pass false to disable the built-in help option.
 
 ```js
 program
   .helpOption('-e, --HELP', 'read more information');
 ```
 
-Alternatively, use `.addHelpOption()` to add an option you construct yourself.
-
-### .helpCommand()
+### .addHelpCommand()
 
-A help command is added by default if your command has subcommands. You can explicitly turn the implicit help command on or off with `.helpCommand(true)` and `.helpCommand(false)`.
+A help command is added by default if your command has subcommands. You can explicitly turn on or off the implicit help command with `.addHelpCommand()` and `.addHelpCommand(false)`.
 
 You can both turn on and customise the help command by supplying the name and description:
 
 ```js
-program.helpCommand('assist [command]', 'show assistance');
+program.addHelpCommand('assist [command]', 'show assistance');
 ```
 
-Alternatively, use `.addHelpCommand()` to add a command you construct yourself.
-
-### Help Groups
-
-The help by default lists options under the the heading `Options:` and commands under `Commands:`. You can create your own groups
-with different headings. 
+### More configuration
 
-- The high-level way is to set the desired group heading while adding the options and commands, using `.optionsGroup()` and `.commandsGroup()`. 
-- The low-level way is using `.helpGroup()` on an individual `Option` or `Command`.
+The built-in help is formatted using the Help class.
+You can configure the Help behaviour by modifying data properties and methods using `.configureHelp()`, or by subclassing using `.createHelp()` if you prefer.
 
-Example file: [help-groups.js](./examples/help-groups.js)
+The data properties are:
 
-### More configuration
+- `helpWidth`: specify the wrap width, useful for unit tests
+- `sortSubcommands`: sort the subcommands alphabetically
+- `sortOptions`: sort the options alphabetically
 
-The built-in help is formatted using the `Help` class.
-You can configure the help by modifying data properties and methods using `.configureHelp()`, or by subclassing `Help` using `.createHelp()` .
+There are methods getting the visible lists of arguments, options, and subcommands. There are methods for formatting the items in the lists, with each item having a _term_ and _description_. Take a look at `.formatHelp()` to see how they are used.
 
-Simple properties include `sortSubcommands`, `sortOptions`, and `showGlobalOptions`. You can add color using the style methods like `.styleTitle()`.
+Example file: [configure-help.js](./examples/configure-help.js)
 
-For more detail and examples of changing the displayed text, color, and layout, see: [Help in Depth](./docs/help-in-depth.md).
+```js
+program.configureHelp({
+  sortSubcommands: true,
+  subcommandTerm: (cmd) => cmd.name() // Just show the name, instead of short usage.
+});
+```
 
 ## Custom event listeners
 
-You can execute custom actions by listening to `command` and `option` events.
+You can execute custom actions by listening to command and option events.
 
 ```js
 program.on('option:verbose', function () {
@@ -967,29 +785,27 @@ program.on('option:verbose', function () {
 
 ### .parse() and .parseAsync()
 
-Call with no parameters to parse `process.argv`. Detects Electron and special node options like `node --eval`. Easy mode!
+The first argument to `.parse` is the array of strings to parse. You may omit the parameter to implicitly use `process.argv`.
 
-Or, call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are `from`:
+If the arguments follow different conventions than node you can pass a `from` option in the second parameter:
 
-- `'node'`: default, `argv[0]` is the application and `argv[1]` is the script being run, with user arguments after that
-- `'electron'`: `argv[0]` is the application and `argv[1]` varies depending on whether the electron application is packaged
-- `'user'`: just user arguments
+- 'node': default, `argv[0]` is the application and `argv[1]` is the script being run, with user parameters after that
+- 'electron': `argv[1]` varies depending on whether the electron application is packaged
+- 'user': all of the arguments from the user
 
 For example:
 
 ```js
-program.parse(); // parse process.argv and auto-detect electron and special node flags
-program.parse(process.argv); // assume argv[0] is app and argv[1] is script
-program.parse(['--port', '80'], { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
+program.parse(process.argv); // Explicit, node conventions
+program.parse(); // Implicit, and auto-detect electron
+program.parse(['-f', 'filename'], { from: 'user' });
 ```
 
-Use `.parseAsync()` instead of `.parse()` if any of your action handlers are async.
-
 ### Parsing Configuration
 
 If the default parsing does not suit your needs, there are some behaviours to support other usage patterns.
 
-By default, program options are recognised before and after subcommands. To only look for program options before subcommands, use `.enablePositionalOptions()`. This lets you use
+By default program options are recognised before and after subcommands. To only look for program options before subcommands, use `.enablePositionalOptions()`. This lets you use
 an option for a different purpose in subcommands.
 
 Example file: [positional-options.js](./examples/positional-options.js)
@@ -1001,8 +817,8 @@ program -b subcommand
 program subcommand -b
 ```
 
-By default, options are recognised before and after command-arguments. To only process options that come
-before the command-arguments, use `.passThroughOptions()`. This lets you pass the arguments and following options through to another program
+By default options are recognised before and after command-arguments. To only process options that come
+before the command-arguments, use `.passThroughOptions()`. This lets you pass the  arguments and following options through to another program
 without needing to use `--` to end the option processing.
 To use pass through options in a subcommand, the program needs to enable positional options.
 
@@ -1015,18 +831,16 @@ program --port=80 arg
 program arg --port=80
 ```
 
-By default, the option processing shows an error for an unknown option. To have an unknown option treated as an ordinary command-argument and continue looking for options, use `.allowUnknownOption()`. This lets you mix known and unknown options.
+By default the option processing shows an error for an unknown option. To have an unknown option treated as an ordinary command-argument and continue looking for options, use `.allowUnknownOption()`. This lets you mix known and unknown options.
 
-By default, the argument processing displays an error for more command-arguments than expected.
-To suppress the error for excess arguments, use `.allowExcessArguments()`.
+By default the argument processing does not display an error for more command-arguments than expected.
+To display an error for excess arguments, use`.allowExcessArguments(false)`.
 
 ### Legacy options as properties
 
 Before Commander 7, the option values were stored as properties on the command.
-This was convenient to code, but the downside was possible clashes with
-existing properties of `Command`. 
-
-You can revert to the old behaviour to run unmodified legacy code by using `.storeOptionsAsProperties()`.
+This was convenient to code but the downside was possible clashes with
+existing properties of `Command`. You can revert to the old behaviour to run unmodified legacy code by using `.storeOptionsAsProperties()`.
 
 ```js
 program
@@ -1041,17 +855,9 @@ program
 
 ### TypeScript
 
-**extra-typings:** There is an optional project to infer extra type information from the option and argument definitions.
-This adds strong typing to the options returned by `.opts()` and the parameters to `.action()`.
-For more, see the repo: [commander-js/extra-typings](https://github.com/commander-js/extra-typings).
-
-```ts
-import { Command } from '@commander-js/extra-typings';
-```
-
-**ts-node:** If you use `ts-node` and stand-alone executable subcommands written as `.ts` files, you need to call your program through node to get the subcommands called correctly, e.g.:
+If you use `ts-node` and  stand-alone executable subcommands written as `.ts` files, you need to call your program through node to get the subcommands called correctly. e.g.
 
-```sh
+```bash
 node -r ts-node/register pm.ts
 ```
 
@@ -1064,61 +870,33 @@ const { createCommand } = require('commander');
 const program = createCommand();
 ```
 
-`createCommand()` is also a method of the `Command` object, and creates a new command rather than a subcommand. This gets used internally
+`createCommand` is also a method of the Command object, and creates a new command rather than a subcommand. This gets used internally
 when creating subcommands using `.command()`, and you may override it to
-customise the new subcommand. Example file: [custom-command-class.js](./examples/custom-command-class.js).
+customise the new subcommand (example file [custom-command-class.js](./examples/custom-command-class.js)).
 
 ### Node options such as `--harmony`
 
 You can enable `--harmony` option in two ways:
 
-- Use `#! /usr/bin/env node --harmony` in the subcommands scripts. (Note: Windows does not support this pattern.)
-- Use the `--harmony` option when calling the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning subcommand processes.
+- Use `#! /usr/bin/env node --harmony` in the subcommands scripts. (Note Windows does not support this pattern.)
+- Use the `--harmony` option when call the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning subcommand process.
 
 ### Debugging stand-alone executable subcommands
 
 An executable subcommand is launched as a separate child process.
 
-If you are using the node inspector for [debugging](https://nodejs.org/en/docs/guides/debugging-getting-started/) executable subcommands using `node --inspect` et al.,
+If you are using the node inspector for [debugging](https://nodejs.org/en/docs/guides/debugging-getting-started/) executable subcommands using `node --inspect` et al,
 the inspector port is incremented by 1 for the spawned subcommand.
 
-If you are using VSCode to debug executable subcommands you need to set the `"autoAttachChildProcesses": true` flag in your `launch.json` configuration.
-
-### npm run-script
-
-By default, when you call your program using `run-script`, `npm` will parse any options on the command-line and they will not reach your program. Use
- `--` to stop the npm option parsing and pass through all the arguments.
-
- The synopsis for [`npm run-script`](https://docs.npmjs.com/cli/v9/commands/npm-run-script) explicitly shows the `--` for this reason:
-
-```console
-npm run-script <command> [-- <args>]
-```
-
-### Display error
-
-This routine is available to invoke the Commander error handling for your own error conditions. (See also the next section about exit handling.)
-
-As well as the error message, you can optionally specify the `exitCode` (used with `process.exit()`)
-and `code` (used with `CommanderError`).
-
-```js
-program.error('Password must be longer than four characters');
-program.error('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });
-```
+If you are using VSCode to debug executable subcommands you need to set the `"autoAttachChildProcesses": true` flag in your launch.json configuration.
 
 ### Override exit and output handling
 
-By default, Commander calls `process.exit()` when it detects errors, or after displaying the help or version. You can override
+By default Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override
 this behaviour and optionally supply a callback. The default override throws a `CommanderError`.
 
-The override callback is passed a `CommanderError` with the properties:
-- `exitCode`: number
-- `code`: string 
-- `message`: string
-
-Commander expects the callback to terminate the normal program flow, and will call `process.exit()` if the callback returns.
-The normal display of error messages or version or help is not affected by the override, which is called after the display.
+The override callback is passed a `CommanderError` with properties `exitCode` number, `code` string, and `message`. The default override behaviour is to throw the error, except for async handling of executable subcommand completion which carries on. The normal display of error messages or version or help
+is not affected by the override which is called after the display.
 
 ```js
 program.exitOverride();
@@ -1130,7 +908,7 @@ try {
 }
 ```
 
-By default, Commander is configured for a command-line application and writes to stdout and stderr.
+By default Commander is configured for a command-line application and writes to stdout and stderr.
 You can modify this behaviour for custom applications. In addition, you can modify the display of error messages.
 
 Example file: [configure-output.js](./examples/configure-output.js)
@@ -1156,16 +934,77 @@ program
 There is more information available about:
 
 - [deprecated](./docs/deprecated.md) features still supported for backwards compatibility
-- [Help in Depth](./docs/help-in-depth.md) configuring help output
-- [options taking varying arguments](./docs/options-in-depth.md)
-- [parsing life cycle and hooks](./docs/parsing-and-hooks.md)
-- [Release Policy](./docs/release-policy.md)
+- [options taking varying arguments](./docs/options-taking-varying-arguments.md)
 
-## Support
+## Examples
+
+In a single command program, you might not need an action handler.
+
+Example file: [pizza](./examples/pizza)
+
+```js
+const { program } = require('commander');
+
+program
+  .description('An application for pizza ordering')
+  .option('-p, --peppers', 'Add peppers')
+  .option('-c, --cheese <type>', 'Add the specified type of cheese', 'marble')
+  .option('-C, --no-cheese', 'You do not want any cheese');
+
+program.parse();
+
+const options = program.opts();
+console.log('you ordered a pizza with:');
+if (options.peppers) console.log('  - peppers');
+const cheese = !options.cheese ? 'no' : options.cheese;
+console.log('  - %s cheese', cheese);
+```
+
+In a multi-command program, you will have action handlers for each command (or stand-alone executables for the commands).
 
-The current version of Commander is fully supported on Long Term Support versions of Node.js, and requires at least v20.
+Example file: [deploy](./examples/deploy)
+
+```js
+const { Command } = require('commander');
+const program = new Command();
+
+program
+  .version('0.0.1')
+  .option('-c, --config <path>', 'set config path', './deploy.conf');
+
+program
+  .command('setup [env]')
+  .description('run setup commands for all envs')
+  .option('-s, --setup_mode <mode>', 'Which setup mode to use', 'normal')
+  .action((env, options) => {
+    env = env || 'all';
+    console.log('read config from %s', program.opts().config);
+    console.log('setup for %s env(s) with %s mode', env, options.setup_mode);
+  });
+
+program
+  .command('exec <script>')
+  .alias('ex')
+  .description('execute the given remote cmd')
+  .option('-e, --exec_mode <mode>', 'Which exec mode to use', 'fast')
+  .action((script, options) => {
+    console.log('read config from %s', program.opts().config);
+    console.log('exec "%s" using %s mode and config %s', script, options.exec_mode, program.opts().config);
+  }).addHelpText('after', `
+Examples:
+  $ deploy exec sequential
+  $ deploy exec async`
+  );
+
+program.parse(process.argv);
+```
+
+More samples can be found in the [examples](https://github.com/tj/commander.js/tree/master/examples) directory.
+
+## Support
 
-Older major versions of Commander receive security updates for 12 months. For more see: [Release Policy](./docs/release-policy.md).
+The current version of Commander is fully supported on Long Term Support versions of node, and requires at least node v12.
+(For older versions of node, use an older version of Commander. Commander version 2.x has the widest support.)
 
 The main forum for free and community support is the project [Issues](https://github.com/tj/commander.js/issues) on GitHub.