Llewellyn
/
starship
mirror of https://github.com/Llewellynvdm/starship.git
1
0
Fork 0
Code Issues Releases Activity

fix(character): Standadise Vim config names (#4081) 

Have switched all vi/vim symbols to have the same prefix 'vim'. To
preserve backwards compatibility with existing configs I have added an
alias for the previous config name.
This commit is contained in:
Thomas O'Donnell 2022-06-18 23:23:59 +02:00 committed by GitHub
parent 2ffe1737f0
commit 67619386cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -122,9 +122,9 @@
"error_symbol": "[❯](bold red)",
"format": "$symbol ",
"success_symbol": "[❯](bold green)",
"vicmd_symbol": "[❮](bold green)",
"vimcmd_replace_one_symbol": "[❮](bold purple)",
"vimcmd_replace_symbol": "[❮](bold purple)",
"vimcmd_symbol": "[❮](bold green)",
"vimcmd_visual_symbol": "[❮](bold yellow)"
},
"allOf": [
@ -1783,7 +1783,7 @@
"default": "[❯](bold red)",
"type": "string"
},
"vicmd_symbol": {
"vimcmd_symbol": {
"default": "[❮](bold green)",
"type": "string"
},

22
docs/config/README.md
View File

@ -561,7 +561,7 @@ look at [this example](#with-custom-error-shape).
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`vimcmd_symbol` is only supported in cmd, fish and zsh.
`vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol`
are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
@ -569,16 +569,16 @@ are only supported in fish due to [upstream issues with mode detection in zsh](h
### Options
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables

5
src/configs/character.rs
View File

@ -7,7 +7,8 @@ pub struct CharacterConfig<'a> {
pub format: &'a str,
pub success_symbol: &'a str,
pub error_symbol: &'a str,
pub vicmd_symbol: &'a str,
#[serde(alias = "vicmd_symbol")]
pub vimcmd_symbol: &'a str,
pub vimcmd_visual_symbol: &'a str,
pub vimcmd_replace_symbol: &'a str,
pub vimcmd_replace_one_symbol: &'a str,
@ -20,7 +21,7 @@ impl<'a> Default for CharacterConfig<'a> {
format: "$symbol ",
success_symbol: "[❯](bold green)",
error_symbol: "[❯](bold red)",
vicmd_symbol: "[❮](bold green)",
vimcmd_symbol: "[❮](bold green)",
vimcmd_visual_symbol: "[❮](bold yellow)",
vimcmd_replace_symbol: "[❮](bold purple)",
vimcmd_replace_one_symbol: "[❮](bold purple)",

2
src/modules/character.rs
View File

@ -45,7 +45,7 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
};
let symbol = match mode {
ShellEditMode::Normal => config.vicmd_symbol,
ShellEditMode::Normal => config.vimcmd_symbol,
ShellEditMode::Visual => config.vimcmd_visual_symbol,
ShellEditMode::Replace => config.vimcmd_replace_symbol,
ShellEditMode::ReplaceOne => config.vimcmd_replace_one_symbol,