WIP: chore(typescript): add TypeScript typings

[aaronmcadam]

What: Attempts to fix #12. I've only added support for getByTestId to ensure that I've done things correctly. I wonder if there's an easy way to keep up to date with dom-testing-library?

Why: For TypeScript support

How: Added a typings directory and added a reference to package.json.

I've tried to copy how cypress adds its own types for chainable methods and custom commands: https://github.com/cypress-io/add-cypress-custom-command-in-typescript/blob/master/README.md

Checklist:

• Documentation: add instructions on adding the library types to tsconfig.json
• Tests
• Ready to be merged
• Added myself to contributors table

[sompylasar]

Looks right to me. There's an example here https://github.com/cypress-io/add-cypress-custom-command-in-typescript/blob/aff24be0/README.md but your code looks more correct and up-to-date than the one in the example.

[aaronmcadam]

I've heard about a way to test typings, I'm AFK but maybe we could enumerate the functions the dom library supports in order to make sure we cover everything. I'll look into it tomorrow. Thanks so much for helping out @sompylasar!

[sompylasar]

I've heard about a way to test typings

Please let me know when you find the way, I'd like to learn it for general awareness.

[aaronmcadam]

I think it's worth reaching out to @kentcdodds, as I don't want to add to his already busy workload for a workflow that he doesn't use day to day. My twitter is @aaromcadam @sompylasar if you want to pick things up in the morning (I'm UTC time)

[aaronmcadam]

@sompylasar Here's an intro to type testing with dtslint

[aaronmcadam]

I've attempted to copy the implementation here: https://github.com/kentcdodds/dom-testing-library/blob/master/typings/queries.d.ts

[aaronmcadam]

Hi @sompylasar, could you give this another look when you get a chance? Thanks!

[sompylasar]

LGTM (if it works, can't test it myself), thanks!

[kentcdodds]

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[kentcdodds]

Thanks so much for your help! I've added you as a collaborator on the project. Please make sure that you review the other/MAINTAINING.md and CONTRIBUTING.md files (specifically the bit about the commit messages and the git hooks) and familiarize yourself with the code of conduct (we're using the contributor covenant). You might also want to watch the repo to be notified when someone files an issue/PR. Please continue to make PRs as you feel the need (you can make your branches directly on the repo rather than your fork if you want). Thanks! And welcome to the team :)

[aaronmcadam]

Do we have any active TypeScript users? These definitions aren't being picked up by VSCode for me.

[sebastian-ludwig]

Hi @aaronmcadam, you should probably use global augmentation instead

declare global {
  namespace Cypress {
    ...
  }
}