Creando mi primera biblioteca de código abierto Vue 3

Rate this content
Bookmark

Aprende cómo crear una biblioteca de Vue.js y qué mejores prácticas debes seguir. También aprenderemos sobre el código abierto y cómo trabajan los mantenedores. Hablaremos sobre xState, la API de composición y estrategias de prueba que incluyen Cypress y Vue test utils!

This talk has been presented at Vue.js London 2023, check out the latest edition of this JavaScript Conference.

FAQ

Los requisitos incluyeron asegurar la accesibilidad cumpliendo con WCAG 2.1 AA, mantener un tamaño de paquete pequeño, y la reutilización de código entre Vue, React y Angular. Además, era fundamental que el proyecto fuera probado y utilizara buenas prácticas de Vue 3.

XState fue elegido porque proporciona una gestión de estado basada en máquinas de estados finitos que puede integrarse fácilmente en Vue, React y Angular, permitiendo compartir lógica de estado de manera eficiente.

Se utilizó un enfoque de desarrollo impulsado por la documentación, documentando características antes de implementarlas y validando con pruebas de extremo a extremo usando Cypress y Cucumber. Esto aseguró que la documentación y las características implementadas fueran correctas y funcionales.

Se crearon horas de oficina en Discord para interacción directa, se hicieron lanzamientos etiquetados en GitHub para pruebas de desarrolladores y se mantuvo el código fuente completamente abierto desde el inicio para fomentar la participación de la comunidad.

Se aprendió la importancia de las pruebas de extremo a extremo para detectar problemas temprano, el beneficio de TypeScript para acelerar el desarrollo y la necesidad de equilibrar entre pruebas unitarias y de extremo a extremo para una cobertura de prueba más eficaz.

Se reescribió el componente Authenticator utilizando librerías nativas para cada framework (Vue, React, Angular), asegurando que el aspecto y funcionamiento fueran idénticos en todas las plataformas, y se redujo el número de dependencias externas para optimizar el tamaño del paquete.

Es crucial pensar en la API que usarás, como Options API o Composition API, y en el método de construcción, como Vue CLI o Vite. También debes decidir entre usar JavaScript o TypeScript y considerar la compatibilidad con otros frameworks mediante JSX.

Erik Hanchett
Erik Hanchett
27 min
15 May, 2023

Comments

Sign in or register to post your comment.
Video Summary and Transcription
Hablemos sobre Vue 3 y la creación de tu primera biblioteca de código abierto. Discutiremos las elecciones de diseño, un ejemplo personal de la creación de una biblioteca de código abierto Vue 3, la comunidad y el código abierto, lecciones aprendidas y puntos clave para crear un proyecto de código abierto. También cubriremos la construcción de una biblioteca Vue 3, el proyecto Authenticator y sus requisitos, compartir código y mejores prácticas, el uso de Xstate para la gestión del estado, las mejores prácticas de Vue 3, estrategias de prueba, la apertura del código y la retroalimentación de la comunidad, el desarrollo basado en documentación, desafíos y mejoras, y el plan de trabajo para el futuro.

1. Introducción a Vue 3 y Open Source

Short description:

Hablemos de Vue 3 y de cómo crear tu primera biblioteca de código abierto. Discutiremos las elecciones de diseño, un ejemplo personal de creación de una biblioteca de código abierto en Vue 3, la comunidad y el código abierto, lecciones aprendidas y conclusiones clave para crear un proyecto de código abierto.

Hablemos de Vue 3 y de cómo crear tu primera biblioteca de código abierto. Así que hay algunos objetivos que quiero tener para esta charla hoy. Vamos a hablar de las elecciones de diseño y los requisitos, y voy a hablar de un ejemplo personal de cómo creé una biblioteca de código abierto en Vue 3 en los últimos años. Vamos a hablar de la comunidad y el código abierto y cómo lidiar con eso. Vamos a ver algunas lecciones aprendidas que he tenido a lo largo de todo este proceso, cosas que hubiera hecho de manera diferente y cosas que salieron muy bien. Y luego tendré una conclusión y algunas cosas que puedes tener en cuenta si vas a crear un proyecto de código abierto.

