diff options
| author | Dario Vladović <d.vladimyr@gmail.com> | 2021-04-10 19:06:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-10 19:06:25 +0200 |
| commit | fe030c2064e20f1359ab4844d3b3472a1ed1f6b6 (patch) | |
| tree | 076eed69af43236b5000e05b685ad16b8ca89514 /docs | |
| parent | 436eb61efd57a9e76131fc293486ef562e2b1f79 (diff) | |
refactor: propagate version formatting errors (#2566)
* refactor: propagate version formatting errors
* refactor: trim version formatting boilerplate
* refactor(node): unwrap version formatting
* docs: fix typo
* docs: remove dots after `version_format`
* feat: lazy version parsing
* refactor(version-formatter): collect segments into string
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 940161ede..6b9a6c132 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1379,7 +1379,7 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `version_format`. | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | @@ -1825,9 +1825,9 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format`. | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `" "` | A format string representing the symbol of NodeJS. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | | `style` | `"bold green"` | The style for the module. | @@ -2135,7 +2135,7 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | -| `version_format`. | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the module. | | `pyenv_version_name` | `false` | Use pyenv to get Python version | @@ -2214,7 +2214,7 @@ The module will be shown if any of the following conditions are met: | Option | Default | Description | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format`. | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | @@ -2254,7 +2254,7 @@ The module will be shown if any of the following conditions are met: | Option | Default | Description | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format`. | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | |