Skip to content

Commit d354d88

Browse files
author
Kent C. Dodds
committed
feat: initial release of scoped package
Reference: testing-library/dom-testing-library#260 BREAKING CHANGE: You need to change your imports from cypress-testing-library to @testing-library/cypress
1 parent af885f8 commit d354d88

File tree

3 files changed

+42
-35
lines changed

3 files changed

+42
-35
lines changed

.all-contributorsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"projectName": "cypress-testing-library",
3-
"projectOwner": "kentcdodds",
3+
"projectOwner": "testing-library",
44
"files": [
55
"README.md"
66
],

README.md

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22
<h1>cypress-testing-library</h1>
33

44
<a href="https://www.emojione.com/emoji/1f405">
5-
<img height="80" width="80" alt="tiger" src="https://raw.githubusercontent.com/kentcdodds/cypress-testing-library/master/other/tiger.png" />
5+
<img
6+
height="80"
7+
width="80"
8+
alt="tiger"
9+
src="https://raw.githubusercontent.com/testing-library/cypress-testing-library/master/other/tiger.png"
10+
/>
611
</a>
712

8-
<p>Simple and complete custom Cypress commands and utilities that encourage good testing practices.</p>
13+
<p>Simple and complete custom Cypress commands and utilities that encourage good
14+
testing practices.</p>
915

