diff options
| author | David Knaack <davidkna@users.noreply.github.com> | 2021-02-21 18:01:31 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 18:01:31 +0100 |
| commit | 509767adc02c39f206e7f0df15920ddba1b2444e (patch) | |
| tree | 86d0b6d4ca488bc947521dbce433c3b7fc72684c /docs | |
| parent | a499f30157bb231d8f39557cdf504e7c094b68aa (diff) | |
feat(swift): Configure when the module is shown (#2349)
This makes it possible to configure when the swift 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 7578e42ba..a952e9f1c 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2412,7 +2412,7 @@ disabled = false ## Swift -The `swift` module shows the currently installed version of Swift. +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file @@ -2420,12 +2420,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 Swift | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables |