Presentando React View

¿Cómo funciona ReactJS? ReactJS es un lenguaje de JavaScript que utiliza tanto Python como Python. Es un lenguaje basado en JavaScript que se puede utilizar para escribir JavaScript para cualquier lenguaje. Es un marco que te permite escribir JavaScript en un marco existente. ReactJS te permite usar ReactJS de muchas formas.

¿Cómo funciona ReactJS? Hola, mi nombre es Wojciech Miksiu y hoy hablaré sobre la documentación. Mi trabajo consiste en construir una biblioteca de componentes de React llamada baseweb y otras herramientas web en Uber. Baseweb es una implementación de nuestro sistema de diseño y lo utilizamos en todas las aplicaciones. Así que hablemos de la documentación. Es algo que la mayoría de nosotros usamos todos los días y es absolutamente esencial. Todos los días estamos sentados en nuestros escritorios tratando de aprender cosas leyendo y solo a veces nos detenemos a escribir unas pocas líneas de código. Y hay muchas fuentes diferentes de documentación. Tenemos libros, MDN, Stack Overflow, comentarios en el código o simplemente buscamos cosas al azar hasta que nos rendimos y preguntamos a nuestros colegas en Slack.

Pero, ¿cuál es mi verdadera motivación para hablar de esto hoy? Me uní a la empresa hace dos años y esta fue la propuesta que me hicieron. Únete a nosotros. Estarás construyendo componentes de React. Eso sonaba increíble y me convencieron de inmediato. Sin embargo, la realidad del trabajo orientado a la plataforma es ligeramente diferente. Se parece más a este gráfico. Y francamente, es algo bueno. Si nadie usa tus cosas, significa que si nadie te hace preguntas, significa que nadie usa tus cosas y sería terrible. Así que se podría decir que mi equipo se convirtió en víctima de su propio éxito. Cuando comenzamos BaseWeb hace dos años, apenas se usaba y teníamos mucho tiempo para simplemente escribir código, pero luego el uso aumentó. Ahora hay más de 600 aplicaciones solo en Uber y eso se traduce en casi mil desarrolladores. Además, nuestra biblioteca tiene una gran superficie de API. Hay más de 60 componentes, cientos de preparativos y prácticamente infinitas posibilidades. También tenemos muchos colaboradores y usuarios externos. Por lo tanto, naturalmente, pasamos mucho tiempo brindando soporte. La pregunta era, ¿podemos recuperar algo de este tiempo? Creo firmemente que si construimos una documentación increíble, podemos reducir significativamente la cantidad de preguntas en nuestros chats y problemas de GitHub. Además, realizamos encuestas frecuentes. Y la documentación siempre es el tema más mencionado.

Entonces, mi equipo ahora invierte mucho tiempo en experimentar con diferentes tipos de documentación. Espero que hasta ahora haya dejado claro por qué la documentación es tan importante. Aquí está la agenda de la charla. Te mostraré algunas versiones antiguas de nuestro sitio web de documentación y explicaré por qué no era lo suficientemente bueno. Luego, lo que construimos con React y usamos hoy. También voy a echar un vistazo bajo el capó y mostrarte algunos conceptos y código relacionados con los compiladores y los árboles de sintaxis abstracta. Y finalmente, la conclusión. Esta es la versión más antigua de nuestra documentación, es simplemente storybook. Es una solución lista para usar que usamos para desarrollar nuestros componentes, pero también para documentarlos. Puedes ver que es simplemente un montón de ejemplos, y en la parte inferior puedes ver el archivo de lectura donde documentamos nuestras propiedades. Pero a medida que crecimos en número de componentes, queríamos tener algo más estructurado y personalizado. Así que lanzamos nuestro propio sitio web personalizado basado en Next.js y MDX. Ahora los componentes están en diferentes categorías, la página en sí está más estructurada. Cada ejemplo tiene su propio código fuente que se escribe manualmente, y en la parte inferior tenemos una documentación de propiedades generada en función de los tipos estáticos. Y esto funciona bastante bien, hasta que deja de hacerlo. Algunos tipos estáticos son demasiado complicados y no son realmente legibles para los humanos. Además, muchas propiedades están destinadas a ser utilizadas solo internamente, cuando se componen con otros componentes. Pero ahora las exponemos en la API pública, y eso solo confunde. Intentamos ajustar esto muchas, muchas veces, pero nunca fue confiable y no fue suficiente como fuente principal de documentación. Los desarrolladores siempre pueden darse cuenta cuando algo está generado automáticamente, y no les encantará precisamente. ¿Por qué deberían hacer un esfuerzo adicional para leerlo, si tú no hiciste ningún esfuerzo para crearlo? Entonces, ¿qué tal agregar muchos ejemplos? ¿A quién no le gustan más ejemplos? Este es nuestro componente técnico. Es bastante simple, y sin embargo, hay 384 permutaciones diferentes de él. ¿Podemos mostrar 384 ejemplos en una sola página? Claro. ¿Será abrumador? Absolutamente. Y lo mismo ocurre con otros componentes. Si hay un número limitado de ejemplos que podemos presentar para no abrumar a nuestros usuarios, ¿qué más podemos hacer? Bueno, vamos a desactivar y explorar estas permutaciones. Permíteme mostrarte lo que construimos.

