Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Jest matchers utils #1464

Merged
merged 3 commits into from
Aug 19, 2023
Merged

feat: add Jest matchers utils #1464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54191bf
feat: add formatMessage
mdjastrzebski Aug 19, 2023
33024c3
feat: add TS extends
mdjastrzebski Aug 19, 2023
30b50fb
chore: remove old Jest Native tests
mdjastrzebski Aug 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
"@babel/preset-typescript": "^7.18.6",
"@callstack/eslint-config": "^13.0.1",
"@relmify/jest-serializer-strip-ansi": "^1.0.2",
"@testing-library/jest-native": "^5.4.0",
"@types/jest": "^29.2.3",
"@types/react": "^18.2.15",
"@types/react-test-renderer": "^18.0.0",
Expand Down
84 changes: 0 additions & 84 deletions src/__tests__/jest-native.test.tsx
View file
Open in desktop

This file was deleted.

20 changes: 20 additions & 0 deletions src/matchers/extend-expect.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { TextMatch, TextMatchOptions } from '../matches';

export interface JestNativeMatchers<R> {
toBeOnTheScreen(): R;
toHaveTextContent(text: TextMatch, options?: TextMatchOptions): R;
}

// Implicit Jest global `expect`.
declare global {
namespace jest {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
interface Matchers<R, T = {}> extends JestNativeMatchers<R> {}
}
}

// Explicit `@jest/globals` `expect` matchers.
declare module '@jest/expect' {
interface Matchers<R extends void | Promise<void>>
extends JestNativeMatchers<R> {}
}
2 changes: 2 additions & 0 deletions src/matchers/extend-expect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/// <reference path="./extend-expect.d.ts" />

import { toBeOnTheScreen } from './to-be-on-the-screen';

expect.extend({
Expand Down
24 changes: 24 additions & 0 deletions src/matchers/utils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { ReactTestInstance } from 'react-test-renderer';
import {
EXPECTED_COLOR,
RECEIVED_COLOR,
matcherHint,
printWithType,
printReceived,
stringify,
} from 'jest-matcher-utils';
import prettyFormat, { plugins } from 'pretty-format';
import redent from 'redent';
Expand Down Expand Up @@ -89,3 +91,25 @@ export function formatElement(element: ReactTestInstance | null) {
2
);
}

export function formatMessage(
matcher: string,
expectedLabel: string,
expectedValue: string | RegExp,
receivedLabel: string,
receivedValue: string | null
) {
return [
`${matcher}\n`,
`${expectedLabel}:\n${EXPECTED_COLOR(
redent(formatValue(expectedValue), 2)
)}`,
`${receivedLabel}:\n${RECEIVED_COLOR(
redent(formatValue(receivedValue), 2)
)}`,
].join('\n');
}

function formatValue(value: unknown) {
return typeof value === 'string' ? value : stringify(value);
}
17 changes: 3 additions & 14 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1832,17 +1832,6 @@
dependencies:
"@sinonjs/commons" "^3.0.0"

"@testing-library/jest-native@^5.4.0":
version "5.4.2"
resolved "https://registry.yarnpkg.com/@testing-library/jest-native/-/jest-native-5.4.2.tgz#6b0c987cc57f8d900763e763025d00d26ccbc85f"
integrity sha512-Vo/CE1uvCVH1H8YPoOEXLXVsm+BjzSQTq35+wkri1fr0O5D+A2WZ+m3ni5g6f1OCzNKNGIAHmisBEWkDs1P1mw==
dependencies:
chalk "^4.1.2"
jest-diff "^29.0.1"
jest-matcher-utils "^29.0.1"
pretty-format "^29.0.3"
redent "^3.0.0"

"@types/babel__core@^7.1.14":
version "7.20.1"
resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.20.1.tgz#916ecea274b0c776fec721e333e55762d3a9614b"
Expand Down Expand Up @@ -4654,7 +4643,7 @@ jest-config@^29.6.1:
slash "^3.0.0"
strip-json-comments "^3.1.1"

jest-diff@^29.0.1, jest-diff@^29.6.1:
jest-diff@^29.6.1:
version "29.6.1"
resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-29.6.1.tgz#13df6db0a89ee6ad93c747c75c85c70ba941e545"
integrity sha512-FsNCvinvl8oVxpNLttNQX7FAq7vR+gMDGj90tiP7siWw1UdakWUGqrylpsYrpvj908IYckm5Y0Q7azNAozU1Kg==
Expand Down Expand Up @@ -4741,7 +4730,7 @@ jest-leak-detector@^29.6.1:
jest-get-type "^29.4.3"
pretty-format "^29.6.1"

jest-matcher-utils@^29.0.1, jest-matcher-utils@^29.6.1:
jest-matcher-utils@^29.6.1:
version "29.6.1"
resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-29.6.1.tgz#6c60075d84655d6300c5d5128f46531848160b53"
integrity sha512-SLaztw9d2mfQQKHmJXKM0HCbl2PPVld/t9Xa6P9sgiExijviSp7TnZZpw2Fpt+OI3nwUO/slJbOfzfUMKKC5QA==
Expand Down Expand Up @@ -6290,7 +6279,7 @@ pretty-format@^26.5.2, pretty-format@^26.6.2:
ansi-styles "^4.0.0"
react-is "^17.0.1"

pretty-format@^29.0.0, pretty-format@^29.0.3, pretty-format@^29.6.1:
pretty-format@^29.0.0, pretty-format@^29.6.1:
version "29.6.1"
resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-29.6.1.tgz#ec838c288850b7c4f9090b867c2d4f4edbfb0f3e"
integrity sha512-7jRj+yXO0W7e4/tSJKoR7HRIHLPPjtNaUGG2xxKQnGvPNRkgWcQ0AZX6P4KBRJN4FcTBWb3sa7DVUJmocYuoog==
Expand Down