-
Notifications
You must be signed in to change notification settings - Fork 144
Description
Jsr shows top-level docs (via a @module jsdoc directive) in its Overview tab for each package. If the entrypoint to a module is a .tsx file, however, such an @module comment is not parsed correctly, and the readme file is shown in the Overview tab instead. A quick look at the sources passed to jsr reveals that the .tsx file is precompiled into a regular .ts file, and this process prepends some jsdoc comments/pragmas at the very start of the file. That probably breaks the logic for determining whether the module entrypoint has a dedicated doc comment to render as the overview.
Example in production:
- https://jsr.io/@macromania/macromania-html@0.2.0 renders the readme in the
Overviewtab, whereas - https://jsr.io/@macromania/macromania-html@0.2.1 renders the proper doc comment.
The only difference between version 0.2.0 and 0.2.1 of that package is that the module entrypoint in the prior is a .tsx file, and a .ts file in the latter.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status