Microsoft/TypeScript

Comments on inner properties are stripped

Open

#10,383 opened on Aug 17, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
Help WantedSuggestion

Repository metrics

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

Description

TS: 2.0.0

// code.ts
/**
 * Some foo
 */
export const foo = {
  /**
   * Some boo
   */
  boo = 0
}

expect:

// code.d.ts
/**
 * Some foo
 */
export declare foo: {
  /**
   * Some boo
   */
  boo: number;
}

actual:

// code.d.ts
/**
 * Some foo
 */
export declare foo: {
  boo: number;
}

By the way, is there a way to separately control whether comment should be kept in *.d.ts and *.js?

Currently when tsconfig.json/compilerOptions/removeComments = true, comments are removed from both of them.

Would it be nice to keep the comments in *.d.ts but not *.js?

Contributor guide

Research direction
Investigate how the TypeScript compiler handles comment emitting for declaration files. Focus on the emit pipeline for .d.ts files, specifically how JSDoc comments on object literal inner properties are handled. Look at the relevant transformer or emitter code that strips comments.
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-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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40