diff options
| author | Hugues Morisset <morisset.hugues@gmail.com> | 2021-07-28 18:26:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-28 12:26:00 -0400 |
| commit | 40cb667b9dab7fb9b7ea31a32e24013af2ed4e09 (patch) | |
| tree | 85caa512a7d1a6295646114e4a36f5da395ee6fd /docs | |
| parent | 2fa7f56cec447a029ac612f0ff12eb8605c963af (diff) | |
feat(status): Add pipestatus display in status module (#2481)
* feat: Add pipestatus display in status module
This MR is based on this one https://github.com/starship/starship/pull/370
* Documentation
* Add a test with map_symbol false
* Handle bash preexec pipestatus
* Add zsh support
* Add fish support
Thanks kidonng for the diff patch
* Rename sucess_symbol to success_symbol
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 5ba450c4e..a9962b7da 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2703,6 +2703,7 @@ This module is not supported on elvish and nu shell. | ------------------------- | ----------------------------- | ------------------------------------------------------ | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | +| `success_symbol` | `"✔️"` | The symbol displayed on program success | | `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable | | `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | | `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | @@ -2710,6 +2711,9 @@ This module is not supported on elvish and nu shell. | `style` | `"bold red"` | The style for the module. | | `recognize_signal_code` | `true` | Enable signal mapping from exit code | | `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | +| `pipestatus_separator` | `|` | The symbol that separate in pipe program exit codes | +| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | | `disabled` | `true` | Disables the `status` module. | ### Variables @@ -2722,6 +2726,7 @@ This module is not supported on elvish and nu shell. | signal_number | `9` | Signal number corresponding to the exit code, only if signalled | | signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | | maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | |