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
testing-library · May 30, 2019 · d354d88 · d354d88
1 parent af885f8
commit d354d88
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 35 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1,6 +1,6 @@
 {
   "projectName": "cypress-testing-library",
-  "projectOwner": "kentcdodds",
+  "projectOwner": "testing-library",
   "files": [
     "README.md"
   ],

diff --git a/README.md b/README.md
@@ -2,10 +2,16 @@
 <h1>cypress-testing-library</h1>
 
 <a href="https://www.emojione.com/emoji/1f405">
-<img height="80" width="80" alt="tiger" src="https://raw.githubusercontent.com/kentcdodds/cypress-testing-library/master/other/tiger.png" />
+  <img
+    height="80"
+    width="80"
+    alt="tiger"
+    src="https://raw.githubusercontent.com/testing-library/cypress-testing-library/master/other/tiger.png"
+  />
 </a>
 
-<p>Simple and complete custom Cypress commands and utilities that encourage good testing practices.</p>
+<p>Simple and complete custom Cypress commands and utilities that encourage good
+testing practices.</p>
 
 [**Read the docs**](https://testing-library.com/cypress) |
 [Edit the docs](https://github.com/alexkrolick/testing-library-docs)
@@ -27,9 +33,13 @@
 [![Tweet][twitter-badge]][twitter]
 
 <div align="center">
-<a href="https://testingjavascript.com">
-<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" />
-</a>
+  <a href="https://testingjavascript.com">
+    <img
+      width="500"
+      alt="TestingJavaScript.com Learn the smart, efficient way to test any JavaScript application."
+      src="https://raw.githubusercontent.com/testing-library/cypress-testing-library/master/other/testingjavascript.jpg"
+    />
+  </a>
 </div>
 
 ## The problem
@@ -62,18 +72,18 @@ This module is distributed via [npm][npm] which is bundled with [node][node] and
 should be installed as one of your project's `devDependencies`:
 
 ```
-npm install --save-dev cypress-testing-library
+npm install --save-dev @testing-library/cypress
 ```
 
 ### With typescript
 
-Typings are defined under `cypress-testing-library/typings`, and should be added
-as follows in `tsconfig.json`:
+Typings are defined under `@testing-library/cypress/typings`, and should be
+added as follows in `tsconfig.json`:
 
 ```json
 {
   "compilerOptions": {
-    "types": ["cypress", "../cypress-testing-library/typings"]
+    "types": ["cypress", "../@testing-library/cypress/typings"]
   }
 }
 ```
@@ -90,7 +100,7 @@ import 'cypress-testing-library/add-commands';
 
 You can now use all of `dom-testing-library`'s `getBy`, `getAllBy`, `queryBy`
 and `queryAllBy` commands.
-[See `dom-testing-library` repo for reference](https://github.com/kentcdodds/dom-testing-library#usage)
+[See the `dom-testing-library` docs for reference](https://testing-library.com)
 
 To show some simple examples (from
 [cypress/integration/commands.spec.js](cypress/integration/commands.spec.js)):
@@ -125,9 +135,7 @@ Thanks goes to these people ([emoji key][emojis]):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore -->
-| [<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") |
-| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
-| [<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") |
+<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>
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
@@ -141,41 +149,41 @@ MIT
 [npm]: https://www.npmjs.com/
 [node]: https://nodejs.org
 [build-badge]:
-  https://img.shields.io/travis/kentcdodds/cypress-testing-library.svg?style=flat-square
-[build]: https://travis-ci.org/kentcdodds/cypress-testing-library
+  https://img.shields.io/travis/testing-library/cypress-testing-library.svg?style=flat-square
+[build]: https://travis-ci.org/testing-library/cypress-testing-library
 [coverage-badge]:
-  https://img.shields.io/codecov/c/github/kentcdodds/cypress-testing-library.svg?style=flat-square
-[coverage]: https://codecov.io/github/kentcdodds/cypress-testing-library
+  https://img.shields.io/codecov/c/github/testing-library/cypress-testing-library.svg?style=flat-square
+[coverage]: https://codecov.io/github/testing-library/cypress-testing-library
 [version-badge]:
   https://img.shields.io/npm/v/cypress-testing-library.svg?style=flat-square
-[package]: https://www.npmjs.com/package/cypress-testing-library
+[package]: https://www.npmjs.com/package/@testing-library/cypress
 [downloads-badge]:
-  https://img.shields.io/npm/dm/cypress-testing-library.svg?style=flat-square
-[npmtrends]: http://www.npmtrends.com/cypress-testing-library
+  https://img.shields.io/npm/dm/@testing-library/cypress.svg?style=flat-square
+[npmtrends]: http://www.npmtrends.com/@testing-library/cypress
 [license-badge]:
-  https://img.shields.io/npm/l/cypress-testing-library.svg?style=flat-square
+  https://img.shields.io/npm/l/@testing-library/cypress.svg?style=flat-square
 [license]:
-  https://github.com/kentcdodds/cypress-testing-library/blob/master/LICENSE
+  https://github.com/testing-library/cypress-testing-library/blob/master/LICENSE
 [prs-badge]:
   https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
 [prs]: http://makeapullrequest.com
-[donate-badge]:
-  https://img.shields.io/badge/$-support-green.svg?style=flat-square
 [coc-badge]:
   https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
 [coc]:
-  https://github.com/kentcdodds/cypress-testing-library/blob/master/other/CODE_OF_CONDUCT.md
+  https://github.com/testing-library/cypress-testing-library/blob/master/other/CODE_OF_CONDUCT.md
 [github-watch-badge]:
-  https://img.shields.io/github/watchers/kentcdodds/cypress-testing-library.svg?style=social
-[github-watch]: https://github.com/kentcdodds/cypress-testing-library/watchers
+  https://img.shields.io/github/watchers/testing-library/cypress-testing-library.svg?style=social
+[github-watch]:
+  https://github.com/testing-library/cypress-testing-library/watchers
 [github-star-badge]:
-  https://img.shields.io/github/stars/kentcdodds/cypress-testing-library.svg?style=social
-[github-star]: https://github.com/kentcdodds/cypress-testing-library/stargazers
+  https://img.shields.io/github/stars/testing-library/cypress-testing-library.svg?style=social
+[github-star]:
+  https://github.com/testing-library/cypress-testing-library/stargazers
 [twitter]:
   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
 [twitter-badge]:
-  https://img.shields.io/twitter/url/https/github.com/kentcdodds/cypress-testing-library.svg?style=social
+  https://img.shields.io/twitter/url/https/github.com/testing-library/cypress-testing-library.svg?style=social
 [emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
 [all-contributors]: https://github.com/kentcdodds/all-contributors
-[dom-testing-library]: https://github.com/kentcdodds/dom-testing-library
+[dom-testing-library]: https://github.com/testing-library/dom-testing-library
 [cypress]: https://www.cypress.io/
diff --git a/package.json b/package.json
@@ -1,14 +1,13 @@
 {
-  "name": "cypress-testing-library",
+  "name": "@testing-library/cypress",
   "version": "0.0.0-semantically-released",
   "description": "Simple and complete custom Cypress commands and utilities that encourage good testing practices.",
   "main": "dist/index.js",
   "typings": "typings",
   "engines": {
-    "node": "> 6"
+    "node": ">=8"
   },
   "scripts": {
-    "add-contributor": "kcd-scripts contributors add",
     "build": "kcd-scripts build",
     "lint": "kcd-scripts lint",
     "test": "npm-run-all --parallel test:unit test:cypress test:typings",