mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-28 15:56:28 +00:00
feat(nim): Configure when the module is shown (#2347)
This makes it possible to configure when the nim module is shown based on the contents of a directory. This should make it possible to be a lot more granular when configuring the module.
This commit is contained in:
parent
873a005c42
commit
4651060999
@ -1708,7 +1708,7 @@ truncation_symbol = ""
|
|||||||
## Nim
|
## Nim
|
||||||
|
|
||||||
The `nim` module shows the currently installed version of Nim.
|
The `nim` module shows the currently installed version of Nim.
|
||||||
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 `nim.cfg` file
|
- The current directory contains a `nim.cfg` file
|
||||||
- The current directory contains a file with the `.nim` extension
|
- The current directory contains a file with the `.nim` extension
|
||||||
@ -1717,12 +1717,15 @@ The module will be shown if any of the following conditions are met:
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ---------- | ---------------------------------- | ----------------------------------------------------- |
|
| -------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||||
| `style` | `"bold yellow"` | The style for the module. |
|
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||||
| `disabled` | `false` | Disables the `nim` module. |
|
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
| `style` | `"bold yellow"` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `nim` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
|
@ -8,6 +8,9 @@ pub struct NimConfig<'a> {
|
|||||||
pub symbol: &'a str,
|
pub symbol: &'a str,
|
||||||
pub style: &'a str,
|
pub style: &'a str,
|
||||||
pub disabled: bool,
|
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 NimConfig<'a> {
|
impl<'a> RootModuleConfig<'a> for NimConfig<'a> {
|
||||||
@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for NimConfig<'a> {
|
|||||||
symbol: "👑 ",
|
symbol: "👑 ",
|
||||||
style: "yellow bold",
|
style: "yellow bold",
|
||||||
disabled: false,
|
disabled: false,
|
||||||
|
detect_extensions: vec!["nim", "nims", "nimble"],
|
||||||
|
detect_files: vec!["nim.cfg"],
|
||||||
|
detect_folders: vec![],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -4,24 +4,20 @@ use crate::configs::nim::NimConfig;
|
|||||||
use crate::formatter::StringFormatter;
|
use crate::formatter::StringFormatter;
|
||||||
|
|
||||||
/// Creates a module with the current Nim version
|
/// Creates a module with the current Nim version
|
||||||
///
|
|
||||||
/// Will display the Nim version if any of the following criteria are met:
|
|
||||||
/// - The current directory contains a file with extension `.nim`, `.nims`, or `.nimble`
|
|
||||||
/// - The current directory contains a `nim.cfg` file
|
|
||||||
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
||||||
|
let mut module = context.new_module("nim");
|
||||||
|
let config = NimConfig::try_load(module.config);
|
||||||
let is_nim_project = context
|
let is_nim_project = context
|
||||||
.try_begin_scan()?
|
.try_begin_scan()?
|
||||||
.set_files(&["nim.cfg"])
|
.set_files(&config.detect_files)
|
||||||
.set_extensions(&["nim", "nims", "nimble"])
|
.set_extensions(&config.detect_extensions)
|
||||||
|
.set_folders(&config.detect_files)
|
||||||
.is_match();
|
.is_match();
|
||||||
|
|
||||||
if !is_nim_project {
|
if !is_nim_project {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut module = context.new_module("nim");
|
|
||||||
let config = NimConfig::try_load(module.config);
|
|
||||||
|
|
||||||
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
|
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
|
||||||
formatter
|
formatter
|
||||||
.map_meta(|var, _| match var {
|
.map_meta(|var, _| match var {
|
||||||
|
Loading…
Reference in New Issue
Block a user