haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat(rust): Configure when the module is shown (#2350) 

This makes it possible to configure when the rust module is shown
based on the contents of a directory.
This commit is contained in:
David Knaack 2021-02-21 18:01:17 +01:00 committed by GitHub
parent 9ba82e8d92
commit a499f30157
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/config/README.md
View File

@ -2202,7 +2202,7 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. By default the `rust` module shows the currently installed version of Rust.
The module will be shown if any of the following conditions are met: The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
@ -2210,12 +2210,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` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables

6
src/configs/rust.rs
View File

@ -8,6 +8,9 @@ pub struct RustConfig<'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 RustConfig<'a> { impl<'a> RootModuleConfig<'a> for RustConfig<'a> {
@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for RustConfig<'a> {
symbol: "🦀 ", symbol: "🦀 ",
style: "bold red", style: "bold red",
disabled: false, disabled: false,
detect_extensions: vec!["rs"],
detect_files: vec!["Cargo.toml"],
detect_folders: vec![],
} }
} }
} }

14
src/modules/rust.rs
View File

@ -10,23 +10,21 @@ use crate::configs::rust::RustConfig;
use crate::formatter::StringFormatter; use crate::formatter::StringFormatter;
/// Creates a module with the current Rust version /// Creates a module with the current Rust version
///
/// Will display the Rust version if any of the following criteria are met:
/// - Current directory contains a file with a `.rs` extension
/// - Current directory contains a `Cargo.toml` 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("rust");
let config = RustConfig::try_load(module.config);
let is_rs_project = context let is_rs_project = context
.try_begin_scan()? .try_begin_scan()?
.set_files(&["Cargo.toml"]) .set_files(&config.detect_files)
.set_extensions(&["rs"]) .set_extensions(&config.detect_extensions)
.set_folders(&config.detect_folders)
.is_match(); .is_match();
if !is_rs_project { if !is_rs_project {
return None; return None;
} }
let mut module = context.new_module("rust");
let config = RustConfig::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 {