diff options
| author | Shu Kutsuzawa <cappyzawa@yahoo.ne.jp> | 2021-02-18 03:03:09 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-17 19:03:09 +0100 |
| commit | 5e931604563b3ec77eb52980b2d8991414f85d22 (patch) | |
| tree | 470f2351d560531cc386806e30c146adedb58813 /docs | |
| parent | 97fbfffd7e25dc750c6a4602f776cf039cc755e1 (diff) | |
feat(lua): Configure when the module is shown (#2326)
This makes it possible to configure when the lua 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 | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 1249fa03f..80da04048 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1569,7 +1569,7 @@ disabled = true ## Lua The `lua` module shows the currently installed version of Lua. -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 `.lua-version` file - The current directory contains a `lua` directory @@ -1577,13 +1577,16 @@ 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 Lua. | -| `style` | `"bold blue"` | The style for the module. | -| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. | +| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["lua"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables |