You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+18-18Lines changed: 18 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -191,7 +191,7 @@ serve --port=80
191
191
192
192
You can use `--` to indicate the end of the options, and any remaining arguments will be used without being interpreted.
193
193
194
-
By default options on the command line are not positional, and can be specified before or after other arguments.
194
+
By default, options on the command line are not positional, and can be specified before or after other arguments.
195
195
196
196
There are additional related routines for when `.opts()` is not enough:
197
197
@@ -234,7 +234,7 @@ pizza details:
234
234
- cheese
235
235
```
236
236
237
-
Multiple boolean short options may be combined together following the dash, and may be followed by a single short option taking a value.
237
+
Multiple boolean short options may be combined following the dash, and may be followed by a single short option taking a value.
238
238
For example `-d -s -p cheese` may be written as `-ds -p cheese` or even `-dsp cheese`.
239
239
240
240
Options with an expected option-argument are greedy and will consume the following argument whatever the value.
@@ -676,7 +676,7 @@ async function main() {
676
676
}
677
677
```
678
678
679
-
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
679
+
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
680
680
pass more arguments than declared, but you can make this an error with `.allowExcessArguments(false)`.
681
681
682
682
### Stand-alone executable (sub)commands
@@ -764,7 +764,7 @@ shell help spawn
764
764
shell spawn --help
765
765
```
766
766
767
-
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.)
767
+
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.)
If the default parsing does not suit your needs, there are some behaviours to support other usage patterns.
971
971
972
-
By default program options are recognised before and after subcommands. To only look for program options before subcommands, use `.enablePositionalOptions()`. This lets you use
972
+
By default, program options are recognised before and after subcommands. To only look for program options before subcommands, use `.enablePositionalOptions()`. This lets you use
973
973
an option for a different purpose in subcommands.
974
974
975
975
Example file: [positional-options.js](./examples/positional-options.js)
@@ -981,8 +981,8 @@ program -b subcommand
981
981
program subcommand -b
982
982
```
983
983
984
-
By default options are recognised before and after command-arguments. To only process options that come
985
-
before the command-arguments, use `.passThroughOptions()`. This lets you pass the arguments and following options through to another program
984
+
By default, options are recognised before and after command-arguments. To only process options that come
985
+
before the command-arguments, use `.passThroughOptions()`. This lets you pass the arguments and following options through to another program
986
986
without needing to use `--` to end the option processing.
987
987
To use pass through options in a subcommand, the program needs to enable positional options.
988
988
@@ -995,15 +995,15 @@ program --port=80 arg
995
995
program arg --port=80
996
996
```
997
997
998
-
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.
998
+
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.
999
999
1000
-
By default the argument processing does not display an error for more command-arguments than expected.
1000
+
By default, the argument processing does not display an error for more command-arguments than expected.
1001
1001
To display an error for excess arguments, use`.allowExcessArguments(false)`.
1002
1002
1003
1003
### Legacy options as properties
1004
1004
1005
1005
Before Commander 7, the option values were stored as properties on the command.
1006
-
This was convenient to code but the downside was possible clashes with
1006
+
This was convenient to code, but the downside was possible clashes with
1007
1007
existing properties of `Command`. You can revert to the old behaviour to run unmodified legacy code by using `.storeOptionsAsProperties()`.
1008
1008
1009
1009
```js
@@ -1027,7 +1027,7 @@ See [commander-js/extra-typings](https://github.com/commander-js/extra-typings)
1027
1027
import { Command } from '@commander-js/extra-typings';
1028
1028
```
1029
1029
1030
-
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.
1030
+
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.
1031
1031
1032
1032
```sh
1033
1033
node -r ts-node/register pm.ts
@@ -1057,14 +1057,14 @@ You can enable `--harmony` option in two ways:
1057
1057
1058
1058
An executable subcommand is launched as a separate child process.
1059
1059
1060
-
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,
1060
+
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.,
1061
1061
the inspector port is incremented by 1 for the spawned subcommand.
1062
1062
1063
1063
If you are using VSCode to debug executable subcommands you need to set the `"autoAttachChildProcesses": true` flag in your launch.json configuration.
1064
1064
1065
1065
### npm run-script
1066
1066
1067
-
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
1067
+
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
1068
1068
`--` to stop the npm option parsing and pass through all the arguments.
1069
1069
1070
1070
The synopsis for [npm run-script](https://docs.npmjs.com/cli/v9/commands/npm-run-script) explicitly shows the `--` for this reason:
By default Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override
1090
+
By default, Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override
1091
1091
this behaviour and optionally supply a callback. The default override throws a `CommanderError`.
1092
1092
1093
1093
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
@@ -1103,7 +1103,7 @@ try {
1103
1103
}
1104
1104
```
1105
1105
1106
-
By default Commander is configured for a command-line application and writes to stdout and stderr.
1106
+
By default, Commander is configured for a command-line application and writes to stdout and stderr.
1107
1107
You can modify this behaviour for custom applications. In addition, you can modify the display of error messages.
1108
1108
1109
1109
Example file: [configure-output.js](./examples/configure-output.js)
0 commit comments