Generate Typescript and Flow type definitions from existing prop-types.

[girishla]

Are there any plans on providing Typescript type definitions ?

[interactivellama]

There is nothing on the roadmap for *.d.ts files at this time. I'm open to them being added. We would probably need to add some tests that validate them, so that they don't get out of date.

[interactivellama]

How can we do this based on propTypes in an automated way?

Also provide Flow typed definitions.

[futuremint]

I tried using dts-gen from Microsoft last week to create Typescript definitions but couldn't get it working using their basic CLI usage on our npm library.

However I'm sure it'll be straightforward to write up a script that uses the source files to generate type definition files from the PropTypes we've already written.

[davidlygagnon]

There is this codemod available to generate flow types from prop-types : https://medium.com/netscape/react-proptypes-to-flow-codemod-9757f5ec5381

. Only caveat is it seems to also removes prop-types... Never used it before but maybe there's a flag that can be passed to leave prop-types as is when converting.

I know I've used this: https://github.com/joarwilk/flowgen before to convert TypeScript defs to flow types, (but that's assuming we have TypeScript defs).

[interactivellama]

We might be able to use something from react-docgen AST parser if we need to do something custom.

[futuremint]

I'm going to work on adding a typedef file in October. I will also look into generating a library definition for flow as well.

[ChuckJonas]

instead of trying to keep typedefs in sync, a better solution would just be to convert this to a typescript project 😉.

[futuremint]

I don't disagree... but providing a typedef file is a bit orthogonal to this project being typescript or not. Being typescript would certainly help this cause... but it doesn't prevent it either. We have other typescript projects around Salesforce, the heavy lifting here would be around integrating tsc into the build system, and also around cleaning up the types. IMHO, typescript's benefits don't really show up until you can turn on strictNullChecks without warnings/errors.

All that said... it is open source and we welcome contributions! I'd be happy to review a PR if you wanted to work on converting to typescript. We'd need to talk about it internally to see if the main contributors were comfortable with typescript though... we have some contributors who also use flow.

[ChuckJonas]

@futuremint I think the biggest benefit would be replacing the clunky propTypes definitions with typescript much better typing system. I think there are other benefits as well, but I was half joking.... It's definitely a big ask.

In my dreamworld ESNextNext just adopts the typescript specification, so you might as well get on board now 😈

[futuremint]

Here is a library I found... https://github.com/KnisterPeter/react-to-typescript-definitions

[dehru]

Hello, has there been any progress on types?

[interactivellama]

@dehru I think @futuremint has been pulled into other organizational priorities.

I'm un-assigning the issue from you @futuremint until you are able to take this up.

[futuremint]

Thats fine to un-assign it. @dehru we're an open sourced project and would welcome a contribution for this if you're inclined to take it on yourself.

[xoob]

Hey everyone, we are currently working on adding TypeScript compatibility for design-system-react and will provide a pull request that will add strict type definitions for every component and their prop types.

[ChuckJonas]

Curious if you are rewriting in ts or just adding type defs?

[xoob]

We are adding .d.ts files for the existing library. Our work utilizes tsc with allowJs and checkJs, and KnisterPeter/react-to-typescript-definitions. The goal is to be able to import the library into TypeScript projects and get code completion, strict validation, and no import errors, while trying to keep the changes to the library as minimal as possible.

[Ewilliams90]

Extremely excited about this @xoob and I would love to help if I can in any way.

[xoob]

I'm currently waiting for a number of pull requests to land before we continue on this.

[interactivellama]

@xoob Is that pull requests on our side or something internal to you?

@Ewilliams90 Welcome to Salesforce!

[garygong]

I think one of the PRs is on our side (#2514). I took a look at that one and it generally looks good.

[djdeimon]

I just can't wait those types definitions. It will be really nice feature and finally I will avoid multiple import issues in my project.

[coler-j]

We are adding .d.ts files for the existing library. Our work utilizes tsc with allowJs and checkJs, and KnisterPeter/react-to-typescript-definitions. The goal is to be able to import the library into TypeScript projects and get code completion, strict validation, and no import errors, while trying to keep the changes to the library as minimal as possible.

@xoob, I would be really interested in your workflow for this, currently looking into doing something similar. Made a SO q to collate my search.