diff options
| author | Shu Kutsuzawa <cappyzawa@gmail.com> | 2021-02-21 21:21:20 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 13:21:20 +0100 |
| commit | 4651060999635d654775e9b1d2d7c851d9c3fe58 (patch) | |
| tree | f834326f2e66f364ddf0054abb298fd971371166 /docs | |
| parent | 873a005c4203e1359fc8d2d4548c4e8993262fe7 (diff) | |
feat(nim): Configure when the module is shown (#2347)
This makes it possible to configure when the nim 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 c52f72fb2..1d6e11c62 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1708,7 +1708,7 @@ truncation_symbol = "" ## Nim The `nim` module shows the currently installed version of Nim. -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 `nim.cfg` file - The current directory contains a file with the `.nim` extension @@ -1717,12 +1717,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` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `nim` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------ | ----------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. | +| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables |