diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-02-14 18:14:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-14 18:14:55 +0100 |
| commit | 81d6f6aa98e420a65fa5ec717dc530c0b2e54140 (patch) | |
| tree | a5666ff56d8761bb97eb1e4bddb2982f198d0f89 /docs/config | |
| parent | 4813763c35d242ced14e4a681add3699bf94c7f7 (diff) | |
feat(crystal): Configure when the module is shown (#2310)
* feat(crystal): Configure when the module is shown
This makes it possible to configure when the crystal 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.
* Update docs/config/README.md
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Diffstat (limited to 'docs/config')
| -rw-r--r-- | docs/config/README.md | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 1a5958e7a..68b801383 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -569,19 +569,22 @@ format = "[$symbol$environment](dimmed green) " ## Crystal The `crystal` module shows the currently installed version of Crystal. -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 `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | --------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables |