Skip to content

Commit

Permalink
Updated dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
cowwoc committed Nov 5, 2024
1 parent 543b47f commit c28f601
Show file tree
Hide file tree
Showing 8 changed files with 267 additions and 265 deletions.
16 changes: 8 additions & 8 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.5/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.7/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.5/docs/api/)
[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.7/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].5
npm install --save @cowwoc/[email protected].7
```

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

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

## Usage Example
Expand Down Expand Up @@ -146,14 +146,14 @@ 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.5/docs/api/module-DefaultRequirements.html#~requireThat)
* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/module-DefaultRequirements.html#~requireThat)
for method preconditions.
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~assertThat)
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/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.5/docs/api/module-DefaultRequirements.html#~checkIf)
* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.7/docs/api/module-DefaultRequirements.html#~checkIf)
for multiple failures and customized error handling.

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

## Best practices

Expand Down
7 changes: 7 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
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.7 - 2024/11/05

* Improvements
* Updated dependencies

## Version 4.0.6 - 2024/11/04

* Improvements
* `size().isEqualTo()` and `isNotEqualTo()` now include the array value in the exception context.
* When referencing to a variable number of elements, always use the plural form of a type (e.g.
`actual must contain X entries` even if `X` is one).

## Version 4.0.5 - 2024/10/31

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.5/docs/api/ObjectVerifier.html#isEqualTo)
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.7/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.5/docs/api/ObjectVerifier.html#isEqualTo)
a [String comparison](https://cowwoc.github.io/requirements.js/4.0.7/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
23 changes: 11 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cowwoc/requirements",
"version": "4.0.6",
"version": "4.0.7",
"keywords": [
"preconditions",
"postconditions",
Expand Down Expand Up @@ -39,7 +39,7 @@
"packageManager": "[email protected]",
"devDependencies": {
"@eslint/core": "^0.8.0",
"@eslint/js": "^9.13.0",
"@eslint/js": "^9.14.0",
"@rollup/plugin-commonjs": "^28.0.1",
"@rollup/plugin-node-resolve": "^15.3.0",
"@rollup/plugin-typescript": "^12.1.1",
Expand All @@ -51,17 +51,17 @@
"@types/lodash.padstart": "^4.6.9",
"@types/minimist": "^1.2.5",
"@types/mocha": "^10.0.9",
"@types/node": "^22.8.5",
"@types/node": "^22.9.0",
"@types/rollup-plugin-node-globals": "^1.4.5",
"@types/tmp": "^0.2.6",
"@typescript-eslint/eslint-plugin": "^8.12.2",
"@typescript-eslint/parser": "^8.12.2",
"@typescript-eslint/eslint-plugin": "^8.13.0",
"@typescript-eslint/parser": "^8.13.0",
"browser-sync": "^3.0.3",
"c8": "^10.1.2",
"chai": "^5.1.2",
"chokidar": "^4.0.1",
"diary": "^0.4.5",
"eslint": "^9.13.0",
"eslint": "^9.14.0",
"eslint-plugin-tsdoc": "^0.3.0",
"fancy-log": "^2.0.0",
"glob": "^11.0.0",
Expand All @@ -73,20 +73,19 @@
"pnpm": "^9.12.3",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"rollup": "^4.24.3",
"rollup": "^4.24.4",
"rollup-plugin-node-globals": "^1.4.0",
"source-map-support": "^0.5.21",
"strip-ansi": "^7.1.0",
"taffydb": "^2.7.3",
"terser": "^5.36.0",
"tmp": "^0.2.3",
"ts-node": "^10.9.2",
"tslib": "^2.8.0",
"tslib": "^2.8.1",
"tsx": "^4.19.2",
"typedoc": "^0.26.10",
"typedoc-plugin-mdn-links": "^3.3.5",
"typedoc": "^0.26.11",
"typedoc-plugin-mdn-links": "^3.3.6",
"typedoc-plugin-missing-exports": "^3.0.0",
"typescript": "^5.6.3",
"typescript-eslint": "^8.12.2"
"typescript-eslint": "^8.13.0"
}
}
Loading

0 comments on commit c28f601

Please sign in to comment.