diff options
author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-02-20 18:32:04 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-20 18:32:04 +0100 |
commit | 9313e90773c8536e520bb34750345d7e4d4a6946 (patch) | |
tree | 7395ca5f67613f0cdf754e8bfdf7d7e3d8e22899 /docs | |
parent | 37d3425d219fef5e9de60ef29295f1bb7b57e94b (diff) |
feat(elixir): Configure when module is shown (#2340)
This makes it possible to configure when the elixir 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 | 37 |
1 files changed, 20 insertions, 17 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index f2438edd2..ab4c5e3d3 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -789,16 +789,16 @@ when there is a csproj file in the current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | -| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `[ "global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dotnet` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | +| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | +| `heuristic` | `true` | Use faster version detection to keep starship snappy. | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dotnet` module. | ### Variables @@ -825,18 +825,21 @@ heuristic = false ## Elixir The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. -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 `mix.exs` file. ### Options -| Option | Default | Description | -| ---------- | --------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `style` | `"bold purple"` | The style for the module. | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Option | Default | Description | +| ------------------- | --------------------------------------------------------- | --------------------------------------------------------------- | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold purple"` | The style for the module. | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables |