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.

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

Add a extend-expect to globally require matchers #2962

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/giant-coats-confess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@emotion/jest': minor
---

Add a `@emotion/jest/extend-expect` module to simplify adding matchers
4 changes: 4 additions & 0 deletions packages/jest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,10 @@ test('renders with correct link styles', () => {
})
```

### Include custom matchers globally

You can add the custom matchers globally by adding a `import '@emotion/jest/extend-expect` to a setupFilesAfterEnv script.

## Thanks

Thanks to [Kent C. Dodds](https://twitter.com/kentcdodds) who wrote [jest-glamor-react](https://github.com/kentcdodds/jest-glamor-react) which this library is largely based on. ❤️
Expand Down
5 changes: 5 additions & 0 deletions packages/jest/extend-expect/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"main": "dist/emotion-jest-extend-expect.cjs.js",
"module": "dist/emotion-jest-extend-expect.esm.js",
"types": "../types/index.d.ts"
}
10 changes: 8 additions & 2 deletions packages/jest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
"module": "./serializer/dist/emotion-jest-serializer.esm.js",
"default": "./serializer/dist/emotion-jest-serializer.cjs.js"
},
"./extend-expect": {
"module": "./extend-expect/dist/emotion-jest-extend-expect.esm.js",
"default": "./extend-expect/dist/emotion-jest-extend-expect.cjs.js"
},
"./enzyme-serializer": {
"module": "./enzyme-serializer/dist/emotion-jest-enzyme-serializer.esm.js",
"default": "./enzyme-serializer/dist/emotion-jest-enzyme-serializer.cjs.js"
Expand All @@ -30,7 +34,8 @@
"types/*.d.ts",
"serializer",
"enzyme",
"enzyme-serializer"
"enzyme-serializer",
"extend-expect"
],
"scripts": {
"test:typescript": "dtslint types"
Expand Down Expand Up @@ -86,7 +91,8 @@
"./index.js",
"./serializer.js",
"./enzyme.js",
"./enzyme-serializer.js"
"./enzyme-serializer.js",
"./extend-expect.js"
]
}
}
1 change: 1 addition & 0 deletions packages/jest/src/extend-expect.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import '../types'
4 changes: 4 additions & 0 deletions packages/jest/src/extend-expect.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { matchers } from './matchers'

// eslint-disable-next-line no-undef
expect.extend(matchers)