Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use JSDoc instead of TypeScript for strong typing #3353

Closed
brodycj opened this issue Sep 16, 2019 · 3 comments
Closed

Use JSDoc instead of TypeScript for strong typing #3353

brodycj opened this issue Sep 16, 2019 · 3 comments
Labels
discussion Needs deeper discussions

Comments

@brodycj
Copy link

brodycj commented Sep 16, 2019

In short, I think this could help avoid adding another barrier of entry for external contributors and some other disadvantages discussed in: https://medium.com/javascript-scene/the-typescript-tax-132ff4cb175b

Here is some documentation of using JSDoc comments to add the strong typing to the existing JavaScript, as documented in the following resources:

see also this discussion: prettier/prettier#6286

There should also be a way to use JSDoc comments to completely bypass using *.d.ts, not working 100% due to microsoft/TypeScript#33136

I would like to give this idea sometime in the near future (no promises right now, unfortunately).

++ /cc @rbiggs

@ShimiSun
Copy link
Collaborator

Thank you for sharing buddy!! 🚀

@ShimiSun ShimiSun added the discussion Needs deeper discussions label Sep 17, 2019
@brodycj
Copy link
Author

brodycj commented Sep 20, 2019

Thanks @ShimiSun for all of your words of encouragement.

I guess my comments in #3271 were too controversial. My opinion remains the same, will do my best to work with whatever decision is taken in the end.

@jcfilben
Copy link
Collaborator

I'm thinking at this point, since we have already committed to typescript, we don't need to add JSDoc. Feel free to re-open and comment if you feel this would still be a valuable enhancement or would like to continue discussion on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Needs deeper discussions
Projects
None yet
Development

No branches or pull requests

3 participants