Cómo hacer nuestros CLIs más seguros con tipos

Rate this content
Bookmark

En esta charla, exploraremos los diversos problemas encontrados al construir CLIs en JavaScript, y demostraremos cómo TypeScript puede abordarlos y ayudarnos a hacer nuestras aplicaciones más seguras.

Al final de esta charla, comprenderás cómo abstraer las validaciones en tiempo de ejecución detrás de interfaces fáciles de usar, y tendrás todas las herramientas que necesitas para llevar esos beneficios a tus propios CLIs a un costo mínimo, ya sean proyectos de código abierto o herramientas internas.

Maël Nison
Maël Nison
29 min
21 Sep, 2023

Comments

Sign in or register to post your comment.

Video Summary and Transcription

Esta charla explora los desafíos de construir CLIs e introduce un framework de CLI completamente tipado construido con TypeScript. Se discuten las complejidades y dificultades de la implementación de CLIs y los beneficios de usar decoradores para metadatos y lógica. La charla también aborda los desafíos de inferencia de tipos y presenta una tercera forma de asignar anotaciones como decoradores. Se destaca la integración de Tpanion, Zod y ClipAnion para la verificación de tipos y validación de formato. Por último, se mencionan otros frameworks de CLI como ClipAllian, Common.js y Oclif que ofrecen funcionalidades similares.

Available in English

1. Introducción a la Charla

Short description:

Bienvenidos a esta charla sobre cómo hacer nuestro CLI más seguro con TypeScript. Discutiremos los problemas que enfrentamos al construir CLIs, las técnicas en TypeScript para una mejor inferencia y los frameworks existentes. ¡Comencemos!

Hola a todos, y bienvenidos a esta charla sobre cómo hacer nuestro CLI más seguro con TypeScript. Mi nombre es Mayr Neonaysan. Trabajo en Datadog como parte del equipo de desarrollo front-end, donde estamos construyendo todo tipo de herramientas para asegurarnos de que nuestros ingenieros front-end puedan ser tan eficientes como deseen ser. Puedes encontrarme en Twitter y GitHub como Arkalis, y sí, espero verte allí.

Entonces, primero, sobre esta charla, la vamos a dividir en cuatro partes diferentes. Primero, vamos a hablar sobre qué son los CLIs, cuáles son los problemas que enfrentamos al construir ellos. Luego vamos a ver algunas técnicas que podemos usar en TypeScript para hacer una mejor inferencia sobre el tipo de las opciones. Y finalmente, vamos a repasar algunos de los frameworks que ya hacen eso por nosotros antes de llegar a una conclusión y recapitular todo lo que aprendimos. ¿Suena bien? Entonces, primero, ¿cuáles son los problemas que enfrentamos al construir CLIs? ¿Qué son los CLIs? En su esencia, son solo un conjunto de palabras separadas por espacios.

2. Complejidades de los CLIs y el CLI de Yarn

Short description:

Los CLIs son simples y útiles para parametrizar acciones. Sin embargo, pueden ser complicados, como al usar npm run eslint ____ versión o el comando cp con argumentos al principio. El CLI de Yarn es uno de los más grandes en el ecosistema de JavaScript y tiene comportamientos específicos. Inicialmente se utilizó Commander JS, pero hicimos que la palabra clave run y el token dash dash fueran opcionales, lo que requirió una implementación adicional.

Son muy simples de leer y muy simples de implementar por lo general. Los utilizamos para parametrizar acciones, que pueden ser tan complicadas como una aplicación CLI completa como YARN, o algo mucho más simple como un script que estás utilizando dentro de tu pipeline de construcción. Lo que tienen en común es que suelen ser muy simples. En comparación con las aplicaciones de UI completas, requieren muy pocas plantillas, lo que los hace muy útiles si solo estás tratando de hacer que un par de comportamientos sean configurables.

Sin embargo, también pueden ser complicados. Por ejemplo, tomemos npm run eslint ____ versión. Si no usas el token ____ para separar eslint y el token de versión, terminarás ejecutando la opción de versión en npm mismo y no en eslint. Sin embargo, si estás ejecutando YARN, no tienes que usar este token ____. Pero para hacer eso, como veremos más adelante, las cosas comienzan a complicarse.

El comando cp parece simple. Sin embargo, a diferencia de muchos comandos donde la cantidad de parámetros o argumentos variádicos está al final del comando, en el caso de cp, está al principio del comando. Tienes slc1, slc2, cualquier número de otras fuentes, pero debes tener un destino al final. Por lo tanto, la posición requerida de los argumentos está al final en lugar de al principio. Tienes el comando arm que tiene la opción preserve-root, pero también tiene la opción "-no-preserve-root". Y si estás implementando algo como esto en tus scripts, generalmente quieres declarar ambas opciones en una sola, para no tener que duplicarlas. Y finalmente, tomemos el caso de vlc-v. Si miras este comando y no sabes nada más al respecto, pensarías que "-v" es en realidad una bandera booleana. Pero no lo es. Si ejecutas vlc-vvv, no obtendrás el mismo comportamiento que si estuvieras ejecutando vlc-v. Porque vvv es en realidad un contador. Cuenta la cantidad de veces que lo pasas al comando.

