please alias jsdoc doc comments to variable assignments

Suggestion

🔍 Search Terms

typescript alias jsdoc to variable assignment

✅ 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

Please copy JSDoc data to aliased variables.

📃 Motivating Example

/** Call this in order to something. */
const foo = (s: string): number => 123

const f = foo

f // hovering on 'f' does not show the documentation description "Call this in order to something."

playground

💻 Use Cases

Make documentation easier. All projects need good documentation!

Workaround:

an author can copy/paste duplicate JSDoc comments. This is harder to maintain.

[verikono]

Big props to this… If i get another sermon about semantic reasoning from my boss I think I shall surely die… He’s all about those multilevel type aliasing, type branding and guarding and now he’s worked out that with async/await everywhere… those type guards are getting very very very composed… unlike myself.

[remcohaszing]

Could this also be applied to type aliases too?

/**
 * This is a type
 */
type Foo = string | number

type Bar = Foo

// hovering on 'Bar' does not show the documentation description "This is atype"
export { Bar }

This is especially useful for types in jsdoc

/**
 * @typedef {import('vscode-languageserver-types').Range} Range
 */

// jsdoc information is lost for 'Range'
/**
 * @param {Range} range
 */
function handleRange(range) {}