microsoft / microsoft/TypeScript

JSDoc with @extends, type parameter and member expression gives wrong dts output

Aperta
#60,113 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Bug Domain: JSDoc Help Wanted
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

🔎 Search Terms

jsdoc type parameter generics extends superclass template

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about JSDoc type parameters with @extends

I tried with TypeScript 5.0.0, 5.6.2, and 5.7.0-dev.20241001.

⏯ Minimal repro link

I needed more than one file to reproduce, which I can't do on the playground. Here's a simple reproducer:

https://github.com/blutorange/issue-repro/tree/issue-typescript-missing-type-param

git clone https://github.com/blutorange/issue-repro
cd issue-repro
git checkout issue-typescript-missing-type-param
npm install
npm run build

Then open dist/index.d.ts.

💻 Code
/**
 * @template {0|1|2} T
 * @extends {Scope.sub.Box<T>}
 */
export class MyComponent extends Scope.sub.Box {
    more() {
        return "foo";
    }
}
🙁 Actual behavior

The class in the extends clause is missing the type parameter. This is a compile error when you validate the .d.ts file.

declare const MyComponent_base: typeof import("./header.js").Box;
/**
 * @template {0|1|2} T
 * @extends {Scope.sub.Box<T>}
 */
export class MyComponent<T extends 0 | 1 | 2> extends MyComponent_base {
    constructor();
    more(): string;
}
export {};
🙂 Expected behavior

TypeScript should include the type parameter in the extends clause.

declare const MyComponent_base: typeof import("./header.js").Box;
/**
 * @template {0|1|2} T
 * @extends {Scope.sub.Box<T>}
 */
export class MyComponent<T extends 0 | 1 | 2> extends MyComponent_base<T> {
    constructor();
    more(): string;
}
export {};
Additional information about the issue

Only seems to happen when the extends clause is a member expression where TS generate an intermediate declare const ....

Fyi, I came across this issue while investigating how to setup a project for generating type declarations from js files for primefaces/primefaces#12500

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con il reproducer collegato facendo il checkout di issue-typescript-missing-type-param, eseguendo npm install e npm run build, quindi esamina dist/index.d.ts. Traccia il percorso di emissione delle dichiarazioni per una member expression JSDoc @extends; il lavoro è completato quando la clausola extends generata conserva l’argomento di tipo T e la dichiarazione è valida.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.