JSDoc @import _unintentional?_ passthrough to generated declarations. #58921
Labels
Bug
A bug in TypeScript
Domain: Declaration Emit
The issue relates to the emission of d.ts files
Effort: Casual
Good issue if you're already used to contributing to the codebase. Harder than "good first issue".
Help Wanted
You can do this
Milestone
Acknowledgement
Comment
With TS 5.5 and the new
@import
JSDoc tag it appears that TSC will passthrough the comment block containing@import
to the generated declarations. The actual import statements are added, but the "unnecessary" comment block remains in the generated declarations. I've already discussed this with the maintainer of TypeDoc and a fix is put in there to ignore any@import
comment blocks, but I figured it would be worth raising this as a potential issue with this new functionality. It's not broken, but can possibly be refined in respect to downstream tooling. I think it is fine to remove any JSDoc comment blocks that just contain@import
tags from generated declarations.I do have a full description of the scenario and the small inconvenience this can cause in downstream tooling via this TypeDoc issue, so do refer to that for an example.
I really appreciate
@import
though as it is a mighty fine feature!The text was updated successfully, but these errors were encountered: