Merge pull request #42 from storybookjs/jest-dom

Update @testing-library/jest-dom to v6

README.md

@@ -2,46 +2,4 @@
 
 Storybook integration for Jest, instrumented for use with the [Interactions addon](https://github.com/storybookjs/storybook/blob/next/code/addons/interactions/README.md).
 
-## FAQ
-
-### Typescript does not recognize expect().toBeInTheDocument()
-
-This is likely an issue with newer package managers.
-
-The `@storybook/jest` package provides some type augmentations so that `expect` has extended matchers coming from Testing Library. The way it works, is that `@storybook/jest` depends on `@testing-library/jest-dom`, a package that depends on `@types/testing-library__jest-dom`. That @types package should be hoisted in your project in order for your types to fully work. As a result, you should have a `node_modules/@types/testing-library__jest-dom` directory. If you don't, then the types won't exist and that's why you're having issues.
-
-For instance, if you have a yarn project, hoisting happens automatically. However if you're using **pnpm**, `@types` are not hoisted automatically, you will have to add a `.npmrc` file with the following setting:
-
-```js
-// .npmrc
-public-hoist-pattern[]=@types*
-```
-
-Otherwise, installing `@types/testing-library__jest-dom` as a direct dependency should have the same effect and fix your issue.
-
-If you are still experiencing issues after making these changes, it's very likely that your `tsconfig.json` file contains specific type overrides, which means that it will ignore automatic types, for instance:
-
-```json
-{
-  "compilerOptions": {
-    "types": [
-      "node",
-      "mocha",
-    ]
-  }
-}
-```
-
-In that case, make sure to add `testing-library__jest-dom` to the `types` array:
-
-```json
-{
-  "compilerOptions": {
-    "types": [
-      "node",
-      "mocha",
-      "testing-library__jest-dom"
-    ]
-  }
-}
-```
+[jest-dom](https://github.com/testing-library/jest-dom) matchers are automatically included as well.

package.json

@@ -14,14 +14,22 @@
   "files": [
     "dist/**/*"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "tsup",
     "release": "yarn build && auto shipit"
   },
   "sideEffects": false,
   "dependencies": {
     "@storybook/expect": "storybook-jest",
-    "@testing-library/jest-dom": "^5.16.2",
+    "@testing-library/jest-dom": "^6.1.2",
     "@types/jest": "28.1.3",
     "jest-mock": "^27.3.0"
   },

src/index.ts

@@ -27,17 +27,6 @@ const expect = instrument(
   { intercept: (_method, path) => path[0] !== 'expect' }
 ).expect as unknown as Expect;
 
-// @TODO: This should be reverted once https://github.com/testing-library/jest-dom/pull/438 is merged
-// Some bundlers include an undefined `default` in the namespace import,
-// or __esmodule (a boolean) which cause expect.extend to throw.
-const validMatchers = { ...matchers };
-Object.keys(validMatchers).forEach((matcherName) => {
-  const matcher = validMatchers[matcherName];
-  if (typeof matcher === 'undefined' || typeof matcher === 'boolean') {
-    delete validMatchers[matcherName];
-  }
-});
-
-expect.extend(validMatchers);
+expect.extend(matchers);
 
 export { expect, jest };

tsup.config.ts

@@ -17,6 +17,6 @@ export default defineConfig({
   dts: {
     entry: ['./src/index.ts'],
     resolve: true,
-    banner: '/// <reference types="jest" />',
+    banner: '/// <reference types="jest" />\n/// <reference types="@testing-library/jest-dom" />',
   },
 });