microsoft / microsoft/TypeScript
lib.dom.d.ts should escape html elements in jsdoc comments
Open
Nobody has claimed this yet.
Experience Enhancement
Help Wanted
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
lib Update Request
Configuration Check
My compilation target is ES2020 and my lib is the default.
Missing / Incorrect Definition
For html elements such as HTMLScriptElement, the JSDoc includes <script>. This causes VS Code to drop the entire body of the comment
Sample Code
const a: HTMLScriptElement // hover over HTMLScriptElement
Proposal
These JSDoc comments should escape any html in the comments. I suggest using markdown inline code instead:
/** HTML `<script>` elements expose the HTMLScriptElement interface ... */
interface HTMLScriptElement extends HTMLElement {
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the generated lib.dom.d.ts and the TypeScript-DOM-lib-generator referenced in the issue. Inspect the HTMLScriptElement JSDoc and verify that HTML such as <script> is escaped or represented as inline code so VS Code preserves the full comment when hovering over HTMLScriptElement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100