diff --git a/README.md b/README.md index 82f4b4a..7d817d3 100644 --- a/README.md +++ b/README.md @@ -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) -# checklist Requirements API +# 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) @@ -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/requirements@4.0.7 +npm install --save @cowwoc/requirements@4.0.8 ``` or [pnpm](https://pnpm.io/): ```shell -pnpm add @cowwoc/requirements@4.0.7 +pnpm add @cowwoc/requirements@4.0.8 ``` ## Usage Example @@ -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 diff --git a/docs/Changelog.md b/docs/Changelog.md index 45e01d6..ed70cfa 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -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 diff --git a/docs/Features.md b/docs/Features.md index fca89a9..b746c1a 100644 --- a/docs/Features.md +++ b/docs/Features.md @@ -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. diff --git a/docs/String_Diff.md b/docs/String_Diff.md index 1f5a684..a27b769 100644 --- a/docs/String_Diff.md +++ b/docs/String_Diff.md @@ -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) diff --git a/package.json b/package.json index b534f24..5c8d65c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cowwoc/requirements", - "version": "4.0.7", + "version": "4.0.8", "keywords": [ "preconditions", "postconditions", @@ -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": "pnpm@9.10.0", @@ -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", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 9dce714..8f33ad3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -17,6 +17,9 @@ importers: lodash.isequal: specifier: ^4.5.0 version: 4.5.0 + strip-ansi: + specifier: ^7.1.0 + version: 7.1.0 devDependencies: '@eslint/js': specifier: ^9.14.0 @@ -96,9 +99,6 @@ importers: source-map-support: specifier: ^0.5.21 version: 0.5.21 - strip-ansi: - specifier: ^7.1.0 - version: 7.1.0 terser: specifier: ^5.36.0 version: 5.36.0