microsoft / microsoft/TypeScript
JSDoc with @extends, type parameter and member expression gives wrong dts output
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
🔎 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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el reproductor vinculado haciendo checkout de issue-typescript-missing-type-param, ejecutando npm install y npm run build, y después inspecciona dist/index.d.ts. Sigue la ruta de emisión de declaraciones para una expresión de miembro JSDoc @extends; se considera terminado cuando la cláusula extends generada conserva el argumento de tipo T y la declaración es válida.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100