Microsoft/TypeScript

JSDoc tag descriptions lose their indentation.

Open

#53,576 opened on Mar 29, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: JSDocHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Does this issue occur when all extensions are disabled?: Yes

Version: 1.76.2 Commit: ee2b180d582a7f601fa6ecfdad8d9fd269ab1884 Date: 2023-03-14T17:47:26.641Z Browser: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36

Steps to Reproduce:

  1. Open vscode.dev
  2. Create a new file and set language mode to JavaScript
  3. Paste the following:
/**
 * This works
 * ```
 * some
 *   indentations
 *     and
 *       some
 *         more
 * ```
 */
function foo() {}

/**
 * @typedef MyObj
 * @property {number} foo This doesn't
 * ```
 * some
 *   indentations
 *     and
 *       some
 *         more
 * ```
 */

const obj = /** @type {MyObj} */ (null);

obj.foo
  1. Hover over foo on the last line.

When hovering over foo() it works fine: image

But on obj.foo the identation of the code block is lost: image

Contributor guide

Research direction
Investigate the hover tooltip formatting code for JSDoc comments in the TypeScript language service. Look at how `@typedef` and `@property` tag descriptions are indented when rendered in markdown. The issue is that indentation is lost for code blocks inside JSDoc tags that are under a typedef, while it works for plain JSDoc comments. Check the logic that strips leading whitespace or processes tag descriptions.
Tech stack
typescriptjavascript
Domain
developer experiencetooling
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70