diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-02-20 18:33:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-20 18:33:00 +0100 |
| commit | 71b6fc17777bd587199a6c1b2c7e30e1a87535f7 (patch) | |
| tree | d105d1a287228fbc957b9724c47384fdc2227474 /docs | |
| parent | 9313e90773c8536e520bb34750345d7e4d4a6946 (diff) | |
feat(elm): Configure when the module is shown (#2341)
This makes it possible to configure when the elm 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.
Diffstat (limited to 'docs')
| -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 ab4c5e3d3..3a82c5e05 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -864,7 +864,7 @@ symbol = "🔮 " ## Elm The `elm` module shows the currently installed version of Elm. -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 `elm.json` file - The current directory contains a `elm-package.json` file @@ -874,12 +874,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` | `"🌳 "` | A format string representing the symbol of Elm. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `elm` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------- | ----------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | +| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `elm` module. | ### Variables |