Microsoft/TypeScript

Preserve properties descriptions when converting @typedef's to interfaces

Open

#54,716 opened on Jun 20, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (6,726 forks)batch import
Experience EnhancementHelp WantedSuggestion

Repository metrics

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

Description

Suggestion

Codefix convertTypedefToType doesn't preserve type and property descriptions.

For example in the test case properties id, name, and age have descriptions, but they are dropped when codefix is applied.

Suggest to preserve that description after converting @typedef to interface as properties descriptions like /** description */

🔍 Search Terms

Searched for typedef issues reported after March 1st

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Preserve @property description after converting @typedef to interfaces (as /** description */)

📃 Motivating Example

Converting

 /**
  * @typedef Foo
  * type {object}
  * @property {string} id - person's ID
  * @property name {string} // person's name
  * @property {number|undefined} age - person's age
  */

to

interface Foo {
    /** person's ID */
    id: string;
    
    /** person's name */
    name: string;
    
    /** person's age */
    age: number | undefined;
}

instead of

interface Foo {
    id: string;
    name: string;
    age: number | undefined;
}

💻 Use Cases

Applying suggested codefix in IDEs

### Tasks

Contributor guide