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

Ouverte
#60,113 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
38/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, typescript
Domaine
compilers

Piste de recherche

Commencez par le reproducer lié en faisant un checkout de issue-typescript-missing-type-param, en exécutant npm install et npm run build, puis inspectez dist/index.d.ts. Suivez le chemin d’émission des déclarations pour une expression de membre JSDoc @extends ; c’est terminé lorsque la clause extends générée conserve l’argument de type T et que la déclaration est valide.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Bug Domain: JSDoc Help Wanted
🔎 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

Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de microsoft/TypeScript

Toutes les issues de microsoft/TypeScript

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.