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

Jsdoc to typescript definitions #965

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Munter
Copy link
Member

@Munter Munter commented Jan 17, 2019

This is an attempt at automatically generating typescript definitions from the existing jsdoc comments.

It seems like types.d.ts gets output correctly, but I haven't yet succeeded in actually getting vscode to pick the definitions up while doing local development or linking projects across the file system.

Example output: https://gist.github.com/Munter/06b6eb424867f2e333f20d93550fb3c7

@Munter Munter changed the title Jsdocto .d.ts Jsdoc to typescript definitions Jan 17, 2019
Copy link
Member

@papandreou papandreou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me!

I thought vscode already picked up on jsdoc annotations in code pulled in from node_modules, so it should already be able to infer the same things? Does this change add any capabilities?

@@ -61,6 +61,7 @@
"specificity": "^0.4.0",
"sw-precache": "^5.2.0",
"teepee": "^2.31.1",
"tsd-jsdoc": "^2.1.2",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be a dev dep?

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

Successfully merging this pull request may close these issues.

None yet

2 participants