Microsoft/TypeScript

Code blocks for `@typedef` do not preserve indentation in the generated `.d.ts` file.

Open

#46,750 opened on Nov 9, 2021

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: Comment EmitEffort: ModerateHelp Wanted

Repository metrics

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

Description

Bug Report

🔎 Search Terms

code block typedef indentation

🕗 Version & Regression Information

Version 4.4.3, 4.4.4, 4.6.0-dev.20211109

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about @typedef

⏯ Playground Link

Playground link with relevant code

💻 Code

/**
 * @typedef {object} TEST
 * ```js
 * {
 *   key_1: value_1,
 *   key_2: {
 *     key_2_1: {
 *       key_2_1_1: 'ZZZzzz…'
 *     }
 *   }
 * }
 * ```
 */

🙁 Actual behavior

Code blocks for @typedef do not preserve indentation in the generated .d.ts file.

/**
 * ```js
 * {
 * key_1: value_1,
 * key_2: {
 *   key_2_1: {
 *     key_2_1_1: 'ZZZzzz…'
 *   }
 * }
 * }
 * ```
 */
type TEST = object;

🙂 Expected behavior

Code blocks for @typedef preserve indentation in the generated .d.ts file.

/**
 * ```js
 * {
 *   key_1: value_1,
 *   key_2: {
 *     key_2_1: {
 *       key_2_1_1: 'ZZZzzz…'
 *     }
 *   }
 * }
 * ```
 */
type TEST = object;

Contributor guide

Research direction
Investigate how TypeScript processes JSDoc comments with code blocks during declaration file generation. Focus on the JSDoc parser and the emitter that produces .d.ts files. Look for indentation handling in multi line code blocks.
Tech stack
typescript
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40