Skip to content

Typescript support #4

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

Closed
ericdmoore opened this issue Mar 12, 2021 · 2 comments
Closed

Typescript support #4

ericdmoore opened this issue Mar 12, 2021 · 2 comments
Labels
☂️ area/types This affects typings good first issue 👋 This may be a great place to get started! help wanted 🙏 This could use your insight or help 🙆 yes/confirmed This is confirmed and ready to be worked on

Comments

@ericdmoore
Copy link

Subject of the feature

Are you open to adding an index.d.ts file?

Problem

I made a d.ts for this - that I have been using. Happy to PR it back to the project.

Expected behavior

VS Code Intelisense to show expected types.

Alternatives

I could submit directly to DefinitelyTyped - but I think their bots may ping you anyway. (Not sure, never PRd to DT before)

@ericdmoore ericdmoore added 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have labels Mar 12, 2021
@ericdmoore
Copy link
Author

@ChristianMurphy
Copy link
Member

We are, you can see some examples of types being added in
syntax-tree/xast-util-sitemap#1, syntax-tree/hast-util-sanitize#21, and syntax-tree/mdast-util-to-string#5
Note that for types as a dts file, using DTSLint and/or type coverage is highly recommended.

More recently there has been a push to get types generated from JSDoc
wooorm/zwitch@88b233d and wooorm/zwitch#6

Either works, and a PR would be welcome!


Closing this issue as we don't want to keep a types tracker issue in each of the 300+ unified repos.

@ChristianMurphy ChristianMurphy added good first issue 👋 This may be a great place to get started! ☂️ area/types This affects typings 🙆 yes/confirmed This is confirmed and ready to be worked on help wanted 🙏 This could use your insight or help and removed 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have labels Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☂️ area/types This affects typings good first issue 👋 This may be a great place to get started! help wanted 🙏 This could use your insight or help 🙆 yes/confirmed This is confirmed and ready to be worked on
Development

No branches or pull requests

2 participants