feat(dart): Configure when the module is shown (#2312)

* feat(dart): Configure when the module is shown

This makes it possible to configure when the dart 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.

* docs(dart): add missing detected files

* removed invalid comment

docs/config/README.md

@@ -608,20 +608,23 @@ format = "via [✨ $version](bold blue) "
 ## Dart
 
 The `dart` module shows the currently installed version of Dart.
-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 `.dart` extension
 - The current directory contains a `.dart_tool` directory
-- The current directory contains a `pubspec.yaml` or `pubspec.lock` file
+- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
 
 ### 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 Dart |
+| `symbol`            | `"🎯 "`                                           | A format string representing the symbol of Dart |
-| `style`    | `"bold blue"`                        | The style for the module.                       |
+| `detect_extensions` | `['dart']`                                        | Which extensions should trigger this moudle.    |
-| `disabled` | `false`                              | Disables the `dart` module.                     |
+| `detect_files`      | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module.     |
+| `detect_folders`    | `[".dart_tool"]`                                  | Which folders should trigger this module.       |
+| `style`             | `"bold blue"`                                     | The style for the module.                       |
+| `disabled`          | `false`                                           | Disables the `dart` module.                     |
 
 ### Variables
 

src/configs/dart.rs

@@ -8,6 +8,9 @@ pub struct DartConfig<'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 DartConfig<'a> {
@@ -17,6 +20,9 @@ impl<'a> RootModuleConfig<'a> for DartConfig<'a> {
             symbol: "🎯 ",
             style: "bold blue",
             disabled: false,
+            detect_extensions: vec!["dart"],
+            detect_files: vec!["pubspec.yaml", "pubspec.yml", "pubspec.lock"],
+            detect_folders: vec![".dart_tool"],
         }
     }
 }

src/modules/dart.rs

@@ -4,26 +4,21 @@ use crate::configs::dart::DartConfig;
 use crate::formatter::StringFormatter;
 
 /// Creates a module with the current Dart version
-///
-/// Will display the Dart version if any of the following criteria are met:
-///     - Current directory contains a file with `.dart` extension
-///     - Current directory contains a `.dart_tool` directory
-///     - Current directory contains a `pubspec.yaml`/`pubspec.yml` or `pubspec.lock` file
 pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
+    let mut module = context.new_module("dart");
+    let config: DartConfig = DartConfig::try_load(module.config);
+
     let is_dart_project = context
         .try_begin_scan()?
-        .set_extensions(&["dart"])
+        .set_files(&config.detect_files)
-        .set_folders(&[".dart_tool"])
+        .set_extensions(&config.detect_extensions)
-        .set_files(&["pubspec.yaml", "pubspec.yml", "pubspec.lock"])
+        .set_folders(&config.detect_folders)
         .is_match();
 
     if !is_dart_project {
         return None;
     }
 
-    let mut module = context.new_module("dart");
-    let config: DartConfig = DartConfig::try_load(module.config);
-
     let parsed = StringFormatter::new(config.format).and_then(|formatter| {
         formatter
             .map_meta(|var, _| match var {