diff options
| author | Shu Kutsuzawa <cappyzawa@gmail.com> | 2021-02-22 03:53:10 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 19:53:10 +0100 |
| commit | fe6f9eeb4de899b813b6c42a60597a0b86429557 (patch) | |
| tree | 9e3c0798467152675df9f3a09db67dd7d1a5f430 /docs | |
| parent | efb82454f2ce63a2e7af07888421bd88271432f1 (diff) | |
feat(purescript): Configure when the module is shown (#2357)
This makes it possible to configure when the purescript 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 5de5b42be..d456abd8b 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2046,19 +2046,22 @@ format = "via [🔹 $version](147 bold) " ## PureScript The `purescript` module shows the currently installed version of PureScript version. -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 `spago.dhall` file -- The current directory contains a \*.purs files +- The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------ | ------------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables |