mirror of
https://github.com/starship/starship.git
synced 2026-06-23 02:05:51 +07:00
feat(red): create module (#2599)
* create module * fmt * fix clippy * fmt even though i already did it * add all extensions * tests for .reds * change from circle to triangle * remove hi.red * fix test name * update variables * fix comment * Update docs/config/README.md Co-authored-by: Dario Vladović <d.vladimyr@gmail.com> * Update docs/config/README.md Co-authored-by: Dario Vladović <d.vladimyr@gmail.com> * apply patchs Co-authored-by: Dario Vladović <d.vladimyr@gmail.com>
This commit is contained in:
@@ -217,6 +217,7 @@ $perl\
|
||||
$php\
|
||||
$purescript\
|
||||
$python\
|
||||
$red\
|
||||
$ruby\
|
||||
$rust\
|
||||
$scala\
|
||||
@@ -2243,6 +2244,45 @@ python_binary = "python3"
|
||||
detect_extensions = []
|
||||
```
|
||||
|
||||
## Red
|
||||
|
||||
By default the `red` module shows the currently installed version of Red.
|
||||
The module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a file with `.red` or `.reds` extension
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"red bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `red` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | -------- | ------------------------------------ |
|
||||
| version | `v2.5.1` | The version of `red` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[red]
|
||||
symbol = "🔴 "
|
||||
```
|
||||
|
||||
## Ruby
|
||||
|
||||
By default the `ruby` module shows the currently installed version of Ruby.
|
||||
|
||||
Reference in New Issue
Block a user