diff options
| author | David Knaack <davidkna@users.noreply.github.com> | 2021-02-15 20:21:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-15 20:21:21 +0100 |
| commit | 856610d53b140f5ab799341ad97b156883b21d65 (patch) | |
| tree | d88baafd60c5806fbac32fc4185bd826379e89b2 /docs | |
| parent | 6bd4e724e9fdddd355540bf25ff7ae8fea9e3ed6 (diff) | |
feat(vagrant): Configure when the module is shown (#2314)
* feat(vagrant): Configure when the module is shown
This makes it possible to configure when the vagrant module is shown based on the contents of a directory.
* fix documentation
Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.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 9c7858043..67e0d6a4c 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2528,18 +2528,21 @@ show_always = true ## Vagrant The `vagrant` module shows the currently installed version of Vagrant. -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 `Vagrantfile` file ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | ### Variables |