2. Building a Vue 3 Library

Short description:

Pensemos en cómo construir una biblioteca de Vue 3. Hay varias formas de construir aplicaciones modernas de Vue 3, como Vue CLI y Vite. Puedes elegir entre JavaScript o TypeScript, Options API o Composition API, y Pina o XState. Aunque Vue 3 a menudo utiliza plantillas, puedes usar JSX en una biblioteca de código abierto. Tomar las decisiones correctas no siempre es obvio y requiere compromisos.

Así que hagamos un pequeño experimento mental antes de seguir adelante. Imaginemos que quieres crear una biblioteca de Vue 3. Digamos que estás en un equipo, tienes algunas utilidades, tienes algo que quieres abrir y poner en el mundo para que cualquiera pueda contribuir. ¿En qué cosas debes pensar al crear esta biblioteca de código abierto? ¿Y qué cosas debes tener en cuenta? Básicamente, pensemos en cómo deberías construirla.

Hay algunas formas de construir aplicaciones modernas de Vue 3 hoy en día. Tenemos Vue CLI, aunque no se recomienda, pero puedes usarlo. Y está Vite. Hay JavaScript o TypeScript. Hay Options API o Composition API. Hay Pina o XState. Y luego está JSX. Una cosa a tener en cuenta es que aunque estés usando Vue 3, que a menudo utiliza estas plantillas, puedes, ya que estás utilizando una biblioteca de código abierto, usar algo como JSX. Porque mucha otra gente conoce JSX si vienes de React u otro framework que lo utiliza, es bastante popular. E incluso Vue.ify lo utiliza en su biblioteca de código abierto. Así que tienes que tomar algunas de estas decisiones. Al final del día, la respuesta correcta no siempre es obvia. No siempre es obvio cuál es lo correcto o lo incorrecto, y tienes que hacer algunos compromisos, y puede que no sea exactamente la respuesta correcta al final del día.

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

Todo Más Allá de la Gestión de Estado en Tiendas con Pinia
Vue.js London Live 2021Vue.js London Live 2021
34 min
Todo Más Allá de la Gestión de Estado en Tiendas con Pinia
Top Content
State management is not limited to complex applications and transitioning to a store offers significant benefits. Pinia is a centralized state management solution compatible with Vue 2 and Vue 3, providing advanced devtools support and extensibility with plugins. The core API of Pinia is similar to Vuex, but with a less verbose version of stores and powerful plugins. Pinia allows for easy state inspection, error handling, and testing. It is recommended to create one file per store for better organization and Pinia offers a more efficient performance compared to V-rex.
Bienvenido a Nuxt 3
Vue.js London Live 2021Vue.js London Live 2021
29 min
Bienvenido a Nuxt 3
Top Content
Nux3 has made significant improvements in performance, output optimization, and serverless support. Nuxt Bridge brings the Nitro engine for enhanced performance and easier transition between Nuxt 2 and Nuxt Read. Nuxt 3 supports Webpack 5, Bytes, and Vue 3. NextLab has developed brand new websites using Docus technology. Nuxt.js is recommended for building apps faster and simpler, and Nuxt 2 should be used before migrating to Nuxt 3 for stability. DOCUS is a new project that combines Nuxt with additional features like content modules and an admin panel.
Un Año en Vue 3
Vue.js London Live 2021Vue.js London Live 2021
20 min
Un Año en Vue 3
Top Content
Vue 3 has seen significant adoption and improvements in performance, bundle size, architecture, and TypeScript integration. The ecosystem around Vue 3 is catching up, with new tools and frameworks being developed. The Vue.js.org documentation is undergoing a complete overhaul. PNIA is emerging as the go-to state management solution for Vue 3. The options API and composition API are both viable options in Vue 3, with the choice depending on factors such as complexity and familiarity with TypeScript. Vue 3 continues to support CDN installation and is recommended for new projects.
Utilizando Rust desde Vue con WebAssembly
Vue.js London Live 2021Vue.js London Live 2021
8 min
Utilizando Rust desde Vue con WebAssembly
Top Content
In this Talk, the speaker demonstrates how to use Rust with WebAssembly in a Vue.js project. They explain that WebAssembly is a binary format that allows for high-performance code and less memory usage in the browser. The speaker shows how to build a Rust example using the WasmPack tool and integrate it into a Vue template. They also demonstrate how to call Rust code from a Vue component and deploy the resulting package to npm for easy sharing and consumption.
Vue: Actualizaciones de Características
Vue.js London 2023Vue.js London 2023
44 min
Vue: Actualizaciones de Características
Top Content
The Talk discusses the recent feature updates in Vue 3.3, focusing on script setup and TypeScript support. It covers improvements in defining props using imported types and complex types support. The introduction of generic components and reworked signatures for defined components provides more flexibility and better type support. Other features include automatic inference of runtime props, improved define emits and defined slots, and experimental features like reactive props destructure and define model. The Talk also mentions future plans for Vue, including stabilizing suspense and enhancing computer invalidations.
Estado Local y Caché del Servidor: Encontrando un Equilibrio
Vue.js London Live 2021Vue.js London Live 2021
24 min
Estado Local y Caché del Servidor: Encontrando un Equilibrio
Top Content
This Talk discusses handling local state in software development, particularly when dealing with asynchronous behavior and API requests. It explores the challenges of managing global state and the need for actions when handling server data. The Talk also highlights the issue of fetching data not in Vuex and the challenges of keeping data up-to-date in Vuex. It mentions alternative tools like Apollo Client and React Query for handling local state. The Talk concludes with a discussion on GitLab going public and the celebration that followed.

