ontwik ui

Ontwik-ui

Una biblioteca de interfaz de usuario sin cabeza y generador de temas de CLI

Impulsado por:

• ? Turborepo-Sistema de compilación de alto rendimiento para Monorepos
• React - Biblioteca JavaScript para interfaces de usuario
• ? TSUP - TypeScript Bundler impulsado por ESBuild
• Libro de cuentos: entorno de componentes de la interfaz de usuario alimentado por Vite

Así como algunas otras herramientas preconfiguradas:

• Mecanografiado para verificación de tipo estático
• Cambios de conjuntos para administrar versiones y Changelogs
• Acciones de GitHub para publicaciones de paquetes totalmente automatizados

Empezando

Documento

Comandos útiles

• yarn dev - Ejecutar todos los paquetes localmente y una vista previa con el libro de cuentos
• yarn build : construya todos los paquetes, incluido el sitio de libros de cuentos
• yarn lint - pelusa todos los paquetes
• yarn changeset
• yarn clean : limpie todas las carpetas node_modules y dist (ejecuta el script limpio de cada paquete)

Aplicaciones y paquetes

Este Monorepo incluye los siguientes paquetes y aplicaciones:

• apps/docs : sitio de documentación de componentes con libro de cuentos
• apps/public-docs : documentos públicos impulsados por NEXTRA
• packages/ontwik-ui : componentes de reacción de núcleo

Cada paquete y aplicación es 90% TypeScript. Los espacios de trabajo de Yarn nos permiten "izar" las dependencias que se comparten entre paquetes y el package.json root.json. Esto significa carpetas node_modules más pequeñas y una mejor experiencia de desarrollo local. Para instalar una dependencia para todo el Monorepo, use el indicador de espacios de trabajo -W con yarn add .

PAQUETOS DE VERDADEROS Y PUBLICITA

Este repositorio utiliza cambios en los cambios para administrar versiones, crear ChangeLogs y publicar en NPM. Está preconfigurado para que pueda comenzar a publicar paquetes inmediatamente.

Generando el ChangeLog

Para generar su CangeLog, ejecute yarn changeset localmente:

1. ¿Qué paquetes le gustaría incluir? - Esto muestra qué paquetes y cambiados y cuáles han permanecido igual. Por defecto, no se incluyen paquetes. Presione space para seleccionar los paquetes que desea incluir en los changeset .
2. ¿Qué paquetes deberían tener un gran bulto? - Presione space para seleccionar los paquetes para los que desea aumentar las versiones.
3. Si hace la primera versión principal, confirme que desea lanzar.
4. Escriba un resumen para los cambios.
5. Confirme que los cambios se ve como se esperaba.
6. Se creará un nuevo archivo de Markdown en la carpeta changeset con el resumen y una lista de los paquetes incluidos.

Lanzamiento

Cuando presiona su código a GitHub, la acción GitHub ejecutará el script release definido en el package.json root.json:

turbo run build --filter=docs^... --filter=public-docs^... && changeset publish

Turborepo ejecuta el script build para todos los paquetes publicables (excluyendo documentos y docentes públicos) y publica los paquetes a NPM.