Lecciones de Mantenimiento de Bibliotecas TypeScript

Rate this content
Bookmark

Mantener bibliotecas JS ampliamente utilizadas ya es complicado, y TypeScript añade un conjunto adicional de desafíos.

Únete al mantenedor de Redux, Mark Erikson, para echar un vistazo a algunos de los problemas únicos que enfrentan los mantenedores de bibliotecas TS, y cómo el equipo de Redux ha manejado esos problemas. Cubriremos:

- Compromisos de diferentes formas de definir tipos TS para una biblioteca
- Cómo dirigirse a diferentes versiones de TS, y consideraciones para determinar el rango de versión soportado
- Migración de bibliotecas JS existentes a TS
- Diferencias entre escribir tipos de "aplicación" y tipos de "biblioteca"
- Gestión y versionado de APIs de tipos públicos
- Consejos y trucos utilizados por tipos de las bibliotecas Redux
- Limitaciones de TS y posibles mejoras a nivel de lenguaje

This talk has been presented at TypeScript Congress 2022, check out the latest edition of this JavaScript Conference.

FAQ

Los tipos en una biblioteca de TypeScript sirven principalmente para dos propósitos: actúan como documentación de la API, permitiendo a los usuarios entender qué funciones y tipos existen y cómo pueden utilizarlos, y ayudan a asegurar la corrección del código tanto del usuario como de la biblioteca, mejorando la mantenibilidad y el comportamiento esperado del código.

Para migrar una biblioteca de JavaScript a TypeScript, se debe comenzar estableciendo una infraestructura de compilación adecuada, asegurarse de que los tipos de TypeScript se compilen y transformen correctamente a JavaScript, y configurar las pruebas para trabajar con TypeScript. Es crucial incluir los tipos directamente en el paquete publicado y utilizar herramientas para probar el paquete con código de aplicación TypeScript antes de la migración completa.

Manejar las versiones de los tipos en TypeScript puede ser complicado ya que TypeScript no utiliza versionado semántico. Es importante considerar los tipos como parte de la API y manejar cuidadosamente los cambios que puedan afectar la compatibilidad hacia atrás. Algunos enfoques incluyen la configuración de CI para testear múltiples versiones de TypeScript y definir políticas de soporte de versiones claras.

Depurar tipos en TypeScript es complicado porque no puedes poner un punto de interrupción en una definición de tipo como en el código tradicional. Una estrategia útil es descomponer tipos complejos paso a paso y asignarlos a variables separadas para analizar cada parte del proceso. Herramientas y configuraciones específicas pueden ayudar a mejorar la visualización y manejo de errores en los tipos.

Diseñar APIs con TypeScript presenta desafíos debido a la naturaleza dinámica de JavaScript. TypeScript empuja hacia un diseño de API más simple y claro. Esto implica crear tipos que puedan inferir la mayor cantidad de información posible para minimizar la cantidad de datos que los usuarios deben proporcionar, aunque esto puede resultar en tipos más complejos.

Mejorar la experiencia de mantenimiento de bibliotecas TypeScript podría incluir la introducción de genéricos opcionales o con nombre, mejores herramientas de depuración de tipos y mensajes de error más claros. Estas mejoras ayudarían a manejar la complejidad de los tipos y a proporcionar una guía más clara para los desarrolladores que utilizan la biblioteca.

Mark Erikson
Mark Erikson
30 min
29 Apr, 2022

Comments

Sign in or register to post your comment.

Video Summary and Transcription

Mark Erickson, un Ingeniero Frontend Senior en Replay, discute las bibliotecas de JavaScript y su soporte para TypeScript, incluyendo migración, versionado y depuración. También explora los desafíos de soportar múltiples versiones de TypeScript y diseñar APIs para su uso con TypeScript. Además, comparte trucos avanzados de tipos Redux e ideas para mantener una biblioteca TypeScript. Los resultados de la encuesta revelan el uso generalizado de TypeScript entre los desarrolladores, con muchos migrando gradualmente sus bases de código. Por último, proporciona consejos para actualizar TypeScript y verificar la funcionalidad.

1. Introducción a Mark Erickson

Short description:

Hola, soy Mark Erickson, un Ingeniero Senior de Frontend en Replay, conocido por responder preguntas sobre React y Redux, recopilar enlaces útiles, escribir entradas de blog y ser un mantenedor de Redux.

