[ts-command-line] Fixes a typo in the README (#4887)

This commit is contained in:
Ale Muñoz 2024-08-14 16:21:24 +02:00 коммит произвёл GitHub
Родитель 97c0858a13
Коммит 8d69f29222
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
2 изменённых файлов: 11 добавлений и 1 удалений

Просмотреть файл

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/ts-command-line",
"comment": "Fix a README typo.",
"type": "none"
}
],
"packageName": "@rushstack/ts-command-line"
}

Просмотреть файл

@ -45,7 +45,7 @@ Several different kinds of parameters are supported:
| flag | `--verbose` | `boolean` | Value is `true` if the flag was specified on the command line, `false` otherwise. |
| integer | `--max-retry 3` | `int` | The argument is an integer number |
| string | `--title "Hello, world"` | `string` | The argument is a text string. |
| choice | `--color red` | `string` | The argument is must be a string from a list of allowed choices (similar to an enum). |
| choice | `--color red` | `string` | The argument must be a string from a list of allowed choices (similar to an enum). |
| string list | `-o file1.txt -o file2.txt` | `string[]` | The argument is a text string. The parameter can be specified multiple times to build a list. |
Other parameter kinds could be implemented if requested. That said, keeping your CLI grammar simple and systematic makes it easier for users to learn.