Workshops on related topic

Vue3: Desarrollo Moderno de Aplicaciones Frontend
Vue.js London Live 2021Vue.js London Live 2021
169 min
Vue3: Desarrollo Moderno de Aplicaciones Frontend
Top Content
Featured WorkshopFree
Mikhail Kuznetsov
Mikhail Kuznetsov
Vue3 fue lanzado a mediados de 2020. Además de muchas mejoras y optimizaciones, la principal característica que trae Vue3 es la API de Composición, una nueva forma de escribir y reutilizar código reactivo. Aprendamos más sobre cómo usar la API de Composición de manera eficiente.

Además de las características principales de Vue3, explicaremos ejemplos de cómo usar bibliotecas populares con Vue3.

Tabla de contenidos:
- Introducción a Vue3
- API de Composición
- Bibliotecas principales
- Ecosistema Vue3

Requisitos previos:
IDE de elección (Inellij o VSC) instalado
Nodejs + NPM
Monitoreo 101 para Desarrolladores de React
React Summit US 2023React Summit US 2023
107 min
Monitoreo 101 para Desarrolladores de React
Top Content
WorkshopFree
Lazar Nikolov
Sarah Guthals
2 authors
Si encontrar errores en tu proyecto frontend es como buscar una aguja en un pajar de código, entonces el monitoreo de errores de Sentry puede ser tu detector de metales. Aprende los conceptos básicos del monitoreo de errores con Sentry. Ya sea que estés ejecutando un proyecto de React, Angular, Vue, o simplemente JavaScript “vainilla”, mira cómo Sentry puede ayudarte a encontrar el quién, qué, cuándo y dónde detrás de los errores en tu proyecto frontend.
Nivel de la masterclass: Intermedio
Usando Nitro - Construyendo una Aplicación con el Último Motor de Renderizado de Nuxt
Vue.js London Live 2021Vue.js London Live 2021
117 min
Usando Nitro - Construyendo una Aplicación con el Último Motor de Renderizado de Nuxt
Top Content
Workshop
Daniel Roe
Daniel Roe
Construiremos un proyecto Nuxt juntos desde cero usando Nitro, el nuevo motor de renderizado de Nuxt, y Nuxt Bridge. Exploraremos algunas de las formas en que puedes usar y desplegar Nitro, mientras construimos una aplicación juntos con algunas de las restricciones del mundo real que enfrentarías al desplegar una aplicación para tu empresa. En el camino, dispara tus preguntas hacia mí y haré lo mejor para responderlas.
Práctica con la Rejilla de Datos React de AG Grid
React Summit 2022React Summit 2022
147 min
Práctica con la Rejilla de Datos React de AG Grid
Top Content
WorkshopFree
Sean Landsman
Sean Landsman
Comienza con la Rejilla de Datos React de AG Grid con un tutorial práctico del equipo central que te llevará a través de los pasos para crear tu primera rejilla, incluyendo cómo configurar la rejilla con propiedades simples y componentes personalizados. La edición comunitaria de AG Grid es completamente gratuita para usar en aplicaciones comerciales, por lo que aprenderás una herramienta poderosa que puedes agregar inmediatamente a tus proyectos. También descubrirás cómo cargar datos en la rejilla y diferentes formas de agregar renderizado personalizado a la rejilla. Al final de la masterclass, habrás creado una Rejilla de Datos React de AG Grid y personalizado con componentes React funcionales.- Comenzando e instalando AG Grid- Configurando ordenación, filtrado, paginación- Cargando datos en la rejilla- La API de la rejilla- Usando hooks y componentes funcionales con AG Grid- Capacidades de la edición comunitaria gratuita de AG Grid- Personalizando la rejilla con Componentes React
Construyendo APIs GraphQL sobre Ethereum con The Graph
GraphQL Galaxy 2021GraphQL Galaxy 2021
48 min
Construyendo APIs GraphQL sobre Ethereum con The Graph
WorkshopFree
Nader Dabit
Nader Dabit
The Graph es un protocolo de indexación para consultar redes como Ethereum, IPFS y otras blockchains. Cualquiera puede construir y publicar APIs abiertas, llamadas subgrafos, para hacer que los datos sean fácilmente accesibles.

