From 79add35fc14f2c2e9fa4bfaa7292dd35c34e226e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 5 Jun 2022 18:09:44 -0700 Subject: [PATCH] split long and short options --- README.md | 30 +++++++++++++++--------------- templates/readme_template | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ef33e42a..75c1e0fc 100644 --- a/README.md +++ b/README.md @@ -251,21 +251,21 @@ option. | ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | ### Options -| Option | Description | -|-----------------------|--------------------------------------------------------------------------------------------------------------| -| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation | -| `-m`, `--monochrome` | monochrome output | -| `-p`, `--pretty` | pretty format the JSON output | -| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u`, `--unbuffer` | unbuffer output | -| `-v`, `--version` | version information | -| `-y`, `--yaml-out` | YAML output | -| `-B`, `--bash-comp` | generate Bash shell completion script | -| `-Z`, `--zsh-comp` | generate Zsh shell completion script | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | monochrome output | +| `-p` | `--pretty` | pretty format the JSON output | +| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | unbuffer output | +| `-v` | `--version` | version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | generate Bash shell completion script | +| `-Z` | `--zsh-comp` | generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the diff --git a/templates/readme_template b/templates/readme_template index 3db0a4e1..9a65dd6f 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -149,21 +149,21 @@ option. | `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} ### Options -| Option | Description | -|-----------------------|--------------------------------------------------------------------------------------------------------------| -| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation | -| `-m`, `--monochrome` | monochrome output | -| `-p`, `--pretty` | pretty format the JSON output | -| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u`, `--unbuffer` | unbuffer output | -| `-v`, `--version` | version information | -| `-y`, `--yaml-out` | YAML output | -| `-B`, `--bash-comp` | generate Bash shell completion script | -| `-Z`, `--zsh-comp` | generate Zsh shell completion script | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | monochrome output | +| `-p` | `--pretty` | pretty format the JSON output | +| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | unbuffer output | +| `-v` | `--version` | version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | generate Bash shell completion script | +| `-Z` | `--zsh-comp` | generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the