diff options
| author | David Knaack <davidkna@users.noreply.github.com> | 2021-02-21 18:01:01 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 18:01:01 +0100 |
| commit | 9ba82e8d921f8d0e7ff48f1f063635ca5971e49d (patch) | |
| tree | 85979471ae4134a9b09c9c306d7b25b02aaa13db /docs | |
| parent | c0a0e85556147582513e6aa907f59983b7c42b14 (diff) | |
feat(ruby): Configure when the module is shown (#2351)
This makes it possible to configure when the ruby module is shown
based on the contents of a directory.
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 7eca0305e..db61963cb 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2162,7 +2162,7 @@ detect_extensions = [] ## Ruby -The `ruby` module shows the currently installed version of Ruby. +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file @@ -2171,12 +2171,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 Ruby. | -| `style` | `"bold red"` | The style for the module. | -| `disabled` | `false` | Disables the `ruby` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. | +| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables |