wiki-3.-Scripts

3. Scripts

Hay varios scripts disponibles para correr. Los mismos se pueden dividir en diferentes categorías: dev, build, test, format

npm run dev:webpack: levanta el entorno de desarrollo con hot reload de los componentes para un desarrollo rápido y sencillo con una buena interfaz.
npm run dev:docs: levanta el entorno de desarrollo de la documentación. Sólo sirve los archivos de documentación (MDX).

npm run build: Genera la versión de distribution del package con todos los componentes consumibles. Crea un distribution para javascript EcmaScript y otro para CommonJS.
npm run build:docs: Genera el build de la documentación de los componentes. Output bundle de producción de la interfaz observable con npm run dev:docs.
npm run build:sb: Genera el build de la interfaz interactiva (tal cómo la interfaz servida con npm run dev). Útil para cuando quiere compartirse nuevas versiones con el equipo interno, de producto o diseño, para que jueguen y prueben, obtener feedback, e iterar más rápido.

npm run test: corre los comandos test:typescript, test:lint, test:mdx, test:run, test:coverage descriptos a continuación.
npm run test:typescript: Test de typescript para prevenir errores en producción debido al mal uso de tipos e interfaces.
npm run test:run: Corre los tests unitarios declarados en los archivos *.spec.ts.
npm run test:coverage: Corre los tests unitarios declarados en los archivos *.spec.ts, y genera un reporte sobre el alcance cubierto de los tests sobre cada componente. Lo ideal es que se mantenga siempre en el 100% para cubrir todos los edge cases y corner cases posibles.
npm run test:lint: comprueba que se respeten las reglas de lint correspondientes.
npm run test:mdx: Comprueba que los archivos de documentación (MDX) no tengan errores de sintaxis, importación y otros.
npm run test:watch: Escucha cambios en los archivos y corre los tests con cada cambio. Además, genera el reporte y levanta una interfaz gráfica en el browser cómo guía para encontrar los errores con mayor facilidad.

npm run format: Se recomienda usar este comando con discreción. Corrige todos los archivos según el linter. Es decir, podría modificar los archivos sobre los cuales no estemos trabajando. Es bueno evitarlo para no generar ruido en los commits.