Entonces, esto es como un espacio de juego que construimos para nuestros componentes. En primer lugar, quieres mostrar el propio componente. La segunda parte más importante es probablemente el propio código fuente.

Lo bueno del código fuente es que puedes editarlo en tiempo real. Y a medida que escribes, el componente cambia. Si cometes un error de sintaxis, simplemente te decimos qué está mal. También agregamos esta función donde puedes pasar el cursor sobre diferentes componentes y ver sus tipos estáticos. Esta es una característica bastante común en muchas documentaciones.

¿Alguna vez te has preguntado cómo funciona esto en tu navegador? Hay una API útil para crear funciones de JavaScript a partir de cadenas. El primer argumento son los parámetros de la nueva función seguidos del cuerpo. A diferencia de una función val, esto se ejecuta solo con un alcance global. Entonces, todo lo que quieras pasar y usar en esta función, debes pasarlo como argumento.

Ahora podemos ejecutar dinámicamente cualquier JavaScript desde una cadena. Pero, ¿qué pasa si no tratamos solo con JavaScript plano? En realidad, casi nunca lo hacemos. Todos nuestros componentes usan JSX. Probablemente hayas visto qué sucede si intentas ejecutar JSX en tu navegador. Obtienes un error de sintaxis sobre un token inesperado. Realmente no podemos pedirle a las personas que escriban React, createElement en lugar de JSX. Entonces, necesitamos introducir un paso adicional, un proceso adicional. Necesitamos agregar un compilador. ¿Recuerdas a Babel? La mayoría de nosotros lo usamos cuando necesitamos compilar nuestras aplicaciones. Pero también podemos usarlo en nuestro navegador para compilar nuestro JSX en React, createElement. Usamos la función de transformación de Babel core. Cargamos el preset de React. Le pasamos nuestro componente. Y devuelve la llamada a React createElement. Así que esto funciona bastante bien. Ahora tenemos el componente. Tenemos el código fuente interactivo. Permíteme también editar algunas funciones convenientes. Por ejemplo, a los desarrolladores les gusta formatear su código para que sea más legible antes de copiarlo y pegarlo. Puedes copiar el código en el portapapeles. Puedes obtener un enlace permanente.

Puedes volver al estado inicial. Y también puedes iniciar CodeSandbox y hacer ediciones más serias, si lo deseas. Esto es genial, pero a veces ni siquiera sabes qué otras props puedes usar para este componente. Entonces, necesitas algún tipo de API de props o documentación de props.

Agregamos esta parte adicional que llamamos NAPs. Cada prop está representada por un solo NAP, y también puedes interactuar con él. A medida que cambio este valor, puedes ver que se actualiza el componente en sí. Pero lo más importante, también se actualiza el código fuente. Este estado se sincroniza en todas estas tres partes. Y aún mejor, por ejemplo, si cambio este tipo a secundario, puedes ver que incluso cambia la importación. Entonces, esto es algo que siempre puedes copiar y pegar en tu aplicación y obtener este componente exacto en este estado exacto.

No solo puedo interactuar con estos NAPs, también puedo seguir cambiando el código fuente en sí. Y puedes ver que, nuevamente, se actualiza el estado aquí, por lo que esta casilla de verificación ahora está marcada y el componente está en estado de carga. ¿Cómo funciona esto? En primer lugar, debemos describir de alguna manera qué propiedades tiene nuestro botón. Podemos renderizar los NAPs. Hemos creado un formato de configuración simple. Aquí tienes un ejemplo. Para cada prop, puedes establecer el nombre, el tipo y la descripción.

