Clarifying recommendation for when to publish types to DefinitelyTyped vs bundled
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
Comienza con packages/documentation/copy/en/declaration-files/Publishing.md, especialmente con las indicaciones de las líneas 11–16, y compara su redacción con la aclaración propuesta en el issue. Se considera completado cuando la documentación distingue claramente entre los tipos incluidos y las indicaciones de DefinitelyTyped para proyectos de TypeScript y JavaScript.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Per #2804, I am creating a new issue to replace #2032 with renewed clarity and purpose.
When publishing types, there are essentially two standard ways to do so:
Reading this, to me, "Otherwise" suggests that packages should only bundle their types if they were automatically generated.
This nicely covers two use cases:
- Source is in TypeScript. Published package is compiled to JavaScript alongside type definitions.
- Source is not in TypeScript. Package users independently publish and maintain types for the package.
I think a 3rd intermediate case is missing:
- Source is not in TypeScript. Code maintainer willing to add, maintain, and publish type definitions alongside source.
I've had passing conversations with maintainers that seemed to me to be under the impression that publishing manually created types separately was the preferred way to do it, seemingly because of this phrasing. Some even suggested doing this for TypeScript packages...
As far as I can tell, there is basically no downside to publishing accurate types along with source code, besides a marginal increase bundle size. The improved developer experience is well worth it and the types get compiled away for any real publishing. I would also think DefinitelyTyped would prefer if others did not rely on DT as it centralizes type issues in their respective packages and handles mismatched version issues intrinsically.
Suggestion for new phrasing
Including up-to-date types in published packages is always preferred. Bundling types improves developer experiences and reduces occurrence of common bugs and issues. If your types are generated by your source code, or you are keeping them up to date manually, we recommend you publish them with your published code bundle. Both TypeScript and JavaScript projects can generate types via declaration.
If you would prefer to not bundle your type definitions in your published package, we recommend submitting the types to DefinitelyTyped, which will publish them to the @types organization on npm.
If you do neither, any users of your package may still submit their own types to DefinitelyTyped.
- Lenguaje dominante
- TypeScript
- Estrellas
- 2.6k
- Forks
- 1.5k
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 8
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Más de microsoft/TypeScript-Website
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
microsoft/TypeScript-Website#3611 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
microsoft/TypeScript-Website#3607 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
microsoft/TypeScript-Website#3039 ·
-
More examples of `infer` Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
microsoft/TypeScript-Website#2998 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
microsoft/TypeScript-Website#3614 ·
Todos los issues de microsoft/TypeScript-Website
Issues similares
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Crush Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
ElementsProject/cln-application#167 · 1 comentario · 1 reacción ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Quantco/pnpm-licenses#17 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100