Hola, soy Mark Erickson, y hoy me gustaría hablarles sobre las lecciones que he aprendido manteniendo TypeScript libraries. Un par de cosas rápidas sobre mí. Actualmente soy un Ingeniero Frontend Senior en Replay, donde estamos construyendo un verdadero depurador de viaje en el tiempo para aplicaciones JavaScript. Si no lo has visto, por favor, échale un vistazo. Soy conocido por varias cosas. Soy un respondedor de preguntas. Con gusto responderé preguntas sobre React y Redux en cualquier lugar donde haya un cuadro de texto en internet. Recojo enlaces interesantes a cualquier cosa que parezca potencialmente útil. Escribo entradas de blog extremadamente largas sobre React y Redux, y soy un mantenedor de Redux. Además, también podrías conocerme como ese tipo con el avatar de los Simpsons.

2. Bibliotecas JavaScript y Soporte TypeScript

Short description:

Hoy vamos a hablar sobre las diferentes formas en que las bibliotecas JavaScript pueden usar y soportar TypeScript, cómo abordar la migración de una biblioteca JavaScript a TypeScript, problemas al tratar con los tipos de biblioteca y la versión, y soportar múltiples versiones de TypeScript también, cómo puedes depurar y probar tipos, cómo abordar el diseño de APIs para usar con TypeScript, y potencialmente algunas características que facilitarían el uso de TypeScript con bibliotecas. Los tipos sirven para varios propósitos, incluyendo la documentación de la API, la corrección del código del usuario, y la corrección del código de la biblioteca. Hay una diferencia distinta entre los tipos de aplicación y los tipos de biblioteca, siendo los tipos de biblioteca más complejos. Las bibliotecas JavaScript pueden proporcionar tipos al estar escritas en TypeScript, escribir a mano las definiciones de tipo para el código JavaScript, o usar tipos comunitarios de Definitely Typed. Las bibliotecas Redux han utilizado todos estos enfoques y han estado migrando a TypeScript. El primer paso en la migración es configurar la infraestructura de construcción y configurar las pruebas.

Hoy vamos a hablar sobre las diferentes formas en que las bibliotecas JavaScript pueden usar y soportar TypeScript, cómo abordar la migración de una biblioteca JavaScript a TypeScript, problemas al tratar con los tipos de biblioteca y la versión, y soportar múltiples versiones de TypeScript también, cómo puedes debug y probar tipos, cómo abordar el diseño de APIs para usar con TypeScript, y potencialmente algunas características que facilitarían el uso de TypeScript con bibliotecas.

Entonces, ¿por qué incluso proporcionamos tipos con una biblioteca? Los tipos sirven para varios propósitos. Uno es la documentación de la API. Los usuarios pueden mirar los tipos y entender qué funciones y tipos existen y cómo puedes usarlos en tu aplicación. Otro es la corrección del código del usuario. Pueden hacer cumplir ciertos patrones de uso que los usuarios deben tener en su aplicación fuente de código. Junto con eso, está la corrección del código de la biblioteca. Los tipos nos ayudan a asegurar que el código dentro de nuestra biblioteca se comporta como se espera, y se trata de mantenibilidad, de poder trabajar en el código real dentro de la biblioteca.

Ahora, diré que creo que hay una diferencia distinta entre los tipos que ves dentro del código de la aplicación y los tipos que ves dentro del código de la biblioteca. Los tipos de aplicación tienden a ser bastante simples. Tienes respuestas de la API, argumentos de funciones, estado con el que estás lidiando, componentes props. Por lo general, no es demasiado complicado, y no ves muchos tipos genéricos allí. Los tipos de biblioteca, por otro lado, son mucho más complicados porque necesitan manejar casos de uso mucho más flexibles. Los tipos de biblioteca tienden a tener un uso mucho más pesado de los genéricos de TypeScript. Y a veces, incluso puedes ver programación a nivel de tipo donde estás haciendo inferencias, lógica condicional, y transformaciones complejas de tipos también.

Ahora, hay varias formas en que una biblioteca JavaScript puede proporcionar tipos. El mejor enfoque es si la biblioteca está realmente escrita en TypeScript. Esto garantiza que los tipos coinciden con el comportamiento real de lo que está en el código fuente de la biblioteca, y que los tipos se actualizan cada vez que hay una nueva versión de la lib. Otra opción es escribir el código fuente en JavaScript y escribir a mano las definiciones de tipo e incluirlas en la salida publicada. Esto está bien porque los tipos todavía son mantenidos por los propios dueños de la biblioteca. Pero puedes terminar en situaciones donde hay diferencias entre lo que los tipos dicen que está en la biblioteca y lo que el código fuente realmente hace. Como último recurso, si los mantenedores de la biblioteca no quieren tener sus propios tipos, entonces la comunidad puede juntar algunos tipos y publicarlos en el repositorio Definitely Typed de Microsoft. Esto puede definitivamente llevar a problemas, pero al menos te da una forma de tener tipos, especialmente si los mantenedores de la biblioteca no quieren preocuparse por tratar con eso ellos mismos. Realmente hemos usado todos estos diferentes enfoques con las bibliotecas Redux a lo largo del tiempo. Pero hemos estado trabajando en tratar de migrar las bibliotecas Redux a TypeScript, especialmente en los últimos años. El núcleo de Redux fue convertido a TypeScript en 2019. Simplemente nunca llegamos a publicarlo. La versión 8 de React Redux finalmente se convirtió a TypeScript, y migramos Reselect el año pasado. Entonces, ¿cómo abordas una de estas migraciones? Bueno, el primer paso es configurar alguna infraestructura de construcción. Necesitas asegurarte de que estás compilando los tipos de TypeScript, transformando la salida de la construcción a JavaScript plano, y quieres asegurarte de que tu configuración de pruebas está configurada para lidiar con TypeScript también.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

