jsdoc-tsimport-plugin
jsdoc-tsimport-plugin copied to clipboard
A JSDoc plugin to support the typescript module import syntax.
Hello! I tried this: ```js /** @typedef {import('../../../../node_modules/@babylonjs/core/node.js').Node} BabylonNode */ ``` and it results in the error: ``` ERROR: Unable to parse a tag's type expression for source file /Users/trusktr/src/autonomys+unnamed-experiment/submodules/amazon-sumerian-hosts/packages/amazon-sumerian-hosts-babylon/src/Babylon.js/HostObject.js...
VS Code supports resolving `import("./folder")` style `typedef`s in JSDoc comments, but the plugin assumes that the basename of the path will be a file rather than a folder. A minimal...
It does not work inside tags of svelte or vue components
Seems like [Subpath imports](https://nodejs.org/api/packages.html#subpath-imports) aren't supported. Eg: ``` {import("#utils/typedefs").user} user User object ```
this change will allow JSDoc to parse any docstrings using the syntax in #14 which is used by VSCode / intellisense. Currently, JSDoc throws if it encounters these, when this...
This plugin works great to resolve import syntax like so: ```javascript /** @typedef {import("../bakery").Cake} Cake */ ``` But VSCode requires that properties on these types used in other JSDoc annotations...
Hello, It would be nice to support non-local imports, e.g. : ```js /** * @param {import('axios').AxiosRequestConfig} config * @returns {import('axios').AxiosInstance} */ ``` Thanks
Hi, i stricteley have following the steps and i have this error during the doc generation, any solutions? Thank's !  **Edit : Missing module name create this error**
Hi, i import all of my `typedef` top of file like this (doesn't work if i import it into an IIFE)  And i use it here (it work) ...
I have an import method inside my class and when I call it inside my jsdoc `@example` it gets transformed by the plugin. I'm not sure if this is expected...