Commit a4744fa

eps1lonMatanBobi

and

authored

feat: Move @testing-library/dom and @types/react-dom to peer dependencies (#1305)

BREAKING CHANGE: `@testing-library/dom` was moved to a peer dependency and needs to be explicitly installed. This reduces the chance of having conflicting versions of `@testing-library/dom` installed that frequently caused bugs when used with `@testing-library/user-event`. We will also be able to allow new versions of `@testing-library/dom` being used without a SemVer major release of `@testing-library/react` by just widening the peer dependency. `@types/react-dom` needs to be installed if you're typechecking files using `@testing-library/react`. Co-authored-by: Matan Borenkraout <matanbobi@gmail.com>

1 parent c1f2957 commit a4744faCopy full SHA for a4744fa

File tree

2 files changed

+15

-7

lines changed

README.md
package.json

2 files changed

+15

-7

lines changed

`‎README.md‎`

Lines changed: 7 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -97,21 +97,24 @@ primary guiding principle is:`
`97`	`97`	`## Installation`
`98`	`98`
`99`	`99`	`This module is distributed via [npm][npm] which is bundled with [node][node] and`
`100`		-should be installed as one of your project's `devDependencies`:
	`100`	+should be installed as one of your project's `devDependencies`.
	`101`	`+Starting from RTL version 16, you'll also need to install`
	`102`	+`@testing-library/dom`:
`101`	`103`
`102`	`104`	```
`103`		`-npm install --save-dev @testing-library/react`
	`105`	`+npm install --save-dev @testing-library/react @testing-library/dom`
`104`	`106`	```
`105`	`107`
`106`	`108`	`or`
`107`	`109`
`108`	`110`	`for installation via [yarn][yarn]`
`109`	`111`
`110`	`112`	```
`111`		`-yarn add --dev @testing-library/react`
	`113`	`+yarn add --dev @testing-library/react @testing-library/dom`
`112`	`114`	```
`113`	`115`
`114`		-This library has `peerDependencies` listings for `react` and `react-dom`.
	`116`	+This library has `peerDependencies` listings for `react`, `react-dom` and
	`117`	+starting from RTL version 16 also `@testing-library/dom`.
`115`	`118`
`116`	`119`	`_React Testing Library versions 13+ require React v18. If your project uses an`
`117`	`120`	`older version of React, be sure to install version 12:_`

`‎package.json‎`

Lines changed: 8 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -45,13 +45,13 @@`
`45`	`45`	`"author": "Kent C. Dodds <me@kentcdodds.com> (https://kentcdodds.com)",`
`46`	`46`	`"license": "MIT",`
`47`	`47`	`"dependencies": {`
`48`		`- "@babel/runtime": "^7.12.5",`
`49`		`- "@testing-library/dom": "^10.0.0",`
`50`		`- "@types/react-dom": "^18.0.0"`
	`48`	`+ "@babel/runtime": "^7.12.5"`
`51`	`49`	`},`
`52`	`50`	`"devDependencies": {`
	`51`	`+ "@testing-library/dom": "^10.0.0",`
`53`	`52`	`"@testing-library/jest-dom": "^5.11.6",`
`54`	`53`	`"@types/react": "^18.3.1",`
	`54`	`+ "@types/react-dom": "^18.3.0",`
`55`	`55`	`"chalk": "^4.1.2",`
`56`	`56`	`"dotenv-cli": "^4.0.0",`
`57`	`57`	`"jest-diff": "^29.7.0",`
`@@ -63,13 +63,18 @@`
`63`	`63`	`"typescript": "^4.1.2"`
`64`	`64`	`},`
`65`	`65`	`"peerDependencies": {`
	`66`	`+ "@testing-library/dom": "^10.0.0",`
`66`	`67`	`"@types/react": "^18.0.0",`
	`68`	`+ "@types/react-dom": "^18.0.0",`
`67`	`69`	`"react": "^18.0.0",`
`68`	`70`	`"react-dom": "^18.0.0"`
`69`	`71`	`},`
`70`	`72`	`"peerDependenciesMeta": {`
`71`	`73`	`"@types/react": {`
`72`	`74`	`"optional": true`
	`75`	`+ },`
	`76`	`+ "@types/react-dom": {`
	`77`	`+ "optional": true`
`73`	`78`	`}`
`74`	`79`	`},`
`75`	`80`	`"eslintConfig": {`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit a4744fa

File tree

2 files changed

2 files changed

`‎README.md‎`

`‎package.json‎`

0 commit comments