diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-02-14 22:21:52 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-14 22:21:52 +0100 |
| commit | d0951db35aaa46b21a604a08a96c878a4da72c87 (patch) | |
| tree | 4042672a81aa9933377673b7763f0888148f1a29 /docs | |
| parent | d4843545aab6e67470a3ff02dcec547fa1de3eed (diff) | |
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
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index c195c8d57..9c7858043 100644 --- a/docs/config/README.md +++ b/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 | -| ---------- | ------------------------------------ | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ----------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `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 |