Ahora, hablemos del CLI de Yarn en sí. Es muy interesante, porque el CLI de Yarn es una de las interfaces de CLI más grandes que todos usamos en el ecosistema de JavaScript. Cada uno tiene más de veinte comandos, y cada uno de ellos acepta opciones, y tenemos algunos comportamientos muy específicos como vimos anteriormente. Al principio, se comenzó a utilizar Commander JS, que es un framework de CLI para JavaScript que admite subcomandos, y eso es algo muy importante para Yarn, porque Yarn add, Yarn remove, Yarn upgrade interactúan contigo, todas esas cosas son comandos de la aplicación principal. Sin embargo, decidimos eventualmente hacer que la palabra clave run fuera opcional, para que pudieras ejecutar Yarn eslint en lugar de Yarn run-eslint, y eso no era algo que Commander JS admitiera de forma nativa. Así que tuvimos que implementar nuestro propio código para admitir eso. Luego, más adelante, decidimos también hacer que el token dash dash fuera opcional, para que si ejecutas Yarn eslint dash dash versión, entonces la versión de dash dash se aplique a eslint y no a Yarn mismo. Eso es muy útil. Sin embargo, requirió implementar algo más encima de Commander JS.

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

TypeScript and React: Secrets of a Happy Marriage
React Advanced Conference 2022React Advanced Conference 2022
21 min
TypeScript and React: Secrets of a Happy Marriage
Top Content
TypeScript and React are inseparable. What's the secret to their successful union? Quite a lot of surprisingly strange code. Learn why useRef always feels weird, how to wrangle generics in custom hooks, and how union types can transform your components.
React's Most Useful Types
React Day Berlin 2023React Day Berlin 2023
21 min
React's Most Useful Types
Top Content
We don't think of React as shipping its own types. But React's types are a core part of the framework - overseen by the React team, and co-ordinated with React's major releases.In this live coding talk, we'll look at all the types you've been missing out on. How do you get the props type from a component? How do you know what ref a component takes? Should you use React.FC? And what's the deal with JSX.Element?You'll walk away with a bunch of exciting ideas to take to your React applications, and hopefully a new appreciation for the wonders of React and TypeScript working together.
Stop Writing Your Routes
Vue.js London 2023Vue.js London 2023
30 min
Stop Writing Your Routes
The more you keep working on an application, the more complicated its routing becomes, and the easier it is to make a mistake. ""Was the route named users or was it user?"", ""Did it have an id param or was it userId?"". If only TypeScript could tell you what are the possible names and params. If only you didn't have to write a single route anymore and let a plugin do it for you. In this talk we will go through what it took to bring automatically typed routes for Vue Router.
Making Magic: Building a TypeScript-First Framework
TypeScript Congress 2023TypeScript Congress 2023
31 min
Making Magic: Building a TypeScript-First Framework
I'll dive into the internals of Nuxt to describe how we've built a TypeScript-first framework that is deeply integrated with the user's IDE and type checking setup to offer end-to-end full-stack type safety, hints for layouts, middleware and more, typed runtime configuration options and even typed routing. Plus, I'll highlight what I'm most excited about doing in the days to come and how TypeScript makes that possible not just for us but for any library author.
Full-stack & typesafe React (+Native) apps with tRPC.io
React Advanced Conference 2021React Advanced Conference 2021
6 min
Full-stack & typesafe React (+Native) apps with tRPC.io
Top Content
Why are we devs so obsessed with decoupling things that are coupled nature? tRPC is a library that replaces the need for GraphQL or REST for internal APIs. When using it, you simply write backend functions whose input and output shapes are instantly inferred in your frontend without any code generation; making writing API schemas a thing of the past. It's lightweight, not tied to React, HTTP-cacheable, and can be incrementally adopted. In this talk, I'll give a glimpse of the DX you can get from tRPC and how (and why) to get started.
Faster TypeScript builds with --isolatedDeclarations
TypeScript Congress 2023TypeScript Congress 2023
24 min
Faster TypeScript builds with --isolatedDeclarations
Top Content
Type-checking a TypeScript codebase can be slow, especially for monorepos containing lots of projects that each need to use the type checker to generate type declaration files. In this talk, we introduce — for the very first time — a new TypeScript feature we are working on called “Isolated Declarations” that allows DTS files to be generated without using the type checker at all! This opens the door to faster declaration generation in TypeScript itself, as well as in external tools written in other languages such as ESBuild and swc. You'll see how to use this new option, and maybe (just maybe) you’ll be convinced about the benefits of explicit return types! Most importantly, we will show how Isolated Declarations enables parallel builds to spread work across your CPU cores to significantly improve the build speed of your TypeScript projects.