Y, cuando actualizamos el código, ahora necesitamos extraer algunas partes de información de él. Necesitamos los nombres y valores de las props para poder mostrarlos en nuestros NAPs. La primera solución rápida sería usar una expresión regular, como aquí. Aquí estamos buscando un elemento JSX y obteniendo las partes con props e hijos. Funciona, pero es extremadamente frágil. ¿Qué pasa si tenemos varios componentes? ¿Qué pasa si están anidados? ¿Cómo diferenciarlos? Ahora el código es solo una cadena larga y tonta. No tenemos una comprensión más profunda de lo que realmente representa. Entonces no podemos hacer mucho al respecto. Necesitamos un enfoque completamente diferente y más poderoso. Necesitamos convertir nuestro código en un árbol. El árbol de sintaxis abstracta. Afortunadamente, ya tenemos una herramienta para eso en nuestro proyecto.

Es Babel. Para que Babel haga algo con tu código, también necesita esta comprensión más profunda de su significado. Así que siempre comienza creando un AST a partir del código que le pasas. Puedes inspeccionar los AST en esta herramienta muy útil llamada AST Explorer. Aquí está nuestro botón. Estamos usando Babel Parser. Y en el lado derecho, puedes ver las tres representaciones de nuestro código. Ahora, si paso el cursor sobre diferentes partes de nuestro código, puedes ver qué nodo se está resaltando. Por ejemplo, este botón ahora corresponde a este identificador JSX. Si paso sobre el tipo, puedes ver que es solo un atributo JSX y el primario es un literal de cadena. Ahora sé exactamente qué parte de este código es cada una y puedo asegurarme de obtener los valores que necesito obtener.

Entonces aquí está la implementación. Primero, utilizas la función parse de Babel parser y le das tu código, y esto genera la estructura del árbol que viste. Luego utilizamos la función traverse para recorrer este árbol y buscar todos los atributos o props de gsx. Una vez que obtenemos este tipo de nodo, simplemente guardamos el nombre y el valor. Esta es una forma muy sencilla de obtener todos los nombres y valores de los props de nuestro componente.

También demostré que podemos hacerlo al revés. Pude cambiar estos snaps y en realidad estaba actualizando este código. Y por cierto, nunca hemos escrito una sola línea de este código en nuestros ejemplos. Todo esto se genera solo en función de la configuración de los props y el estado de este playground. ¿Cómo funciona este proceso al revés? ¿Cómo generamos realmente un código? Como puedes imaginar, hay algún tipo de estado donde tienes la lista de los nombres y sus valores de los props, y sabes cuál es el nombre del componente. Nuevamente, podríamos intentar algo simple y simplemente unir un montón de cadenas juntas, y esto nos dará el fragmento final y funcionará. Pero se complica bastante rápido con todas las excepciones y casos diferentes. Y también es una forma muy fácil de producir un código que no funciona y tiene errores de sintaxis. Ya aprendimos una lección similar con las expresiones regulares. Entonces, nuevamente, necesitamos un enfoque más confiable.

Ya mencioné los árboles anteriormente y resulta que también puedes construirlos desde cero. Este es un ejemplo simplificado de una función que crea un AST de un elemento JSX. Podemos componer nodos juntos para construir nuestro propio árbol desde cero. Dado que todas estas funciones son de tipo estático, si olvidamos pasar algún valor, obtendremos un error. Y ahora podemos estar seguros de que sea cual sea el script final, funcionará. Por supuesto, ahora tenemos el AST, pero todavía necesitamos convertirlo en código. Una vez que tenemos el AST, podemos utilizar la función generate de Babel generator. Esto simplemente convierte el AST en código. Pero hay un problema. Esto solo dará como resultado una sola línea de código, que no es muy legible. Así que vamos a ser más elegantes y podemos utilizar otra herramienta popular llamada Prettier. Y Prettier utiliza la misma representación AST que Babel para el código. Así que podemos usar Prettier para imprimir un fragmento de código mucho más bonito. Hay muchas otras características de este playground que no tengo tiempo de mostrarte.

Por ejemplo, no todos los componentes son tan simples como un botón. A veces necesitas incluir... A veces necesitas usar estados locales para hacer que tus ejemplos sean realistas. Nosotros lo admitimos. A veces necesitas anidar múltiples componentes. Nosotros lo admitimos. Incluso puedes querer construir un prototipo personalizado y un NAP personalizado. Nosotros también lo admitimos. Todo esto está preparado en esta biblioteca llamada React View. Es de código abierto. Y tiene su propia documentación interactiva. Así que, por favor, échale un vistazo.

Y aquí van algunas reflexiones finales. En primer lugar, la documentación es inmensamente importante y una parte crítica de cualquier cosa que envíes. Ayuda a tus clientes a usar tu producto. Pero también hazlo por tus propias razones egoístas. Puedes ahorrarte mucho tiempo al no responder preguntas que pueden ser respondidas por una documentación de calidad.

