From 22d7a20afd09c435a9345550d8b0338af2ff8533 Mon Sep 17 00:00:00 2001 From: Gili Tzabari Date: Thu, 31 Oct 2024 16:47:51 -0400 Subject: [PATCH] Test release --- README.md | 14 +++++++------- docs/Changelog.md | 2 +- docs/Features.md | 2 +- docs/String_Diff.md | 2 +- package.json | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0cf7ede..7b9ae4e 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.4/docs/api/) +[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.5/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.4 +npm install --save @cowwoc/requirements@4.0.5 ``` or [pnpm](https://pnpm.io/): ```shell -pnpm add @cowwoc/requirements@4.0.4 +pnpm add @cowwoc/requirements@4.0.5 ``` ## Usage Example @@ -146,11 +146,11 @@ This library offers the following features: Designed for discovery using your favorite IDE's auto-complete feature. The main entry points are: -* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~requireThat) +* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~requireThat) for method preconditions. -* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~assertThat) +* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~assertThat) for [class invariants, method postconditions and private methods](docs/Features.md#assertion-support). -* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~checkIf) +* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~checkIf) for multiple failures and customized error handling. See the [API documentation](https://cowwoc.github.io/requirements.java/10.0/docs/api/) for more details. diff --git a/docs/Changelog.md b/docs/Changelog.md index 5c4b05f..eb1244b 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -1,7 +1,7 @@ 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.4 - 2024/10/31 +## Version 4.0.5 - 2024/10/31 * Breaking changes: * Replaced `validateThat()` with `checkIf()`. diff --git a/docs/Features.md b/docs/Features.md index 969694f..9930cb7 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.4/docs/api/ObjectVerifier.html#isEqualTo) +a [String comparison](https://cowwoc.github.io/requirements.js/4.0.5/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 4b31bdd..b305fab 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.4/docs/api/ObjectVerifier.html#isEqualTo) +a [String comparison](https://cowwoc.github.io/requirements.js/4.0.5/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 85e070e..ca96959 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cowwoc/requirements", - "version": "4.0.4", + "version": "4.0.5", "keywords": [ "preconditions", "postconditions",