diff options
| author | Bill <bill@billrisher.com> | 2021-09-07 07:59:14 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-07 09:59:14 -0500 |
| commit | 08b5cd0862453e595e57d50bf4825ee5f538e481 (patch) | |
| tree | 1486a36adf960dd8429dfa3d34b074dc12d43f73 /docs | |
| parent | 296718ce286ed551d8b20632294a8bb7de516ea3 (diff) | |
feat(cobol): added COBOL module (#2994)
* feat: added COBOL module
* slight README fix
* added command faking for COBOL
* updated COBOL symbol to better suit language
Co-authored-by: Bill Risher <bill@encephaloinvestments.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 31 | ||||
| -rw-r--r-- | docs/presets/README.md | 9 |
2 files changed, 40 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index b54fe3db9..8b7a61063 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -502,6 +502,37 @@ the module will be activated if any of the following conditions are met: \*: This variable can only be used as a part of a style string +## COBOL / GNUCOBOL + +The `cobol` module shows the currently installed version of COBOL. +By default, the module will be shown if any of the following conditions are met: + +- The current directory contains any files ending in `.cob` or `.COB` +- The current directory contains any files ending in `.cbl` or `.CBL` + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------ | +| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`| +| `style` | `"bold blue"` | The style for the module. | +| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `cobol` module. | + +### Variables + +| Variable | Example | Description | +| -------- | --------- | ------------------------------------ | +| version | `v3.1.2.0`| The version of `cobol` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + ## Command Duration The `cmd_duration` module shows how long the last command took to execute. diff --git a/docs/presets/README.md b/docs/presets/README.md index 4754f4528..7c8ce2ee0 100644 --- a/docs/presets/README.md +++ b/docs/presets/README.md @@ -115,6 +115,9 @@ format = '\[[$symbol($version)]($style)\]' [cmd_duration] format = '\[[⏱ $duration ]($style)\]' +[cobol] +format = '\[[$symbol($version)]($style)\]' + [conda] format = '\[[$symbol$environment]($style)\]' @@ -276,6 +279,9 @@ deleted = "x" [aws] symbol = "aws " +[cobol] +symbol = "cobol " + [conda] symbol = "conda " @@ -379,6 +385,9 @@ This preset hides the version of language runtimes. If you work in containers or [cmake] format = "via [$symbol]($style)" +[cobol] +format = "via [$symbol]($style)" + [crystal] format = "via [$symbol]($style)" |