En segundo lugar, ¿cómo podemos mejorar mucho la documentación? Obtén tus superpoderes con los árboles de sintaxis abstracta y herramientas como Babel y Prettier. Ya los usamos para construir nuestras aplicaciones, pero también podemos usarlos para escribir algunas partes aburridas de nuestro código y construir una documentación mucho mejor.

Y finalmente, para comenzar, echa un vistazo a ReactVue. Es de código abierto y alimenta todos los ejemplos de mi charla y nuestra documentación. Y hay una cosa más, encontramos otro uso para tener una especificación de prop para cada componente. Lo tradujimos en fragmentos de código de VS Code. Es una excelente función para usuarios avanzados. Muchas veces, tus desarrolladores ni siquiera necesitan leer la documentación para producir nuevo código. ¿Y qué hay mejor que eso? Si quieres mantenerte actualizado, aquí está mi Twitter. Y gracias por ver. Charlas fantásticas hoy, y la tuya definitivamente se suma a la larga lista de grandes charlas que hemos visto. Y de nuevo, solo... la cita. Ah, tan buena.

Esto es como, sí, la documentación es importante, gente. Una pregunta que me estaba haciendo cuando vi esto, y recordé cómo empecé con la documentación en el pasado. ¿Cómo dirías... cuál es una buena manera para que las personas comiencen a crear documentación? ¿Cuál es el buen punto de partida? Sí, para nosotros también fue un proceso, ¿verdad? Nos llevó un tiempo construir todo el sistema, así que diría que comiences incrementalmente. Creo que Storybook es una gran opción, porque puedes usarlo para desarrollar tus componentes, y tiene algunos complementos realmente geniales, así que también puedes documentarlos. Después de un tiempo, cuando eso no es suficiente, o sientes que necesitas algo más, tal vez deberías usar una solución personalizada. Tuvimos una charla realmente buena sobre Gatsby y MDX. Realmente, realmente me gusta MDX. También lo usamos. Usamos Next.js, es similar. Pero sí, simplemente comienza incrementalmente. Storybook es una excelente manera de comenzar rápidamente. MDX es increíble después.

De hecho, eso me lleva a una pregunta de Forzu del canal, que es, si tengo una biblioteca de muestra de Storybook, ¿debería probar ReactView para la documentación? Nuestro sistema de diseño está bastante integrado con NX y Storybook. ¿Es un complemento o una alternativa a Storybook usar ReactView? También puedes usarlo con Storybook. ReactView es solo un componente de React, por lo que se puede usar en Storybook. En cierto modo, es similar. En Storybook, también tienes estos mapas donde puedes cambiar valores y ver diferentes variantes de tus componentes. ReactView va un paso más allá. Genera el código fuente por ti. Entonces, sí, puedes usarlo al mismo tiempo. Storybook admite cualquier cosa. Simplemente puedes poner cualquier componente de React allí. ReactView es solo otro componente de React, por lo que definitivamente puedes usarlo juntos. Eso es agradable. Eso es bastante genial.

Y mencionaste, volviendo a la pregunta original sobre cómo comenzar, mencionaste que fue un proceso para tu empresa. Entonces, ¿qué dirías que fue el proceso? ¿Cuáles fueron los pasos que tuvieron que seguir? Además de elegir tu tecnología y una solución para producir la documentación, ¿cómo se veía más o menos todo el proceso? Correcto. Primero comenzamos construyendo toda la biblioteca de componentes. Esa era la prioridad, simplemente sacar todos los componentes. Por eso usamos Storybooks.

No dedicamos mucho tiempo a construir documentación personalizada. Pero también tenemos este canal de soporte y estábamos escuchando a las personas. Tienen muchas dificultades para usar nuestros componentes, y siempre intentábamos responder a estas preguntas. Y luego vemos que las personas hacen las mismas preguntas. Pensamos, ¿cómo podríamos reunir estas preguntas y resolverlas en nuestra documentación para que las personas dejen de preguntarnos lo mismo una y otra vez.

Entonces, intenta preguntar a las personas que usan tu documentación, tu proyecto, qué opinan sobre tu documentación, qué falta. Definitivamente te lo dirán porque pasan mucho tiempo buscando respuestas. Así que es como este feedback constante de tus usuarios que realmente mejora tu documentación. Deberías preguntarles con frecuencia, tal vez hacer una encuesta. Eso es realmente genial. También me preguntaba sobre esto. Entonces construiste una biblioteca de componentes y estoy bastante seguro de que tienes muchos componentes, ¿verdad? Y no solo eso. Quiero decir, los componentes son una cosa sobre la que las personas pueden tener preguntas. Pero puede haber preguntas auxiliares o preguntas frecuentes que te hacen que no están necesariamente directamente relacionadas con un componente, sino como la interacción de componentes o algo así. ¿Cómo puedes asegurarte de que los usuarios encuentren las respuestas a sus preguntas dentro de tu extensa documentación?

