Skip to content

Commit 29aad25

Browse files
alexkrolickKent C. Dodds
authored and
Kent C. Dodds
committed
fix(typescript): move typings to DefinitelyTyped (#437)
You should not need to make any changes to upgrade to this version. We're just doing this to improve TypeScript maintenance. Co-authored-by: Kent C. Dodds <[email protected]>
1 parent b5584eb commit 29aad25

File tree

3 files changed

+4
-86
lines changed

3 files changed

+4
-86
lines changed

CONTRIBUTING.md

+3-32
Original file line numberDiff line numberDiff line change
@@ -26,45 +26,16 @@ series [How to Contribute to an Open Source Project on GitHub][egghead]
2626
> can make all of your pull request branches based on this `master` branch.
2727
> Whenever you want to update your version of `master`, do a regular `git pull`.
2828
29-
## Add yourself as a contributor
30-
31-
This project follows the [all contributors][all-contributors] specification. To
32-
add yourself to the table of contributors on the `README.md`, please use the
33-
automated script as part of your PR:
34-
35-
```console
36-
npm run add-contributor
37-
```
38-
39-
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. If
40-
you've already added yourself to the list and are making a new type of
41-
contribution, you can run it again and select the added contribution type.
42-
4329
## Committing and Pushing changes
4430
4531
Please make sure to run the tests before you commit your changes. You can run
4632
`npm run test:update` which will update any snapshots that need updating. Make
4733
sure to include those changes (if they exist) in your commit.
4834
49-
### opt into git hooks
50-
51-
There are git hooks set up with this project that are automatically installed
52-
when you install dependencies. They're really handy, but are turned off by
53-
default (so as to not hinder new contributors). You can opt into these by
54-
creating a file called `.opt-in` at the root of the project and putting this
55-
inside:
56-
57-
```
58-
pre-commit
59-
```
60-
61-
### Add typings
35+
### Update Typings
6236
63-
If your PR introduced some changes in the API, you are more than welcome to
64-
modify the Typescript type definition to reflect those changes. Just modify the
65-
`/typings/index.d.ts` file accordingly. If you have never seen Typescript
66-
definitions before, you can read more about it in its
67-
[documentation pages](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)
37+
The TypeScript type definitions are in the
38+
[DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react)
6839
6940
## Help needed
7041

package.json

+1-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"description": "Simple and complete React DOM testing utilities that encourage good testing practices.",
55
"main": "dist/index.js",
66
"module": "dist/@testing-library/react.esm.js",
7-
"typings": "typings/index.d.ts",
87
"engines": {
98
"node": ">=8"
109
},
@@ -23,7 +22,6 @@
2322
},
2423
"files": [
2524
"dist",
26-
"typings",
2725
"cleanup-after-each.js",
2826
"dont-cleanup-after-each.js",
2927
"pure.js"
@@ -45,13 +43,11 @@
4543
"dependencies": {
4644
"@babel/runtime": "^7.5.5",
4745
"@testing-library/dom": "^6.0.0",
48-
"@types/react-dom": "*"
46+
"@types/testing-library__react": "^9.1.0"
4947
},
5048
"devDependencies": {
5149
"@reach/router": "^1.2.1",
5250
"@testing-library/jest-dom": "^4.0.0",
53-
"@types/react": "^16.9.1",
54-
"@types/react-dom": "^16.8.5",
5551
"kcd-scripts": "^1.5.2",
5652
"react": "^16.9.0",
5753
"react-dom": "^16.9.0"

typings/index.d.ts

-49
This file was deleted.

0 commit comments

Comments
 (0)