Skip to content

Commit 42942b7

Browse files
author
Kent C. Dodds
committed
WIP: init
0 parents  commit 42942b7

19 files changed

+647
-0
lines changed

‎.all-contributorsrc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"projectName": "cypress-testing-library",
3+
"projectOwner": "kentcdodds",
4+
"files": [
5+
"README.md"
6+
],
7+
"imageSize": 100,
8+
"commit": false,
9+
"contributors": [
10+
{
11+
"login": "kentcdodds",
12+
"name": "Kent C. Dodds",
13+
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3",
14+
"profile": "https://kentcdodds.com",
15+
"contributions": [
16+
"code",
17+
"doc",
18+
"infra",
19+
"test"
20+
]
21+
}
22+
]
23+
}

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* text=auto
2+
*.js text eol=lf

‎.github/ISSUE_TEMPLATE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
HI! PLEASE STOP TO READ THIS!! If you're issue is regarding one of the query
3+
APIs (`getByText`, `getByLabelText`, etc), then please file it on the
4+
https://github.com/kentcdodds/dom-testing-library repository instead. If you
5+
file it here it will be closed. Thanks :)
6+
7+
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
8+
Please make sure that you are familiar with and follow the Code of Conduct for
9+
this project (found in the CODE_OF_CONDUCT.md file).
10+
11+
Please fill out this template with all the relevant information so we can
12+
understand what's going on and fix the issue.
13+
14+
I'll probably ask you to submit the fix (after giving some direction). If you've
15+
never done that before, that's great! Check this free short video tutorial to
16+
learn how: http://kcd.im/pull-request
17+
-->
18+
19+
* `cypress-testing-library` version:
20+
* `node` version:
21+
* `npm` (or `yarn`) version:
22+
23+
Relevant code or config
24+
25+
```javascript
26+
```
27+
28+
What you did:
29+
30+
What happened:
31+
32+
<!-- Please provide the full error message/screenshots/anything -->
33+
34+
Reproduction repository:
35+
36+
<!--
37+
If possible, please create a repository that reproduces the issue with the
38+
minimal amount of code possible.
39+
-->
40+
41+
Problem description:
42+
43+
Suggested solution:

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--
2+
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
3+
4+
Please make sure that you are familiar with and follow the Code of Conduct for
5+
this project (found in the CODE_OF_CONDUCT.md file).
6+
7+
Also, please make sure you're familiar with and follow the instructions in the
8+
contributing guidelines (found in the CONTRIBUTING.md file).
9+
10+
If you're new to contributing to open source projects, you might find this free
11+
video course helpful: http://kcd.im/pull-request
12+
13+
Please fill out the information below to expedite the review and (hopefully)
14+
merge of your pull request!
15+
-->
16+
17+
<!-- What changes are being made? (What feature/bug is being fixed here?) -->
18+
19+
**What**:
20+
21+
<!-- Why are these changes necessary? -->
22+
23+
**Why**:
24+
25+
<!-- How were these changes implemented? -->
26+
27+
**How**:
28+
29+
<!-- Have you done all of these things? -->
30+
31+
**Checklist**:
32+
33+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
34+
35+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
36+
37+
* [ ] Documentation
38+
* [ ] Tests
39+
* [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
40+
* [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
41+
42+
<!-- feel free to add additional comments -->

‎.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
node_modules
2+
coverage
3+
dist
4+
.opt-in
5+
.opt-out
6+
.DS_Store
7+
.eslintcache
8+
9+
# these cause more harm than good
10+
# when working with contributors
11+
package-lock.json
12+
yarn.lock

‎.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
registry=http://registry.npmjs.org/
2+
package-lock=false

‎.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
package.json
2+
node_modules
3+
dist
4+
coverage

‎.prettierrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"semi": false,
6+
"singleQuote": true,
7+
"trailingComma": "all",
8+
"bracketSpacing": false,
9+
"jsxBracketSameLine": false
10+
}

‎.travis.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
sudo: false
2+
language: node_js
3+
cache:
4+
directories:
5+
- ~/.npm
6+
notifications:
7+
email: false
8+
node_js: '8'
9+
install: npm install
10+
script: npm run validate
11+
after_success: kcd-scripts travis-after-success
12+
branches:
13+
only: master

‎CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CHANGELOG
2+
3+
The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release).
4+
You can see it on the [releases page](../../releases).

‎CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute!
4+
5+
**Working on your first Pull Request?** You can learn how from this _free_ series
6+
[How to Contribute to an Open Source Project on GitHub][egghead]
7+
8+
## Project setup
9+
10+
1. Fork and clone the repo
11+
2. Run `npm run setup -s` to install dependencies and run validation
12+
3. Create a branch for your PR with `git checkout -b pr/your-branch-name`
13+
14+
> Tip: Keep your `master` branch pointing at the original repository and make
15+
> pull requests from branches on your fork. To do this, run:
16+
>
17+
> ```
18+
> git remote add upstream https://github.com/kentcdodds/cypress-testing-library.git
19+
> git fetch upstream
20+
> git branch --set-upstream-to=upstream/master master
21+
> ```
22+
>
23+
> This will add the original repository as a "remote" called "upstream,"
24+
> Then fetch the git information from that remote, then set your local `master`
25+
> branch to use the upstream master branch whenever you run `git pull`.
26+
> Then you can make all of your pull request branches based on this `master`
27+
> branch. Whenever you want to update your version of `master`, do a regular
28+
> `git pull`.
29+
30+
## Add yourself as a contributor
31+
32+
This project follows the [all contributors][all-contributors] specification.
33+
To add yourself to the table of contributors on the `README.md`, please use the
34+
automated script as part of your PR:
35+
36+
```console
37+
npm run add-contributor
38+
```
39+
40+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
41+
If you've already added yourself to the list and are making
42+
a new type of contribution, you can run it again and select the added
43+
contribution type.
44+
45+
## Committing and Pushing changes
46+
47+
Please make sure to run the tests before you commit your changes. You can run
48+
`npm run test:update` which will update any snapshots that need updating.
49+
Make sure to include those changes (if they exist) in your commit.
50+
51+
### opt into git hooks
52+
53+
There are git hooks set up with this project that are automatically installed
54+
when you install dependencies. They're really handy, but are turned off by
55+
default (so as to not hinder new contributors). You can opt into these by
56+
creating a file called `.opt-in` at the root of the project and putting this
57+
inside:
58+
59+
```
60+
pre-commit
61+
```
62+
63+
## Help needed
64+
65+
Please checkout the [the open issues][issues]
66+
67+
Also, please watch the repo and respond to questions/bug reports/feature
68+
requests! Thanks!
69+
70+
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
71+
[all-contributors]: https://github.com/kentcdodds/all-contributors
72+
[issues]: https://github.com/kentcdodds/cypress-testing-library/issues