Workshops on related topic

React, TypeScript, and TDD
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Top Content
Featured WorkshopFree
Paul Everitt
Paul Everitt
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
Best Practices and Advanced TypeScript Tips for React Developers
React Advanced Conference 2022React Advanced Conference 2022
148 min
Best Practices and Advanced TypeScript Tips for React Developers
Top Content
Featured Workshop
Maurice de Beijer
Maurice de Beijer
Are you a React developer trying to get the most benefits from TypeScript? Then this is the workshop for you.In this interactive workshop, we will start at the basics and examine the pros and cons of different ways you can declare React components using TypeScript. After that we will move to more advanced concepts where we will go beyond the strict setting of TypeScript. You will learn when to use types like any, unknown and never. We will explore the use of type predicates, guards and exhaustive checking. You will learn about the built-in mapped types as well as how to create your own new type map utilities. And we will start programming in the TypeScript type system using conditional types and type inferring.
Deep TypeScript Tips & Tricks
Node Congress 2024Node Congress 2024
83 min
Deep TypeScript Tips & Tricks
Top Content
Workshop
Josh Goldberg
Josh Goldberg
TypeScript has a powerful type system with all sorts of fancy features for representing wild and wacky JavaScript states. But the syntax to do so isn't always straightforward, and the error messages aren't always precise in telling you what's wrong. Let's dive into how many of TypeScript's more powerful features really work, what kinds of real-world problems they solve, and how to wrestle the type system into submission so you can write truly excellent TypeScript code.
Practice TypeScript Techniques Building React Server Components App
TypeScript Congress 2023TypeScript Congress 2023
131 min
Practice TypeScript Techniques Building React Server Components App
Workshop
Maurice de Beijer
Maurice de Beijer
In this hands-on workshop, Maurice will personally guide you through a series of exercises designed to empower you with a deep understanding of React Server Components and the power of TypeScript. Discover how to optimize your applications, improve performance, and unlock new possibilities.
 
During the workshop, you will:
- Maximize code maintainability and scalability with advanced TypeScript practices
- Unleash the performance benefits of React Server Components, surpassing traditional approaches
- Turbocharge your TypeScript with the power of Mapped Types
- Make your TypeScript types more secure with Opaque Types
- Explore the power of Template Literal Types when using Mapped Types
 
Maurice will virtually be by your side, offering comprehensive guidance and answering your questions as you navigate each exercise. By the end of the workshop, you'll have mastered React Server Components, armed with a newfound arsenal of TypeScript knowledge to supercharge your React applications.
 
Don't miss this opportunity to elevate your React expertise to new heights. Join our workshop and unlock the potential of React Server Components with TypeScript. Your apps will thank you.
Advanced TypeScript types for fun and reliability
TypeScript Congress 2022TypeScript Congress 2022
116 min
Advanced TypeScript types for fun and reliability
Workshop
Maurice de Beijer
Maurice de Beijer
If you're looking to get the most out of TypeScript, this workshop is for you! In this interactive workshop, we will explore the use of advanced types to improve the safety and predictability of your TypeScript code. You will learn when to use types like unknown or never. We will explore the use of type predicates, guards and exhaustive checking to make your TypeScript code more reliable both at compile and run-time. You will learn about the built-in mapped types as well as how to create your own new type map utilities. And we will start programming in the TypeScript type system using conditional types and type inferring.
Are you familiar with the basics of TypeScript and want to dive deeper? Then please join me with your laptop in this advanced and interactive workshop to learn all these topics and more.
You can find the slides, with links, here: http://theproblemsolver.nl/docs/ts-advanced-workshop.pdf
And the repository we will be using is here: https://github.com/mauricedb/ts-advanced
Mastering Node.js Test Runner
TestJS Summit 2023TestJS Summit 2023
78 min
Mastering Node.js Test Runner
Workshop
Marco Ippolito
Marco Ippolito
Node.js test runner is modern, fast, and doesn't require additional libraries, but understanding and using it well can be tricky. You will learn how to use Node.js test runner to its full potential. We'll show you how it compares to other tools, how to set it up, and how to run your tests effectively. During the workshop, we'll do exercises to help you get comfortable with filtering, using native assertions, running tests in parallel, using CLI, and more. We'll also talk about working with TypeScript, making custom reports, and code coverage.