Microsoft/TypeScript

lib.dom.d.ts should escape html elements in jsdoc comments

Open

#44,038 opened on May 11, 2021

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
Experience EnhancementHelp WantedSuggestion

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

Tech stack
typescripthtml
Domain
documentationfrontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScript knowledgefamiliarity with JSDoc comments
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is about escaping HTML elements like `<script>` in JSDoc comments within `lib.dom.d.ts`. The fix likely involves modifying the DOM lib generator or the source files that produce these comments. Review the current JSDoc for `HTMLScriptElement` and similar interfaces, and consider using backticks or HTML entities to escape. The main challenge is understanding where the comments originate (likely in the TypeScript DOM lib generator repo). Check comments in issue #44038 for any suggested approaches.