Skip to content

Commit

Permalink
Bugfix: Added missing "strip-ansi" dependency.
Browse files Browse the repository at this point in the history
  • Loading branch information
cowwoc committed Nov 9, 2024
1 parent f924381 commit da1605b
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 34 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[![npm version](https://badge.fury.io/js/%40cowwoc%2Frequirements.svg)](https://badge.fury.io/js/%40cowwoc%2Frequirements)
[![build-status](https://github.com/cowwoc/requirements.js/workflows/Build/badge.svg)](https://github.com/cowwoc/requirements.js/actions?query=workflow%3ABuild)

# <img src="https://raw.githubusercontent.com/cowwoc/requirements.js/release-4.0.7/docs/checklist.svg?sanitize=true" width=64 height=64 alt="checklist"> Requirements API
# <img src="https://raw.githubusercontent.com/cowwoc/requirements.js/release-4.0.8/docs/checklist.svg?sanitize=true" width=64 height=64 alt="checklist"> Requirements API

[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/)
[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/)
[![Changelog](https://img.shields.io/badge/changelog-A345D5.svg)](docs/Changelog.md)
[![java](https://img.shields.io/badge/other%20languages-java-457FD5.svg)](../../../requirements.java)

Expand All @@ -18,13 +18,13 @@ A [fluent API](https://en.m.wikipedia.org/docs/Fluent_interface) for enforcing
To get started, add this dependency:

```shell
npm install --save @cowwoc/[email protected].7
npm install --save @cowwoc/[email protected].8
```

or [pnpm](https://pnpm.io/):

```shell
pnpm add @cowwoc/[email protected].7
pnpm add @cowwoc/[email protected].8
```

## Usage Example
Expand Down Expand Up @@ -147,32 +147,32 @@ Designed for discovery using your favorite IDE's auto-complete feature.
The main entry points are:

* `requireThat(value, name)` for method preconditions.
* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThat.html)
* [requireThatArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatArray.html)
* [requireThatBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatBoolean.html)
* [requireThatMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatMap.html)
* [requireThatNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatNumber.html)
* [requireThatSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatSet.html)
* [requireThatString(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.requireThatString.html)
* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThat.html)
* [requireThatArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatArray.html)
* [requireThatBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatBoolean.html)
* [requireThatMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatMap.html)
* [requireThatNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatNumber.html)
* [requireThatSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatSet.html)
* [requireThatString(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.requireThatString.html)
* `assertThat(value, name)` for [class invariants, method postconditions and private methods](docs/Features.md#assertion-support).
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThat.html)
* [assertThatArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatArray.html)
* [assertThatBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatBoolean.html)
* [assertThatMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatMap.html)
* [assertThatNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatNumber.html)
* [assertThatSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatSet.html)
* [assertThatString(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.assertThatString.html)
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThat.html)
* [assertThatArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatArray.html)
* [assertThatBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatBoolean.html)
* [assertThatMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatMap.html)
* [assertThatNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatNumber.html)
* [assertThatSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatSet.html)
* [assertThatString(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.assertThatString.html)
* `checkIf(value, name)` for multiple failures and customized error handling.
* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIf.html)
* [checkIfArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfArray.html)
* [checkIfBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfBoolean.html)
* [checkIfMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfMap.html)
* [checkIfNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfNumber.html)
* [checkIfSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfSet.html)
* [checkIfString(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/functions/DefaultJavascriptValidators.checkIfString.html)
* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIf.html)
* [checkIfArray(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfArray.html)
* [checkIfBoolean(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfBoolean.html)
* [checkIfMap(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfMap.html)
* [checkIfNumber(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfNumber.html)
* [checkIfSet(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfSet.html)
* [checkIfString(value, name)](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/functions/DefaultJavascriptValidators.checkIfString.html)


See the [API documentation](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/) for more details.
See the [API documentation](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/) for more details.

## Best practices

Expand Down
4 changes: 4 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Minor updates involving cosmetic changes have been omitted from this list. See
https://github.com/cowwoc/requirements.java/commits/master for a full list.

## Version 4.0.8 - 2024/11/09

* Bugfix: Added missing `strip-ansi` dependency.

## Version 4.0.7 - 2024/11/05

* Improvements
Expand Down
2 changes: 1 addition & 1 deletion docs/Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ requireThat(nameToAge, "nameToAge").
## String diff

When
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/ObjectVerifier.html#isEqualTo)
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/ObjectVerifier.html#isEqualTo)
fails, the library outputs a diff of the values being compared.

Depending on the terminal capability, you will see a [textual](Textual_Diff.md) or a colored diff.
Expand Down
2 changes: 1 addition & 1 deletion docs/String_Diff.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
When
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/ObjectVerifier.html#isEqualTo)
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.8/docs/api/ObjectVerifier.html#isEqualTo)
fails, the library outputs a [diff](https://en.wikipedia.org/wiki/Diff) of the values being compared.

Depending on the terminal capability, you will see a [Textual](Textual_Diff.md) or [Colored](Colored_Diff.md)
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cowwoc/requirements",
"version": "4.0.7",
"version": "4.0.8",
"keywords": [
"preconditions",
"postconditions",
Expand Down Expand Up @@ -33,7 +33,8 @@
"dependencies": {
"chalk": "^5.3.0",
"diff": "7.0.0",
"lodash.isequal": "^4.5.0"
"lodash.isequal": "^4.5.0",
"strip-ansi": "^7.1.0"
},
"license": "Apache-2.0",
"packageManager": "[email protected]",
Expand Down Expand Up @@ -64,7 +65,6 @@
"mocha": "^10.8.2",
"rollup": "^4.24.4",
"source-map-support": "^0.5.21",
"strip-ansi": "^7.1.0",
"terser": "^5.36.0",
"tslib": "^2.8.1",
"tsx": "^4.19.2",
Expand Down
6 changes: 3 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit da1605b

Please sign in to comment.