microsoft / microsoft/TypeScript

Add initializer property to JSDocParameterTag node

Offen
#61,373 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

### 🔍 Search Terms

param, parameter, argument, jsdoc, initializer, default value, parameter

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

Add an optional initializer property to the `JSDocParameterTag`, which will contain the default value of the param tag.

For a function:

```js
/**
* @param {string} [p="test"] - An optional param with a default value
*/
const abc = (p) => {};
```

The `initializer` property will be `test`.

This is a parity change with the `Parameter` node, which has `initializer` property for initializer in the parameter declaration:

```ts
const abc = (p: string = "test") => {};
```

### 📃 Motivating Example

Adding the `initializer` property to the `JSDocParameterTag` makes it possible to indicate default value of any overloaded function or function declaration, which was previously impossible. This adds the same property which was previously only available on the `Parameter` node. So IDEs or other tools built on TypeScript compiler now can easily communicate the default value of the parameter.

Since the default value of the parameter is currently already parsed, it should by trivial to just add it to the node as a new property and shouldn’t cause any performance issues.

### 💻 Use Cases

1. What do you want to use this for?
This can be used by IDEs or other tooling (such as documentation generators) to show default value of the parameter, which rely on TypeScript compiler.
In my use case I’m building a documentation generator which outputs parameter table for functions with types, default values and descriptions. For default values I’m using the initializer of the function and if it’s not specified I would like the default value from the param tag.

2. What shortcomings exist with current approaches?

There is no way how to access default values of overloaded methods or method declarations. This is also true for overloaded methods where initializer is not permitted in the parameter itself.

3. What workarounds are you using in the meantime?

The tools which want to use this have to parse the jsdoc parameter themselves.

If this issue gets approved I would gladly submit a PR for this.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Finde die Definition von JSDocParameterTag und die bestehende Behandlung von Parameter-Initializern im TypeScript-Compiler, und verfolge anschließend, wo Standardwerte von JSDoc-Parametern geparst werden. Überprüfe die relevanten Compiler-Tests auf JSDoc-AST-Eigenschaften und füge eine Abdeckung hinzu, die zeigt, dass der geparste Standardwert als optionaler Initializer verfügbar gemacht wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.