Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-24 13:47:38 +00:00
Code Issues Releases Activity

feat(status): Add pipestatus_segment_format option to status module (#4103)

Browse Source 
Add pipestatus_segment_format
This commit is contained in:
Artyom Belousov 2022-07-19 16:07:50 +03:00 committed by GitHub
parent 442d084962
commit 61438484bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 51 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/config-schema.json vendored
View File

@ -4521,6 +4521,12 @@
"default": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)", "default": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)",
"type": "string" "type": "string"
}, },
"pipestatus_segment_format": {
"type": [
"string",
"null"
]
},
"disabled": { "disabled": {
"default": true, "default": true,
"type": "boolean" "type": "boolean"

33
docs/config/README.md
View File

@ -3322,22 +3322,23 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- | | --------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | The format of the module | | `format` | `"[$symbol$status]($style) "` | The format of the module |
| `symbol` | `"✖"` | The symbol displayed on program error | | `symbol` | `"✖"` | The symbol displayed on program error |
| `success_symbol` | `""` | The symbol displayed on program success | | `success_symbol` | `""` | The symbol displayed on program success |
| `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable | | `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | | `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | | `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | The symbol displayed on any signal | | `signal_symbol` | `"⚡"` | The symbol displayed on any signal |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `recognize_signal_code` | `true` | Enable signal mapping from exit code | | `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Enable symbols mapping from exit code | | `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Enable pipestatus reporting | | `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | ` | ` | | `pipestatus_separator` | <code>&vert;</code> | The symbol used to separate pipestatus segments |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | | `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. | | `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
| `disabled` | `true` | Disables the `status` module. |
### Variables ### Variables

3
src/configs/status.rs
View File

@ -17,6 +17,8 @@ pub struct StatusConfig<'a> {
pub pipestatus: bool, pub pipestatus: bool,
pub pipestatus_separator: &'a str, pub pipestatus_separator: &'a str,
pub pipestatus_format: &'a str, pub pipestatus_format: &'a str,
#[serde(skip_serializing_if = "Option::is_none")]
pub pipestatus_segment_format: Option<&'a str>,
pub disabled: bool, pub disabled: bool,
} }
@ -37,6 +39,7 @@ impl<'a> Default for StatusConfig<'a> {
pipestatus_separator: "|", pipestatus_separator: "|",
pipestatus_format: pipestatus_format:
"\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)", "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)",
pipestatus_segment_format: None,
disabled: true, disabled: true,
} }
} }

26
src/modules/status.rs
View File

@ -54,12 +54,14 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
return None; return None;
} }
let segment_format = config.pipestatus_segment_format.unwrap_or(config.format);
// Create pipestatus string // Create pipestatus string
let pipestatus = match pipestatus_status { let pipestatus = match pipestatus_status {
PipeStatusStatus::Pipe(pipestatus) => pipestatus PipeStatusStatus::Pipe(pipestatus) => pipestatus
.iter() .iter()
.map( .map(
|ec| match format_exit_code(ec.as_str(), config.format, None, &config, context) { |ec| match format_exit_code(ec.as_str(), segment_format, None, &config, context) {
Ok(segments) => segments Ok(segments) => segments
.into_iter() .into_iter()
.map(|s| s.to_string()) .map(|s| s.to_string())
@ -684,4 +686,26 @@ mod tests {
assert_eq!(expected, actual); assert_eq!(expected, actual);
} }
} }
#[test]
fn pipestatus_segment_format() {
let pipe_exit_code = &[0, 1];
let main_exit_code = 1;
let expected = Some("[0]|[1] => <1>".to_string());
let actual = ModuleRenderer::new("status")
.config(toml::toml! {
[status]
format = "\\($status\\)"
pipestatus = true
pipestatus_separator = "|"
pipestatus_format = "$pipestatus => <$status>"
pipestatus_segment_format = "\\[$status\\]"
disabled = false
})
.status(main_exit_code)
.pipestatus(pipe_exit_code)
.collect();
assert_eq!(expected, actual);
}
} }