Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-25 11:20:01 +00:00
Code Issues Releases Activity

feat(helm): Configure when the module is shown (#2352)

Browse Source 
This makes it possible to configure when the helm module is shown based
on the contents of a directory.
This commit is contained in:
Thomas O'Donnell 2021-02-21 19:57:23 +01:00 committed by GitHub
parent 64288c2e04
commit 0083e28827
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/config/README.md
View File

@ -1291,19 +1291,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm
The `helm` module shows the currently installed version of Helm.
The module will be shown if any of the following conditions are met:
By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables

6
src/configs/helm.rs
View File

@ -8,6 +8,9 @@ pub struct HelmConfig<'a> {
pub symbol: &'a str,
pub style: &'a str,
pub disabled: bool,
pub detect_extensions: Vec<&'a str>,
pub detect_files: Vec<&'a str>,
pub detect_folders: Vec<&'a str>,
}
impl<'a> RootModuleConfig<'a> for HelmConfig<'a> {
@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for HelmConfig<'a> {
symbol: "⎈ ",
style: "bold white",
disabled: false,
detect_extensions: vec![],
detect_files: vec!["helmfile.yaml", "Chart.yaml"],
detect_folders: vec![],
}
}
}

13
src/modules/helm.rs
View File

@ -4,22 +4,21 @@ use crate::configs::helm::HelmConfig;
use crate::formatter::StringFormatter;
/// Creates a module with the current Helm version
///
/// Will display the Helm version if any of the following criteria are met:
/// - Current directory contains a `helmfile.yaml` file
/// - Current directory contains a `Chart.yaml` file
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
let mut module = context.new_module("helm");
let config = HelmConfig::try_load(module.config);
let is_helm_project = context
.try_begin_scan()?
.set_files(&["helmfile.yaml", "Chart.yaml"])
.set_files(&config.detect_files)
.set_extensions(&config.detect_extensions)
.set_folders(&config.detect_folders)
.is_match();
if !is_helm_project {
return None;
}
let mut module = context.new_module("helm");
let config = HelmConfig::try_load(module.config);
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
formatter
.map_meta(|var, _| match var {