diff options
| author | Lyle Mantooth <lyle@cato.digital> | 2022-12-31 09:55:23 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-31 15:55:23 +0100 |
| commit | 67b6376e2ef0835350e3e856ade6602b6c187c42 (patch) | |
| tree | e568d0a14c21b853b5c43b0d4eb1c0f67da08aa5 /docs/config/README.md | |
| parent | 8d2256ab1d0ba288fb6ba9b9248bc2210ca01059 (diff) | |
feat: add pijul_channel module (#4765)
* feat: Pijul VCS support
* Extra bits needed for new module.
* Format Markdown table.
* Fix lint.
* Don't test Pijul module so thoroughly.
Installing from source is too expensive, and compiled binaries are only
available for Windows (and unofficially as well). Perhaps once Pijul
1.0.0 comes out of beta there will be more binaries available in package
repos.
* Format!
* Bad rebase, remove Pijul install from workflow.
* Mock Pijul commands for code coverage.
* Make fake .pijul directory in fixture.
* Truly mock `pijul` command.
* Rename module from `pijul` to `pijul_channel`.
* Format!
* Fix config-schema.json.
* Missed changing module name in docs/ folder.
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 1fc4968fe..601b86e94 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -271,6 +271,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -3175,6 +3176,21 @@ By default the module will be shown if any of the following conditions are met: format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `'î‚ '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. |