En este masterclass aprenderás cómo construir un subgrafo que indexa datos de blockchain de NFT del contrato inteligente Foundation. Desplegaremos la API y aprenderemos cómo realizar consultas para recuperar datos utilizando diferentes tipos de patrones de acceso a datos, implementando filtros y ordenamiento.

Al final del masterclass, deberías entender cómo construir y desplegar APIs de alto rendimiento en The Graph para indexar datos de cualquier contrato inteligente desplegado en Ethereum.
Embarcándonos en una aventura con Nuxt 3, Motion UI y Azure
JSNation 2022JSNation 2022
141 min
Embarcándonos en una aventura con Nuxt 3, Motion UI y Azure
WorkshopFree
Melanie de Leeuw
Melanie de Leeuw
¡Nos encantan las aplicaciones web fáciles de crear y desplegar! Entonces, veamos qué puede hacer una pila tecnológica muy actual como Nuxt 3, Motion UI y Azure Static Web Apps. Podría ser perfectamente un trío de oro en el desarrollo web moderno. O podría ser una hoguera de errores y problemas. De cualquier manera, será una aventura de aprendizaje para todos nosotros. Nuxt 3 se lanzó hace apenas unos meses y no podemos esperar más para explorar sus nuevas características, como su compatibilidad con Vue 3 y el Motor Nitro. Agregamos un poco de estilo a nuestra aplicación con la biblioteca Sass Motion UI, porque el diseño estático está pasado de moda y las animaciones vuelven a estar de moda.Nuestra fuerza impulsora de la pila será Azure. Las aplicaciones web estáticas de Azure son nuevas, casi listas para producción y una forma ingeniosa y rápida para que los desarrolladores desplieguen sus sitios web. Así que, por supuesto, debemos probar esto.Con algunas Azure Functions esparcidas por encima, exploraremos lo que puede hacer el desarrollo web en 2022.