Repository navigation
JSDoc @import no longer works correctly with default exports #60317
Description
Activity
Peter Wagenet (@wagenet) Does the following test apply to your case?
// @Filename: /tsconfig.json { "compilerOptions": { "allowJs": true, "checkJs": true, "baseUrl": ".", "paths": { "ns/*": ["src/*"] } } } // @Filename: /src/foo.ts export default interface Foo { a: number; } // @Filename: /src/bar.js /** @import Foo from "ns/foo" */ /** @return {Foo} */ function f() { return { a: "" }; }Oleksandr Tarasiuk (@a-tarasyuk) I have
allowJs: truebut no setting forcheckJs.Peter Wagenet (@wagenet) I modified Oleksandr Tarasiuk (@a-tarasyuk) 's example slightly. But it works as expected --
Foogets imported and shows the correct error. Can you give more detail about your repro, like what the filenames are and what all your tsconfig settings are?I would recommend setting
checkJs: truefirst thing because that will show errors in JS files, and there's probably an error on your@importthat you're not seeing.// @Filename: /tsconfig.json { "compilerOptions": { "noEmit": true, "allowJs": true, "checkJs": true, "baseUrl": ".", "paths": { "ns/*": ["src/*"] } }, "files": ["src/bar.js"] } // @Filename: /src/foo.ts export default interface Foo { a: number; } // @Filename: /src/bar.js /** @import Foo from "ns/foo" */ /** @return {Foo} */ function f() { return { a: "" }; }
I have encountered the same problem with Typescript version 5.8.3 (in VS Code version 1.101.0)
🔎 Search Terms
jsdoc import Import (A place for python bower components) (@import)
🕗 Version & Regression Information
This changed between versions 5.5.4 and 5.6.3.
⏯ Playground Link
No response
💻 Code
tsconfig.jsonexcerpt:{ "compilerOptions": { "baseUrl": ".", "paths": { "my-app/*": ["src/*"] } } }🙁 Actual behavior
In TypeScript 5.5 the above worked correctly with
getFooreturningFoo. As of TypeScript 5.6 this now returns anany. This workaround resolves the problem but feels like it is not what is intended.🙂 Expected behavior
I expected default exports to work with
@importin JSDoc.Additional information about the issue
No response