microsoft / microsoft/TypeScript
Support declaring @types as the supported route for typings dependencies in the package.json
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Search Terms
package json types field types types module
Suggestion
Allow libraries written in JavaScript to be able to declare that they have types in DT (or other modules), and that they support a certain version of it.
For example:
Express does not support TypeScript but trusts that the DefinitelyTyped express maintainers know what they are doing generally. They want to declare that DT is the way for TypeScript users to get types out of the box. Today that's not really possible.
Examples
Two potential routes:
-
Override the "types" parameter to support:
"types": "@types/express:^3.0"in a package.json -
Recommend a new field in the package.json:
"typesModule": "@types/express:^3.0"- then when TypeScript normally offers a 'no types found', then it can offer the command to install with the correct semver range.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
/cc @wesleytodd @isaacs @ljharb
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 revisando cómo TypeScript lee los metadatos de package.json y el funcionamiento de la ruta existente “no types found”; el issue no menciona archivos fuente ni tests. El diseño debe elegir y especificar primero cómo declara un paquete un módulo de typings externo y su rango de semver compatible, y después verificar que TypeScript pueda usar esa declaración para orientar la instalación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 32/100