summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShu Kutsuzawa <cappyzawa@gmail.com>2021-02-21 21:21:20 +0900
committerGitHub <noreply@github.com>2021-02-21 13:21:20 +0100
commit4651060999635d654775e9b1d2d7c851d9c3fe58 (patch)
treef834326f2e66f364ddf0054abb298fd971371166
parent873a005c4203e1359fc8d2d4548c4e8993262fe7 (diff)
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.
-rw-r--r--docs/config/README.md17
-rw-r--r--src/configs/nim.rs6
-rw-r--r--src/modules/nim.rs14
3 files changed, 21 insertions, 16 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index c52f72fb2..1d6e11c62 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -1708,7 +1708,7 @@ truncation_symbol = ""
## 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 file with the `.nim` extension
@@ -1717,12 +1717,15 @@ The module will be shown if any of the following conditions are met:
### Options
-| Option | Default | Description |
-| ---------- | ---------------------------------- | ----------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
-| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
-| `style` | `"bold yellow"` | The style for the module. |
-| `disabled` | `false` | Disables the `nim` module. |
+| Option | Default | Description |
+| -------------------- | ------------------------------------ | ----------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
+| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
+| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
+| `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
diff --git a/src/configs/nim.rs b/src/configs/nim.rs
index 752b01783..1e67746bb 100644
--- a/src/configs/nim.rs
+++ b/src/configs/nim.rs
@@ -8,6 +8,9 @@ pub struct NimConfig<'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 NimConfig<'a> {
@@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for NimConfig<'a> {
symbol: "👑 ",
style: "yellow bold",
disabled: false,
+ detect_extensions: vec!["nim", "nims", "nimble"],
+ detect_files: vec!["nim.cfg"],
+ detect_folders: vec![],
}
}
}
diff --git a/src/modules/nim.rs b/src/modules/nim.rs
index 75af863c3..f7bea7bac 100644
--- a/src/modules/nim.rs
+++ b/src/modules/nim.rs
@@ -4,24 +4,20 @@ use crate::configs::nim::NimConfig;
use crate::formatter::StringFormatter;
/// 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>> {
+ let mut module = context.new_module("nim");
+ let config = NimConfig::try_load(module.config);
let is_nim_project = context
.try_begin_scan()?
- .set_files(&["nim.cfg"])
- .set_extensions(&["nim", "nims", "nimble"])
+ .set_files(&config.detect_files)
+ .set_extensions(&config.detect_extensions)
+ .set_folders(&config.detect_files)
.is_match();
if !is_nim_project {
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| {
formatter
.map_meta(|var, _| match var {