‎LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2017 Kent C. Dodds
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.

‎README.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<div align="center">
2+
<h1>cypress-testing-library</h1>
3+
4+
<p>Simple and complete custom Cypress commands and utilities that encourage good testing practices.</p>
5+
</div>
6+
7+
<hr />
8+
9+
[![Build Status][build-badge]][build]
10+
[![Code Coverage][coverage-badge]][coverage]
11+
[![version][version-badge]][package]
12+
[![downloads][downloads-badge]][npmtrends]
13+
[![MIT License][license-badge]][license]
14+
15+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
16+
[![PRs Welcome][prs-badge]][prs]
17+
[![Code of Conduct][coc-badge]][coc]
18+
19+
[![Watch on GitHub][github-watch-badge]][github-watch]
20+
[![Star on GitHub][github-star-badge]][github-star]
21+
[![Tweet][twitter-badge]][twitter]
22+
23+
<a href="https://app.codesponsor.io/link/PKGFLnhDiFvsUA5P4kAXfiPs/kentcdodds/cypress-testing-library" rel="nofollow"><img src="https://app.codesponsor.io/embed/PKGFLnhDiFvsUA5P4kAXfiPs/kentcdodds/cypress-testing-library.svg" style="width: 888px; height: 68px;" alt="Sponsor" /></a>
24+
25+
## The problem
26+
27+
// TODO
28+
29+
## This solution
30+
31+
// TODO
32+
33+
## Table of Contents
34+
35+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
36+
37+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
38+
39+
* [Installation](#installation)
40+
* [Usage](#usage)
41+
* [Inspiration](#inspiration)
42+
* [Other Solutions](#other-solutions)
43+
* [Contributors](#contributors)
44+
* [LICENSE](#license)
45+
46+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
47+
48+
## Installation
49+
50+
This module is distributed via [npm][npm] which is bundled with [node][node] and
51+
should be installed as one of your project's `devDependencies`:
52+
53+
```
54+
npm install --save-dev cypress-testing-library
55+
```
56+
57+
## Usage
58+
59+
// TODO
60+
61+
## Inspiration
62+
63+
// TODO
64+
65+
## Other Solutions
66+
67+
I'm not aware of any, if you are please [make a pull request][prs] and add it
68+
here!
69+
70+
## Contributors
71+
72+
Thanks goes to these people ([emoji key][emojis]):
73+
74+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
75+
76+
<!-- prettier-ignore -->
77+
| [<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") |
78+
| :---: |
79+
80+
<!-- ALL-CONTRIBUTORS-LIST:END -->
81+
82+
This project follows the [all-contributors][all-contributors] specification.
83+
Contributions of any kind welcome!
84+
85+
## LICENSE
86+
87+
MIT
88+
89+
[npm]: https://www.npmjs.com/
90+
[node]: https://nodejs.org
91+
[build-badge]: https://img.shields.io/travis/kentcdodds/cypress-testing-library.svg?style=flat-square
92+
[build]: https://travis-ci.org/kentcdodds/cypress-testing-library
93+
[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/cypress-testing-library.svg?style=flat-square
94+
[coverage]: https://codecov.io/github/kentcdodds/cypress-testing-library
95+
[version-badge]: https://img.shields.io/npm/v/cypress-testing-library.svg?style=flat-square
96+
[package]: https://www.npmjs.com/package/cypress-testing-library
97+
[downloads-badge]: https://img.shields.io/npm/dm/cypress-testing-library.svg?style=flat-square
98+
[npmtrends]: http://www.npmtrends.com/cypress-testing-library
99+
[license-badge]: https://img.shields.io/npm/l/cypress-testing-library.svg?style=flat-square
100+
[license]: https://github.com/kentcdodds/cypress-testing-library/blob/master/LICENSE
101+
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
102+
[prs]: http://makeapullrequest.com
103+
[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square
104+
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
105+
[coc]: https://github.com/kentcdodds/cypress-testing-library/blob/master/other/CODE_OF_CONDUCT.md
106+
[github-watch-badge]: https://img.shields.io/github/watchers/kentcdodds/cypress-testing-library.svg?style=social
107+
[github-watch]: https://github.com/kentcdodds/cypress-testing-library/watchers
108+
[github-star-badge]: https://img.shields.io/github/stars/kentcdodds/cypress-testing-library.svg?style=social
109+
[github-star]: https://github.com/kentcdodds/cypress-testing-library/stargazers
110+
[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
111+
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kentcdodds/cypress-testing-library.svg?style=social
112+
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
113+
[all-contributors]: https://github.com/kentcdodds/all-contributors

0 commit comments

Comments
 (0)