Copied types from DefinitelyTyped into this repository #530

Lagily · 2020-04-22T11:40:50Z

What: Copied types from DefinitelyTyped into this repository and adjusted the package.json, so these types are packed into the npm package. Also removed the dependency to the DefinitelyTyped types, since they are now in this repo.

Why: See #494 (comment)

Checklist:

[?] Documentation added to the
docs site
[N/A] I've prepared a PR for types targeting
DefinitelyTyped
Tests
Ready to be merged

Not sure as to where and how you would like documentation to be added. I don't think additional documentation is needed (yet). We should instead make a PR to remove dom-testing-library from DefinitelyTyped - what do you think?

…ency

codesandbox-ci · 2020-04-22T11:41:54Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 430236e:

Sandbox	Source
festive-bash-udo11	Configuration

codecov · 2020-04-22T11:46:02Z

Codecov Report

Merging #530 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #530   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines          438       438           
  Branches       105       105           
=========================================
  Hits           438       438

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d62141...430236e. Read the comment docs.

kentcdodds

Awesome, thank you for this!

Is there any way we can add something to the validate script that will check these typings are correct? I've had some projects where they'll have a set of TypeScript files in the project and run the typings against those files to make sure they pass type checking.

eps1lon · 2020-04-22T23:17:52Z

@kentcdodds Would you be open to adding type annotations via JSDOC?

We could generate the declarations directly from the source files while simultaneously checking that the types are correct (and actually type check the source files).

That way we keep any TypeScript syntax out and the current workflow doesn't change.

At least I think this is possible. The typings are simple enough that JSDOC should be sufficient.

kentcdodds · 2020-04-22T23:22:31Z