Los tipos más útiles de React
React Day Berlin 2023React Day Berlin 2023
21 min
Los tipos más útiles de React
Top Content
Today's Talk focuses on React's best types and JSX. It covers the types of JSX and React components, including React.fc and React.reactnode. The discussion also explores JSX intrinsic elements and react.component props, highlighting their differences and use cases. The Talk concludes with insights on using React.componentType and passing components, as well as utilizing the react.element ref type for external libraries like React-Select.
TypeScript y React: Secretos de un matrimonio feliz
React Advanced Conference 2022React Advanced Conference 2022
21 min
TypeScript y React: Secretos de un matrimonio feliz
Top Content
React and TypeScript have a strong relationship, with TypeScript offering benefits like better type checking and contract enforcement. Failing early and failing hard is important in software development to catch errors and debug effectively. TypeScript provides early detection of errors and ensures data accuracy in components and hooks. It offers superior type safety but can become complex as the codebase grows. Using union types in props can resolve errors and address dependencies. Dynamic communication and type contracts can be achieved through generics. Understanding React's built-in types and hooks like useState and useRef is crucial for leveraging their functionality.
Haciendo Magia: Construyendo un Marco de Trabajo Primero-TypeScript
TypeScript Congress 2023TypeScript Congress 2023
31 min
Haciendo Magia: Construyendo un Marco de Trabajo Primero-TypeScript
Top Content
Daniel Rowe discusses building a TypeScript-first framework at TypeScript Congress and shares his involvement in various projects. Nuxt is a progressive framework built on Vue.js, aiming to reduce friction and distraction for developers. It leverages TypeScript for inference and aims to be the source of truth for projects. Nuxt provides type safety and extensibility through integration with TypeScript. Migrating to TypeScript offers long-term maintenance benefits and can uncover hidden bugs. Nuxt focuses on improving existing tools and finds inspiration in frameworks like TRPC.
Deja de Escribir tus Rutas
Vue.js London 2023Vue.js London 2023
30 min
Deja de Escribir tus Rutas
Designing APIs is a challenge, and it's important to consider the language used and different versions of the API. API ergonomics focus on ease of use and trade-offs. Routing is a misunderstood aspect of API design, and file-based routing can simplify it. Unplugging View Router provides typed routes and eliminates the need to pass routes when creating the router. Data loading and handling can be improved with data loaders and predictable routes. Handling protected routes and index and ID files are also discussed.
Cómo Construir Tu Propio Proyecto de Código Abierto
React Advanced Conference 2022React Advanced Conference 2022
16 min
Cómo Construir Tu Propio Proyecto de Código Abierto
Hello my friend, in this talk, I wanna share with you how to build your own open source project. Building an open source software project can be challenging. I receive a lot of things randomly in a day, like thank you messages for making my life easier, which motivates me. To choose an open source project to work on, pick one you use every day. Your software is being used when people report issues and send pull requests.
Compilaciones de TypeScript más rápidas con --isolatedDeclarations
TypeScript Congress 2023TypeScript Congress 2023
24 min
Compilaciones de TypeScript más rápidas con --isolatedDeclarations
Top Content
This talk discusses the performance issues in TypeScript builds and introduces a new feature called isolated declarations. By running the compiler in parallel and using isolated modules, significant performance gains can be achieved. Isolated declarations improve build speed, compatibility with other tools, and require developers to write types in code. This feature has the potential to further increase performance and may be available in TypeScript soon.

Workshops on related topic

React, TypeScript y TDD
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript y TDD
Top Content
Featured WorkshopFree
Paul Everitt
Paul Everitt
ReactJS es extremadamente popular y, por lo tanto, ampliamente soportado. TypeScript está ganando popularidad y, por lo tanto, cada vez más soportado.

¿Los dos juntos? No tanto. Dado que ambos cambian rápidamente, es difícil encontrar materiales de aprendizaje precisos.

