microsoft / microsoft/TypeScript
"types" field in package.json pointing to a `.ts` file in node_modules results in the file being compiled and type checked
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
Continuing from https://github.com/Microsoft/TypeScript/issues/22228
cc @evil-shrike
I have this issue.
@mhegazy said
the lib has either
"types": "index.ts"or a.tsfile at its root. which is wrong. a library should not expose its sources, only its declarations.
But features like inferred return types (f.e. when making class-factory mixins) are not compilable to declaration files, resulting in errors like
error TS4025: Exported variable 'html' has or is using private name 'htmlBind'.
error TS4031: Public property '_currentArea' of exported class has or is using private name 'AreaInternal'.
error TS4055: Return type of public method from exported class has or is using private name 'PartHelper'.
error TS4073: Parameter 'partHelper' of public method from exported class has or is using private name 'PartHelper'.
error TS4078: Parameter 'options' of exported function has or is using private name 'ExtendOptions'.
A .d.ts does not have expressions.. it represents the shape of the API.
Not entirely true.
As far as I know, the only way to use features (that declaration files don't support) in downstream projects is to get types directly from .ts source files. This makes the need to point types to .ts source files a valid use case.
This is what I think should happen:
If "types" points to a .ts file, and "main" points to a .js file, then the compiler should use the .ts file only for type definitions and not compile or type-check the code.
"main" can serve as a guide to telling the compiler whether it should compile sources, or read js files. "types" should be for... specifying the source of types.
Unless I missed it, there's no other way to include types for features that aren't representable in declaration files.
Why is it that declaration features don't match source features? It seems that an important goal should be for declaration features to always have the capability of matching source features.
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 reproduciendo la configuración de package.json descrita aquí, con types apuntando a un archivo .ts y main apuntando a un archivo .js; revisa la discusión en el issue #22228 para obtener contexto. Se considera terminado cuando el compilador usa la entrada .ts para obtener información de tipos sin compilar ni comprobar los tipos de su implementación, manteniendo al mismo tiempo el comportamiento de tipado solicitado para el código posterior.
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
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100