I think that would be a good iterative approach to migrating to TypeScript (if that's what we end up doing). I'd be willing to take a look at that, yeah.

Lagily · 2020-04-23T09:24:39Z

Sure, I think DefinitelyTyped also runs some sort of tests on their types, I'll investigate and add something

Lagily · 2020-04-23T19:31:00Z

I've added the type tests like DefinitelyTyped does it, I commited in a way that you can see the tests fail, before adjustments are made. If you change the type-tests.ts in a way that types don't make sense (as in it doesn't compile anymore) the npm verify step will now fail.

I honestly don't think it's too much work to port this code base to TypeScript, I personally wouldn't add any more intermediate steps.

eps1lon

Looks good to me with one minor nit.

Just need to decide in which version we want to drop this.

The jsdoc + js-check effort can be made in another PR with the goal of keeping the types in sync.

package.json

Lagily · 2020-04-24T11:52:20Z

I might give it a shot to port the code base to TypeScript - should I wait out on that?

eps1lon · 2020-04-24T13:28:53Z

I might give it a shot to port the code base to TypeScript - should I wait out on that?

For now we don't want to use actual TypeScript. After we resolved this PR I'm going to try out types via JSDOC.

timdeschryver · 2020-04-24T16:05:57Z

types/wait-for-element-to-be-removed.d.ts

@@ -0,0 +1,8 @@
+export function waitForElementToBeRemoved<T>(


Fyi, I made a PR to DefinitelyTyped to add the interval option here.
It got merged today, so I believe we should also add it here.

https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44006/files

actually since options is simply passed to waitFor, it should just use the same type, so we don't have to redefine it in multiple places, I'll take care of it

That's a good idea 👍

eps1lon · 2020-04-30T11:42:29Z

Regarding JSDOC: It doesn't seem like we can incorporate TS types at the moment. I wouldn't know how to type events.js.

kentcdodds · 2020-05-05T18:21:13Z

Ok, I'm thinking this is a good idea. Shame about the JSDOC stuff. Let's go ahead and get this merged and then we can explore migrating to TS totally.

Looks like there's a conflict in the package.json (sorry, my bad). I just released a major version to kcd-scripts which now will automatically run a typecheck script if it's available. So you don't need to worry about adding that to the validate script.

kentcdodds · 2020-05-05T20:11:52Z

Sorry, clicked the wrong button.

Also sorry about that, I mistakenly removed jsdom from the dev deps even though I forgot we actually use it directly for our node tests.

Go ahead and rebase again if you please and make sure to re-install deps. Thanks!

Lagily · 2020-05-05T20:26:15Z

Sure! Will hopefully run through now - does merging this PR count as a 'migrate to TS pull request is welcome'? :-D

kentcdodds · 2020-05-05T20:29:18Z

A pull request would be welcome, but I'm not certain that it would be merged.

To be frank, I'm insecure about my personal TypeScript abilities (just haven't had enough time with it honestly) so I've been hesitant to add TS to my projects primarily for that reason (though the barrier to contributions is also a consideration).

So I'm willing to take a look and provide feedback on a PR, but I'm not 100% certain that it would get merged.

kentcdodds · 2020-05-05T20:31:06Z

Is there anything left on this PR?

I want to leave this open for a day or two more to make sure everyone who's got an opinion shares it.

Merging this PR means that every API change should be associated with updates to the TypeScript definitions, so it has important implications.

Lagily · 2020-05-05T20:33:21Z

Fair enough. From my point of view, this PR is complete.

kentcdodds · 2020-05-07T17:47:42Z

Ok, let's do this.

kentcdodds · 2020-05-07T17:52:52Z

🎉 This PR is included in version 7.5.0 🎉

The release is available on:

npm package (@latest dist-tag)
GitHub release

Your semantic-release bot 📦🚀

nstepien · 2020-05-07T18:45:54Z

I use @testing-library/react and I'm getting these errors now:

> tsc -p tsconfig.all.json

node_modules/@testing-library/dom/types/queries.d.ts:3:32 - error TS2307: Cannot find module 'wait-for'.

3 import { waitForOptions } from 'wait-for';
                                 ~~~~~~~~~~

node_modules/@testing-library/dom/types/wait-for-dom-change.d.ts:1:32 - error TS2307: Cannot find module 'index'.

1 import { waitForOptions } from "index";
                                 ~~~~~~~

node_modules/@testing-library/dom/types/wait-for-element-to-be-removed.d.ts:1:32 - error 
TS2307: Cannot find module 'wait-for'.

1 import { waitForOptions } from "wait-for";
                                 ~~~~~~~~~~

node_modules/@testing-library/dom/types/wait-for-element.d.ts:1:32 - error TS2307: Cannot find module 'wait-for'.

1 import { waitForOptions } from "wait-for";
                                 ~~~~~~~~~~


Found 4 errors.

Looks like you need to use relative paths.

nstepien · 2020-05-07T18:52:54Z

@kentcdodds I've opened a PR to try to fix the above: #556

Lagily · 2020-05-16T08:48:16Z

@kentcdodds could you also add me as a contributor?

eps1lon · 2020-05-16T08:54:48Z

@all-contributors add @Lagily for code

allcontributors · 2020-05-16T08:54:59Z

@eps1lon

I've put up a pull request to add @Lagily! 🎉

Ali Nasserzadeh added 2 commits April 22, 2020 13:30

Copied the newest .d.ts files from DefinitelyTyped

dc8cc2a

Adjusted package.json to include type files and removed @types depend…

36c0231

…ency

kentcdodds reviewed Apr 22, 2020

View reviewed changes

Lagily and others added 4 commits April 23, 2020 21:16

Merge branch 'master' into master

0045130

Copied over DefinitelyTyped type tests

f02757e

Added dtslint to check the types and type-tests

4184bb9

Adjusted the types to pass dtslint (removed unneeded jsdoc)

c876b1a

eps1lon reviewed Apr 23, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

Removed unneeded dependency 'conditional-type-check'

4330d34

timdeschryver reviewed Apr 24, 2020

View reviewed changes

Ali Nasserzadeh added 2 commits April 24, 2020 19:13

Unified all waitForOptions types to one single type

70d0975

extended waitFor tests to better cover for the waitForOptions type

82edc36

Merge https://github.com/testing-library/dom-testing-library

56cf2e4

kentcdodds closed this May 5, 2020

kentcdodds reopened this May 5, 2020

Ali Nasserzadeh added 2 commits May 5, 2020 22:12

Merge https://github.com/testing-library/dom-testing-library

bbe2ea1

Rebased and bumped TypeScript version (stable)

430236e

kentcdodds merged commit 678f4da into testing-library:master May 7, 2020

kentcdodds added the released label May 7, 2020

kentcdodds mentioned this pull request May 7, 2020

feat: native typescript support testing-library/jest-dom#246

Merged

4 tasks

allcontributors bot mentioned this pull request May 16, 2020

docs: add Lagily as a contributor #577

Merged

kentcdodds added the TypeScript label Jun 3, 2020

kentcdodds mentioned this pull request Jun 3, 2020

@types/testing-library__react"' has no exported member 'waitFor' testing-library/react-testing-library#688

Closed

samtsai mentioned this pull request Jun 3, 2020

[WIP] Bring typings from DefinitelyTyped into this repo testing-library/react-testing-library#690

Merged

4 tasks

TheGallery mentioned this pull request Aug 16, 2020

Move types from DefinitelyTyped testing-library/cypress-testing-library#148

Merged

3 tasks

afontcu mentioned this pull request Nov 1, 2020

Move types from DefinitelyTyped to this repository testing-library/vue-testing-library#165

Merged

MatanBobi mentioned this pull request Dec 1, 2020

Move Types from @types/* to this repo testing-library/jest-dom#314

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Copied types from DefinitelyTyped into this repository #530

Copied types from DefinitelyTyped into this repository #530

Lagily commented Apr 22, 2020

codesandbox-ci bot commented Apr 22, 2020 •

edited

Loading

codecov bot commented Apr 22, 2020 •

edited

Loading

kentcdodds left a comment

eps1lon commented Apr 22, 2020

kentcdodds commented Apr 22, 2020

Lagily commented Apr 23, 2020

Lagily commented Apr 23, 2020

eps1lon left a comment

Lagily commented Apr 24, 2020

eps1lon commented Apr 24, 2020

timdeschryver Apr 24, 2020

Lagily Apr 24, 2020

timdeschryver Apr 24, 2020

eps1lon commented Apr 30, 2020

kentcdodds commented May 5, 2020

kentcdodds commented May 5, 2020

Lagily commented May 5, 2020

kentcdodds commented May 5, 2020

kentcdodds commented May 5, 2020

Lagily commented May 5, 2020

kentcdodds commented May 7, 2020

kentcdodds commented May 7, 2020

nstepien commented May 7, 2020

nstepien commented May 7, 2020

Lagily commented May 16, 2020

eps1lon commented May 16, 2020

allcontributors bot commented May 16, 2020

		@@ -0,0 +1,8 @@
		export function waitForElementToBeRemoved<T>(

Copied types from DefinitelyTyped into this repository #530

Copied types from DefinitelyTyped into this repository #530

Conversation

Lagily commented Apr 22, 2020

codesandbox-ci bot commented Apr 22, 2020 • edited Loading

codecov bot commented Apr 22, 2020 • edited Loading

Codecov Report

kentcdodds left a comment

Choose a reason for hiding this comment

eps1lon commented Apr 22, 2020

kentcdodds commented Apr 22, 2020

Lagily commented Apr 23, 2020

Lagily commented Apr 23, 2020

eps1lon left a comment

Choose a reason for hiding this comment

Lagily commented Apr 24, 2020

eps1lon commented Apr 24, 2020

timdeschryver Apr 24, 2020

Choose a reason for hiding this comment

Lagily Apr 24, 2020

Choose a reason for hiding this comment

timdeschryver Apr 24, 2020

Choose a reason for hiding this comment

eps1lon commented Apr 30, 2020

kentcdodds commented May 5, 2020

kentcdodds commented May 5, 2020

Lagily commented May 5, 2020

kentcdodds commented May 5, 2020

kentcdodds commented May 5, 2020

Lagily commented May 5, 2020

kentcdodds commented May 7, 2020

kentcdodds commented May 7, 2020

nstepien commented May 7, 2020

nstepien commented May 7, 2020

Lagily commented May 16, 2020

eps1lon commented May 16, 2020

allcontributors bot commented May 16, 2020

codesandbox-ci bot commented Apr 22, 2020 •

edited

Loading

codecov bot commented Apr 22, 2020 •

edited

Loading