diff options
| -rw-r--r-- | docs/config/README.md | 17 | ||||
| -rw-r--r-- | src/configs/ocaml.rs | 6 | ||||
| -rw-r--r-- | src/modules/ocaml.rs | 19 |
3 files changed, 21 insertions, 21 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index a952e9f1c..7104d1d57 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1832,7 +1832,7 @@ format = "via [🤖 $version](bold green) " ## OCaml The `ocaml` module shows the currently installed version of OCaml. -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 file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1843,12 +1843,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 string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `ocaml` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | +| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables diff --git a/src/configs/ocaml.rs b/src/configs/ocaml.rs index f407c6b9d..7f1dad715 100644 --- a/src/configs/ocaml.rs +++ b/src/configs/ocaml.rs @@ -8,6 +8,9 @@ pub struct OCamlConfig<'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 OCamlConfig<'a> { @@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for OCamlConfig<'a> { symbol: "🐫 ", style: "bold yellow", disabled: false, + detect_extensions: vec!["opam", "ml", "mli", "re", "rei"], + detect_files: vec!["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"], + detect_folders: vec!["_opam", "esy.lock"], } } } diff --git a/src/modules/ocaml.rs b/src/modules/ocaml.rs index 0c7bd8d7a..0b7a19dd1 100644 --- a/src/modules/ocaml.rs +++ b/src/modules/ocaml.rs @@ -4,29 +4,20 @@ use crate::configs::ocaml::OCamlConfig; use crate::formatter::StringFormatter; /// Creates a module with the current OCaml version -/// -/// Will display the OCaml version if any of the following criteria are met: -/// - Current directory contains a file with `.opam` extension or `_opam` directory -/// - Current directory contains a `esy.lock` directory -/// - Current directory contains a `dune` or `dune-project` file -/// - Current directory contains a `jbuild` or `jbuild-ignore` file -/// - Current directory contains a `.merlin` file -/// - Current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> { + let mut module = context.new_module("ocaml"); + let config: OCamlConfig = OCamlConfig::try_load(module.config); let is_ocaml_project = context .try_begin_scan()? - .set_files(&["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]) - .set_folders(&["_opam", "esy.lock"]) - .set_extensions(&["opam", "ml", "mli", "re", "rei"]) + .set_files(&config.detect_files) + .set_folders(&config.detect_folders) + .set_extensions(&config.detect_extensions) .is_match(); if !is_ocaml_project { return None; } - let mut module = context.new_module("ocaml"); - let config: OCamlConfig = OCamlConfig::try_load(module.config); - let parsed = StringFormatter::new(config.format).and_then(|formatter| { formatter .map_meta(|variable, _| match variable { |