Sí, esa es una gran pregunta. Esa también fue una de las razones por las que decidimos construir una documentación personalizada, no solo usando storybook. Porque no es suficiente solo documentar componentes, sino que también quieres tener la historia de todo el sistema. Pero que también cubra otras preguntas importantes. Entonces, otra cosa para facilitar esto es tener una buena búsqueda en tu documentación. Tener una buena búsqueda de texto completo es realmente útil. Y hay algunas soluciones gratuitas de código abierto como Algolia, que son realmente buenas y que construyen el índice por ti. Genial. Sí. Eso es bastante genial. Creo que también hay, cómo se llama, Solar y, ah, hay otro que no puedo recordar, Elasticsearch. No, eso es algo diferente. Elasticsearch es una búsqueda de texto completo, sí. Sí, eso también funcionaría. En realidad, no he probado mucho Algolia. También, disculpa.

También, otra cosa que he visto con empresas que finalmente invirtieron en documentación, algunas de ellas lo hicieron demasiado tarde. Si tienes una gran cantidad de contenido para cubrir, crear documentación muy tarde en el proceso es realmente difícil de hacer bien. ¿Dirías que se debe escribir documentación desde el principio, desde el comienzo de un proyecto, o depende de cuándo comenzar a escribir documentación?

Esa es también una buena pregunta. Entonces, si estás construyendo algo completamente nuevo y solo estás haciendo prototipos, puede que no sea lo mejor comenzar con la documentación. Porque probablemente cambiarás las APIs mucho y estarás perdiendo mucho tiempo. Por otro lado, si sabes que lo que estás construyendo es a largo plazo, podría ser mucho más fácil hacerlo al mismo tiempo, como comenzar a documentar todo al mismo tiempo. Porque, ya sabes, cuando quieres lanzar un proyecto, no tienes documentación. Es realmente molesto. Como ahora, tengo que dejar de hacer cualquier cosa y durante las próximas dos semanas, solo voy a escribir un gran bloque de texto. Así que probablemente sea más fácil hacerlo al mismo tiempo, a menos que estés haciendo prototipos de algo nuevo y no estés seguro todavía. Es una especie de compromiso.

Eso es un buen punto. Sí, tiene sentido. Siguiendo esa pregunta, Fauzul pregunta si tenemos recomendaciones como las que hemos visto en la última charla de MDX. Probablemente. Me gustaría mostrar casos de uso como habitaciones de IKEA para mis componentes en la documentación. También, gran charla, dice él. Gracias.

De acuerdo, entonces una recomendación es no depender demasiado de la generación automática. Es muy tentador usar alguna herramienta que extraiga tipos estáticos de tus componentes y simplemente genere toda esta documentación de la API. No estoy diciendo que la documentación de la API no sea útil, pero las personas ya están usando TypeScript, por lo que pueden ver qué APIs pueden usar. Probablemente estén más interesados en casos de uso más profundos, por lo que siempre debes intentar crear tu documentación a medida para escenarios reales. Así que simplemente no confíes en la generación automática. Intenta realmente escribir documentación legible para los humanos, algo que te gustaría ver como desarrollador. Esa sería mi recomendación, y al mismo tiempo, también lo que debes hacer. Dedica tiempo y hazlo agradable, legible para los humanos... incluso divertido, ¿verdad? Queremos divertirnos al leer la documentación.

También, cuando se trata de ser un desarrollador y escribir documentación, otra cosa que noto y también es una mala práctica... Creo que lo único peor que la documentación es la documentación desactualizada. ¿Cómo lidias con el cambio de código y la documentación que no se actualiza? Creo que lo más importante es mantener la documentación y el código en el mismo repositorio, en el mismo lugar. Y simplemente, ya sabes, reutilizar cosas. Si cambio un componente, en realidad va a romper los ejemplos en mi documentación, así que también tengo que arreglar eso. Y también, ya sabes, cualquier función que agregue a cualquier componente, al mismo tiempo también tengo que crear documentación para ello. Entonces, si mantienes estas cosas juntas en el mismo lugar, estando vinculadas, siempre te verás obligado a mantenerlas sincronizadas, lo que realmente ayuda. Esa es una forma genial de abordar esto. Increíble. Wojtek, creo que fue una charla increíble y estoy realmente agradecido de que estuvieras aquí para responder todas tus preguntas, todas las preguntas que hay ahí fuera y también mis preguntas.