diff options
| author | marcybell <marcy@marcelinesystems.dev> | 2023-06-01 22:24:11 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-01 21:24:11 +0200 |
| commit | 70d2014f3447e616fb45b63b2793b256e19aa631 (patch) | |
| tree | dd837722ebba69f1657fb23cb7611882a407e91c /docs/config/README.md | |
| parent | 351bf9d0b382adcc3e073c1a293fd815bb623f37 (diff) | |
feat(nodejs): Add `expected_version` variable (#5081)
* add `expected_version` variable to `nodejs`
* show comparison symbols with `expected_version`
* documentation, formatting, more tests
* Remapped `engines_version` to $version
* Added better descriptions to docs
* Update docs/config/README.md
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
* Removed clone from `nodejs`, formatting
* refactored function calls
* rewrote `engines_version` formatter
* Moved Lazy variables into maps
---------
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index d75c805d3..5050631c9 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2859,11 +2859,12 @@ By default the module will be shown if any of the following conditions are met: ### Variables -| Variable | Example | Description | -| -------- | ---------- | ------------------------------------ | -| version | `v13.12.0` | The version of `node` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| version | `v13.12.0` | The version of `node` | +| engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. | +| 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 |