¿React+TypeScript, con los IDEs de JetBrains? Esa combinación de tres partes es el tema de esta serie. Mostraremos un poco sobre mucho. Es decir, los pasos clave para ser productivo, en el IDE, para proyectos de React utilizando TypeScript. En el camino, mostraremos el desarrollo guiado por pruebas y enfatizaremos consejos y trucos en el IDE.
Dominando conceptos avanzados en TypeScript
React Summit US 2023React Summit US 2023
132 min
Dominando conceptos avanzados en TypeScript
Top Content
Featured WorkshopFree
Jiri Lojda
Jiri Lojda
TypeScript no es solo tipos e interfaces. Únete a esta masterclass para dominar características más avanzadas de TypeScript que harán tu código a prueba de balas. Cubriremos tipos condicionales y notación de inferencia, cadenas de plantillas y cómo mapear sobre tipos de unión y propiedades de objetos/arrays. Cada tema se demostrará en una aplicación de muestra que se escribió con tipos básicos o sin tipos en absoluto y juntos mejoraremos el código para que te familiarices más con cada característica y puedas llevar este nuevo conocimiento directamente a tus proyectos.
Aprenderás:- - ¿Qué son los tipos condicionales y la notación de inferencia?- ¿Qué son las cadenas de plantillas?- Cómo mapear sobre tipos de unión y propiedades de objetos/arrays.
Consejos y Trucos Profundos de TypeScript
Node Congress 2024Node Congress 2024
83 min
Consejos y Trucos Profundos de TypeScript
Top Content
Featured Workshop
Josh Goldberg
Josh Goldberg
TypeScript tiene un sistema de tipos poderoso con todo tipo de características sofisticadas para representar estados de JavaScript salvajes y extravagantes. Pero la sintaxis para hacerlo no siempre es sencilla, y los mensajes de error no siempre son precisos al decirte qué está mal. Vamos a profundizar en cómo funcionan muchas de las características más poderosas de TypeScript, qué tipos de problemas del mundo real resuelven, y cómo dominar el sistema de tipos para que puedas escribir código TypeScript verdaderamente excelente.
Mejores Prácticas y Consejos Avanzados de TypeScript para Desarrolladores de React
React Advanced Conference 2022React Advanced Conference 2022
148 min
Mejores Prácticas y Consejos Avanzados de TypeScript para Desarrolladores de React
Top Content
Featured Workshop
Maurice de Beijer
Maurice de Beijer
¿Eres un desarrollador de React tratando de obtener los máximos beneficios de TypeScript? Entonces esta es la masterclass para ti.En esta masterclass interactiva, comenzaremos desde lo básico y examinaremos los pros y contras de las diferentes formas en que puedes declarar componentes de React usando TypeScript. Después de eso, pasaremos a conceptos más avanzados donde iremos más allá de la configuración estricta de TypeScript. Aprenderás cuándo usar tipos como any, unknown y never. Exploraremos el uso de predicados de tipo, guardias y comprobación exhaustiva. Aprenderás sobre los tipos mapeados incorporados, así como cómo crear tus propias utilidades de mapa de tipo nuevo. Y comenzaremos a programar en el sistema de tipos de TypeScript usando tipos condicionales e inferencia de tipos.
Building Your Own Custom Type System
React Summit 2024React Summit 2024
38 min
Building Your Own Custom Type System
Featured Workshop
Kunal Dubey
Kunal Dubey
I'll introduce the audience to a concept where they can have end-to-end type systems that helps ensure typesafety across the teams Such a system not only improves communication between teams but also helps teams collaborate effectively and ship way faster than they used to before. By having a custom type system, teams can also identify the errors and modify the API contracts on their IDE, which contributes to a better Developer Experience. The workshop would primarily leverage TS to showcase the concept and use tools like OpenAPI to generate the typesystem on the client side. 
Frictionless Development With Unified Type System
JSNation 2024JSNation 2024
113 min
Frictionless Development With Unified Type System
Featured Workshop
Ejiro Asiuwhu
Ejiro Asiuwhu
Imagine developing where frontend and backend sing in harmony, types dance in perfect sync, and errors become a distant memory. That's the magic of TypeScript Nirvana!
Join me on a journey to unveil the secrets of unified type definitions, the key to unlocking frictionless development. We'll dive into:
- Shared language, shared love: Define types once, share them everywhere. Consistency becomes your BFF, errors your worst nightmare (one you'll rarely see).- Effortless coding: Ditch the manual grind of type checking. TypeScript's got your back, freeing you to focus on building awesomeness.- Maintainability magic: With crystal-clear types guiding your code, maintaining it becomes a walk in the park. More time innovating, less time debugging.- Security fortress: TypeScript's type system shields your app from common vulnerabilities, making it a fortress against security threats.