1016
[**Read the docs**](https://testing-library.com/cypress) |
1117
[Edit the docs](https://github.com/alexkrolick/testing-library-docs)
@@ -27,9 +33,13 @@
2733
[![Tweet][twitter-badge]][twitter]
2834

2935
<div align="center">
30-
<a href="https://testingjavascript.com">
31-
<img width="500" alt="TestingJavaScript.com Learn the smart, efficient way to test any JavaScript application." src="https://raw.githubusercontent.com/kentcdodds/cypress-testing-library/master/other/testingjavascript.jpg" />
32-
</a>
36+
<a href="https://testingjavascript.com">
37+
<img
38+
width="500"
39+
alt="TestingJavaScript.com Learn the smart, efficient way to test any JavaScript application."
40+
src="https://raw.githubusercontent.com/testing-library/cypress-testing-library/master/other/testingjavascript.jpg"
41+
/>
42+
</a>
3343
</div>
3444

3545
## The problem
@@ -62,18 +72,18 @@ This module is distributed via [npm][npm] which is bundled with [node][node] and
6272
should be installed as one of your project's `devDependencies`:
6373

6474
```
65-
npm install --save-dev cypress-testing-library
75+
npm install --save-dev @testing-library/cypress
6676
```
6777

6878
### With typescript
6979

70-
Typings are defined under `cypress-testing-library/typings`, and should be added
71-
as follows in `tsconfig.json`:
80+
Typings are defined under `@testing-library/cypress/typings`, and should be
81+
added as follows in `tsconfig.json`:
7282

7383
```json
7484
{
7585
"compilerOptions": {
76-
"types": ["cypress", "../cypress-testing-library/typings"]
86+
"types": ["cypress", "../@testing-library/cypress/typings"]
7787
}
7888
}
7989
```
@@ -90,7 +100,7 @@ import 'cypress-testing-library/add-commands';
90100

91101
You can now use all of `dom-testing-library`'s `getBy`, `getAllBy`, `queryBy`
92102
and `queryAllBy` commands.
93-
[See `dom-testing-library` repo for reference](https://github.com/kentcdodds/dom-testing-library#usage)
103+
[See the `dom-testing-library` docs for reference](https://testing-library.com)
94104

95105
To show some simple examples (from
96106
[cypress/integration/commands.spec.js](cypress/integration/commands.spec.js)):
@@ -125,9 +135,7 @@ Thanks goes to these people ([emoji key][emojis]):
125135

126136
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
127137
<!-- prettier-ignore -->
128-
| [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub><b>Kent C. Dodds</b></sub>](https://kentcdodds.com)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=kentcdodds "Code") [📖](https://github.com/kentcdodds/cypress-testing-library/commits?author=kentcdodds "Documentation") [🚇](#infra-kentcdodds "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=kentcdodds "Tests") | [<img src="https://avatars2.githubusercontent.com/u/498274?v=4" width="100px;"/><br /><sub><b>Ivan Babak</b></sub>](https://sompylasar.github.io)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=sompylasar "Code") [🤔](#ideas-sompylasar "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/4002543?v=4" width="100px;"/><br /><sub><b>Łukasz Gandecki</b></sub>](http://team.thebrain.pro)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=lgandecki "Code") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=lgandecki "Tests") | [<img src="https://avatars1.githubusercontent.com/u/25429764?v=4" width="100px;"/><br /><sub><b>Peter Kamps</b></sub>](https://github.com/npeterkamps)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=npeterkamps "Code") [📖](https://github.com/kentcdodds/cypress-testing-library/commits?author=npeterkamps "Documentation") [🤔](#ideas-npeterkamps "Ideas, Planning, & Feedback") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=npeterkamps "Tests") | [<img src="https://avatars3.githubusercontent.com/u/4506749?v=4" width="100px;"/><br /><sub><b>Airat Aminev</b></sub>](https://github.com/airato)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=airato "Code") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=airato "Tests") [🔧](#tool-airato "Tools") | [<img src="https://avatars0.githubusercontent.com/u/5121148?v=4" width="100px;"/><br /><sub><b>Adrian Smijulj</b></sub>](https://www.webiny.com)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=adrian1358 "Code") | [<img src="https://avatars0.githubusercontent.com/u/12230408?v=4" width="100px;"/><br /><sub><b>Soo Jae Hwang</b></sub>](https://www.ossfinder.com)<br />[🐛](https://github.com/kentcdodds/cypress-testing-library/issues?q=author%3Amisoguy "Bug reports") [💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=misoguy "Code") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=misoguy "Tests") |
129-
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
130-
| [<img src="https://avatars1.githubusercontent.com/u/1288694?v=4" width="100px;"/><br /><sub><b>Justin Hall</b></sub>](https://github.com/wKovacs64)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=wKovacs64 "Code") [⚠️](https://github.com/kentcdodds/cypress-testing-library/commits?author=wKovacs64 "Tests") | [<img src="https://avatars3.githubusercontent.com/u/9463809?v=4" width="100px;"/><br /><sub><b>euzebe</b></sub>](https://github.com/euZebe)<br />[📖](https://github.com/kentcdodds/cypress-testing-library/commits?author=euZebe "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/19804196?v=4" width="100px;"/><br /><sub><b>jkdowdle</b></sub>](https://github.com/jkdowdle)<br />[💻](https://github.com/kentcdodds/cypress-testing-library/commits?author=jkdowdle "Code") |
138+
<table><tr><td align="center"><a href="https://kentcdodds.com"><img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;" alt="Kent C. Dodds"/><br /><sub><b>Kent C. Dodds</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=kentcdodds" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=kentcdodds" title="Documentation">📖</a> <a href="#infra-kentcdodds" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=kentcdodds" title="Tests">⚠️</a></td><td align="center"><a href="https://sompylasar.github.io"><img src="https://avatars2.githubusercontent.com/u/498274?v=4" width="100px;" alt="Ivan Babak"/><br /><sub><b>Ivan Babak</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=sompylasar" title="Code">💻</a> <a href="#ideas-sompylasar" title="Ideas, Planning, & Feedback">🤔</a></td><td align="center"><a href="http://team.thebrain.pro"><img src="https://avatars1.githubusercontent.com/u/4002543?v=4" width="100px;" alt="Łukasz Gandecki"/><br /><sub><b>Łukasz Gandecki</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=lgandecki" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=lgandecki" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/npeterkamps"><img src="https://avatars1.githubusercontent.com/u/25429764?v=4" width="100px;" alt="Peter Kamps"/><br /><sub><b>Peter Kamps</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=npeterkamps" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=npeterkamps" title="Documentation">📖</a> <a href="#ideas-npeterkamps" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=npeterkamps" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/airato"><img src="https://avatars3.githubusercontent.com/u/4506749?v=4" width="100px;" alt="Airat Aminev"/><br /><sub><b>Airat Aminev</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=airato" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=airato" title="Tests">⚠️</a> <a href="#tool-airato" title="Tools">🔧</a></td><td align="center"><a href="https://www.webiny.com"><img src="https://avatars0.githubusercontent.com/u/5121148?v=4" width="100px;" alt="Adrian Smijulj"/><br /><sub><b>Adrian Smijulj</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=adrian1358" title="Code">💻</a></td><td align="center"><a href="https://www.ossfinder.com"><img src="https://avatars0.githubusercontent.com/u/12230408?v=4" width="100px;" alt="Soo Jae Hwang"/><br /><sub><b>Soo Jae Hwang</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/issues?q=author%3Amisoguy" title="Bug reports">🐛</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=misoguy" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=misoguy" title="Tests">⚠️</a></td></tr><tr><td align="center"><a href="https://github.com/wKovacs64"><img src="https://avatars1.githubusercontent.com/u/1288694?v=4" width="100px;" alt="Justin Hall"/><br /><sub><b>Justin Hall</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=wKovacs64" title="Code">💻</a> <a href="https://github.com/testing-library/cypress-testing-library/commits?author=wKovacs64" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/euZebe"><img src="https://avatars3.githubusercontent.com/u/9463809?v=4" width="100px;" alt="euzebe"/><br /><sub><b>euzebe</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=euZebe" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/jkdowdle"><img src="https://avatars0.githubusercontent.com/u/19804196?v=4" width="100px;" alt="jkdowdle"/><br /><sub><b>jkdowdle</b></sub></a><br /><a href="https://github.com/testing-library/cypress-testing-library/commits?author=jkdowdle" title="Code">💻</a></td></tr></table>
131139

132140
<!-- ALL-CONTRIBUTORS-LIST:END -->
133141

@@ -141,41 +149,41 @@ MIT
141149
[npm]: https://www.npmjs.com/
142150
[node]: https://nodejs.org
143151
[build-badge]:
144-
https://img.shields.io/travis/kentcdodds/cypress-testing-library.svg?style=flat-square
145-
[build]: https://travis-ci.org/kentcdodds/cypress-testing-library
152+
https://img.shields.io/travis/testing-library/cypress-testing-library.svg?style=flat-square
153+
[build]: https://travis-ci.org/testing-library/cypress-testing-library
146154
[coverage-badge]:
147-
https://img.shields.io/codecov/c/github/kentcdodds/cypress-testing-library.svg?style=flat-square
148-
[coverage]: https://codecov.io/github/kentcdodds/cypress-testing-library
155+
https://img.shields.io/codecov/c/github/testing-library/cypress-testing-library.svg?style=flat-square
156+
[coverage]: https://codecov.io/github/testing-library/cypress-testing-library
149157
[version-badge]:
150158
https://img.shields.io/npm/v/cypress-testing-library.svg?style=flat-square
151-
[package]: https://www.npmjs.com/package/cypress-testing-library
159+
[package]: https://www.npmjs.com/package/@testing-library/cypress
152160
[downloads-badge]:
153-
https://img.shields.io/npm/dm/cypress-testing-library.svg?style=flat-square
154-
[npmtrends]: http://www.npmtrends.com/cypress-testing-library
161+
https://img.shields.io/npm/dm/@testing-library/cypress.svg?style=flat-square
162+
[npmtrends]: http://www.npmtrends.com/@testing-library/cypress
155163
[license-badge]:
156-
https://img.shields.io/npm/l/cypress-testing-library.svg?style=flat-square
164+
https://img.shields.io/npm/l/@testing-library/cypress.svg?style=flat-square
157165
[license]:
158-
https://github.com/kentcdodds/cypress-testing-library/blob/master/LICENSE
166+
https://github.com/testing-library/cypress-testing-library/blob/master/LICENSE
159167
[prs-badge]:
160168
https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
161169
[prs]: http://makeapullrequest.com
162-
[donate-badge]:
163-
https://img.shields.io/badge/$-support-green.svg?style=flat-square
164170
[coc-badge]:
165171
https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
166172
[coc]:
167-
https://github.com/kentcdodds/cypress-testing-library/blob/master/other/CODE_OF_CONDUCT.md
173+
https://github.com/testing-library/cypress-testing-library/blob/master/other/CODE_OF_CONDUCT.md
168174
[github-watch-badge]:
169-
https://img.shields.io/github/watchers/kentcdodds/cypress-testing-library.svg?style=social
170-
[github-watch]: https://github.com/kentcdodds/cypress-testing-library/watchers
175+
https://img.shields.io/github/watchers/testing-library/cypress-testing-library.svg?style=social
176+
[github-watch]:
177+
https://github.com/testing-library/cypress-testing-library/watchers
171178
[github-star-badge]:
172-
https://img.shields.io/github/stars/kentcdodds/cypress-testing-library.svg?style=social
173-
[github-star]: https://github.com/kentcdodds/cypress-testing-library/stargazers
179+
https://img.shields.io/github/stars/testing-library/cypress-testing-library.svg?style=social
180+
[github-star]:
181+
https://github.com/testing-library/cypress-testing-library/stargazers
174182
[twitter]:
175183
https://twitter.com/intent/tweet?text=Check%20out%20cypress-testing-library%20by%20%40kentcdodds%20https%3A%2F%2Fgithub.com%2Fkentcdodds%2Fcypress-testing-library%20%F0%9F%91%8D
176184
[twitter-badge]:
177-
https://img.shields.io/twitter/url/https/github.com/kentcdodds/cypress-testing-library.svg?style=social
185+
https://img.shields.io/twitter/url/https/github.com/testing-library/cypress-testing-library.svg?style=social
178186
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
179187
[all-contributors]: https://github.com/kentcdodds/all-contributors
180-
[dom-testing-library]: https://github.com/kentcdodds/dom-testing-library
188+
[dom-testing-library]: https://github.com/testing-library/dom-testing-library
181189
[cypress]: https://www.cypress.io/

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
{
2-
"name": "cypress-testing-library",
2+
"name": "@testing-library/cypress",
33
"version": "0.0.0-semantically-released",
44
"description": "Simple and complete custom Cypress commands and utilities that encourage good testing practices.",
55
"main": "dist/index.js",
66
"typings": "typings",
77
"engines": {
8-
"node": "> 6"
8+
"node": ">=8"
99
},
1010
"scripts": {
11-
"add-contributor": "kcd-scripts contributors add",
1211
"build": "kcd-scripts build",
1312
"lint": "kcd-scripts lint",
1413
"test": "npm-run-all --parallel test:unit test:cypress test:typings",

0 commit comments

Comments
 (0)