From 771676f5ed6140201be8ad980faec476d48cdf13 Mon Sep 17 00:00:00 2001 From: Michael Rienstra Date: Fri, 8 Oct 2021 15:57:44 -0700 Subject: [PATCH 1/2] README.md --- packages/jest-matcher-utils/README.md | 42 +++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 packages/jest-matcher-utils/README.md diff --git a/packages/jest-matcher-utils/README.md b/packages/jest-matcher-utils/README.md new file mode 100644 index 000000000000..f0917048ee39 --- /dev/null +++ b/packages/jest-matcher-utils/README.md @@ -0,0 +1,42 @@ +# jest-matcher-utils + +This package's exports are most notably used by `expect`'s [`this.utils`](https://jestjs.io/docs/expect#thisutils). + +## Installation + +To add this package as a dependency of a project, run either of the following commands: + +- `npm install jest-matcher-utils` +- `yarn add jest-matcher-utils` + +## Exports ([src/index.ts](jest-matcher-utils/src/index.ts)) + +### Functions +`stringify` +`highlightTrailingWhitespace` +`printReceived` +`printExpected` +`printWithType` +`ensureNoExpected` +`ensureActualIsNumber` +`ensureExpectedIsNumber` +`ensureNumbers` +`ensureExpectedIsNonNegativeInteger` +`printDiffOrStringify` +`diff` +`pluralize` +`getLabelPrinter` +`matcherErrorMessage` +`matcherHint` + +### Types +`MatcherHintOptions` +`DiffOptions` + +### Constants +`EXPECTED_COLOR` +`RECEIVED_COLOR` +`INVERTED_COLOR` +`BOLD_WEIGHT` +`DIM_COLOR` +`SUGGEST_TO_CONTAIN_EQUAL` From 24afe8aa44c57d75d3a7e2bab5e3de31ce15ff05 Mon Sep 17 00:00:00 2001 From: Michael Rienstra Date: Sat, 9 Oct 2021 10:39:05 -0700 Subject: [PATCH 2/2] chore: prettier packages/jest-matcher-utils/README.md --- packages/jest-matcher-utils/README.md | 30 ++++++--------------------- 1 file changed, 6 insertions(+), 24 deletions(-) diff --git a/packages/jest-matcher-utils/README.md b/packages/jest-matcher-utils/README.md index f0917048ee39..a43ce68473bb 100644 --- a/packages/jest-matcher-utils/README.md +++ b/packages/jest-matcher-utils/README.md @@ -12,31 +12,13 @@ To add this package as a dependency of a project, run either of the following co ## Exports ([src/index.ts](jest-matcher-utils/src/index.ts)) ### Functions -`stringify` -`highlightTrailingWhitespace` -`printReceived` -`printExpected` -`printWithType` -`ensureNoExpected` -`ensureActualIsNumber` -`ensureExpectedIsNumber` -`ensureNumbers` -`ensureExpectedIsNonNegativeInteger` -`printDiffOrStringify` -`diff` -`pluralize` -`getLabelPrinter` -`matcherErrorMessage` -`matcherHint` + +`stringify` `highlightTrailingWhitespace` `printReceived` `printExpected` `printWithType` `ensureNoExpected` `ensureActualIsNumber` `ensureExpectedIsNumber` `ensureNumbers` `ensureExpectedIsNonNegativeInteger` `printDiffOrStringify` `diff` `pluralize` `getLabelPrinter` `matcherErrorMessage` `matcherHint` ### Types -`MatcherHintOptions` -`DiffOptions` + +`MatcherHintOptions` `DiffOptions` ### Constants -`EXPECTED_COLOR` -`RECEIVED_COLOR` -`INVERTED_COLOR` -`BOLD_WEIGHT` -`DIM_COLOR` -`SUGGEST_TO_CONTAIN_EQUAL` + +`EXPECTED_COLOR` `RECEIVED_COLOR` `INVERTED_COLOR` `BOLD_WEIGHT` `DIM_COLOR` `SUGGEST_TO_CONTAIN_EQUAL`