extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-07 17:05:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(cmake): Configure when the module is shown (#2280)

Browse Source 
This makes it possible to configure when the cmake 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:
Thomas O'Donnell 2021-02-13 11:38:47 +01:00 committed by GitHub
parent eccbda8328
commit 47a769cdf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/config/README.md
View File

@ -442,19 +442,23 @@ vicmd_symbol = "[V](bold green) "
## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
The `cmake` module shows the currently installed version of CMake. By default
the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Options
| Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
| Option | Default | Description |
| ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables

6
src/configs/cmake.rs
View File

@ -8,6 +8,9 @@ pub struct CMakeConfig<'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 CMakeConfig<'a> {
@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for CMakeConfig<'a> {
symbol: "喝 ",
style: "bold blue",
disabled: false,
detect_extensions: vec![],
detect_files: vec!["CMakeLists.txt", "CMakeCache.txt"],
detect_folders: vec![],
}
}
}

12
src/modules/cmake.rs
View File

@ -4,21 +4,21 @@ use crate::configs::cmake::CMakeConfig;
use crate::formatter::StringFormatter;
/// Creates a module with the current CMake version
///
/// Will display the CMake version if any of the following criteria are met:
/// - The current directory contains a `CMakeLists.txt` or `CMakeCache.txt`
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
let mut module = context.new_module("cmake");
let config = CMakeConfig::try_load(module.config);
let is_cmake_project = context
.try_begin_scan()?
.set_files(&["CMakeLists.txt", "CMakeCache.txt"])
.set_files(&config.detect_files)
.set_extensions(&config.detect_extensions)
.set_folders(&config.detect_folders)
.is_match();
if !is_cmake_project {
return None;
}
let mut module = context.new_module("cmake");
let config = CMakeConfig::try_load(module.config);
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
formatter
.map_meta(|variable, _| match variable {