diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-02-21 13:20:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 13:20:14 +0100 |
| commit | 873a005c4203e1359fc8d2d4548c4e8993262fe7 (patch) | |
| tree | 0efd67d99d09a6799d52275fdd5d87d907719bbf /docs | |
| parent | 7331e4bec6e0ad18ae29bed9b862d9b345ead67c (diff) | |
feat(erlang): Configure when the module is shown (#2346)
* feat(erlang): Configure when the module is shown
This makes it possible to configure when the erlang 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: Shu Kutsuzawa <cappyzawa@gmail.com>
Co-authored-by: Shu Kutsuzawa <cappyzawa@gmail.com>
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 b18886251..c52f72fb2 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -944,19 +944,22 @@ default = "unknown shell" ## Erlang The `erlang` module shows the currently installed version of Erlang/OTP. -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 `rebar.config` file. - The current directory contains a `erlang.mk` file. ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `erlang` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables |