Typescript Compatibility about es-components HOT 7 OPEN

I created a repo where a complete Typescript re-write was done in order to produce the highest quality typescript definitions.

https://github.mktp.io/tosimpe/es-components-types

The Types folder contains all declarations for all the es-componenets libraries.

If possible, this folder could be shipped via npm with the library beit the package.json file is updated with the types property.

This would ensure nothing must be done after installing the module to make it typescript compatible. Also, I believe the developer experience in both a javascript env as well typescript env dramatically is improved. Consumers will see all the documentation directly in there editor as opposed to navigating to it in their browser. And all expected types are discoverable in the editor as well.

from es-components.

@jrios @stevematney @Darrken @aabenoja Is there someone I can talk to about this?

from es-components.

We take pull requests

from es-components.

If there is consensus, we can definitely see about migrating the repo to typescript. I see that you've done a large part of the work already in the repository you linked above. I think it would be foolhardy to try and do one fell swoop replacement, but if you'd like to see about introducing typescript for a single component, we can test it out before moving more in more of them.

How does that sound? @Darrken @stevematney @aabenoja @tosimpe

from es-components.

We take pull requests

@aabenoja this is not very constructive. let's try and keep things constructive here.

from es-components.

That sounds like a good plan, @jrios. I'd also feel more comfortable with piecemeal conversions rather than one huge PR.

from es-components.

I will be very busy through the end of the year else I would certainly offer up PR's. I wanted to get a feeling for interest before considering that though.

Currently, We are using patch-package with a npm post install script to include all the Typescript declarations into the node_modules/es-components/ and node_modules/es-components-wtw-theme directories. This ensures our project is fully typesafe and all the documentation for es-components can be found in editor.

I would not recommend a single PR either. The conversion repo I did was just to get the declarations and I made some shortcuts while converting js to ts that would break some of it. The repo does however contain proper JSDOC comments for most components though so even if go no TS route, I think there is a mass benefit to grabbing those from my personal repo.

from es-components.