-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Support import
syntax (and possibly deprecate module
syntax)
#1632
Comments
jsdoc does not follow imports by default #1577 |
I am referring to Typescript's style of imports; see, e.g.: https://github.com/openlayers/jsdoc-plugin-typescript#typescript |
The quotation marks in Hopefully if accepting this issue as I hope would be the case for mutual compatibility, JSDoc, might allow, at least through plugin, the ability to check such non-browser-resolvable paths (especially according to the Node Resolution Algorithm), so that they could be confirmed in some way. So that, e.g.: /** @type {import("jQuery.fn").starfairy} */ ...could be confirmed as a valid path, and even possibly link to source code. Actually, since jQuery doesn't export "fn", I guess it should be: /** @type {import("jQuery").fn.starfairy} */ |
I think this qualifies as a duplicate of #1645. |
A jsdoc plugin to workaround to this problem (or at least the case of relative imports): |
Expected behavior
Allow this Typescript syntax:
I'd personally also hope to see
module:
deprecated (at least eventually):...because:
Current behavior
Currently, the
module
syntax is not compatible with those wishing to move to Typescript (or considering doing so), or those using Typescript who wish to confine themselves to the subset supported by jsdoc3 so as to be able to take advantage of jsdoc3/jsdoc.The text was updated successfully, but these errors were encountered: