ontwik ui

Ontwik-UI

Une bibliothèque d'interface utilisateur sans tête et un générateur de thème CLI

Alimenté par:

• ? Turborepo - Système de construction haute performance pour Monorepos
• React - bibliothèque JavaScript pour les interfaces utilisateur
• ? TSUP - Bundler dactylographié alimenté par Esbuild
• Livre de contes - Environnement des composants d'interface utilisateur alimenté par Vite

Ainsi que quelques autres outils préconfigurés:

• TypeScript pour la vérification des types statiques
• Enfants pour gérer le versioning et les changelogs
• Actions GitHub pour l'édition de packages entièrement automatisée

Commencer

Docs

Commandes utiles

• yarn dev - Exécutez tous les packages localement et aperçu avec livre de contes
• yarn build - Build Tous les packages, y compris le site de livre de contes
• yarn lint - Lint tous les packages
• yarn changeset - Générez un ensemble de changements
• yarn clean - Nettoyez tous les dossiers node_modules et dist (exécute le script propre de chaque package)

Applications et packages

Ce monorepo comprend les packages et applications suivants:

• apps/docs : site de documentation des composants avec livre de contes
• apps/public-docs : Docs publics propulsé par Nextra
• packages/ontwik-ui : Core React Composants

Chaque package et application est à 90% dactylographié. Les espaces de travail YARN nous permettent de «hisser» les dépendances qui sont partagées entre les packages vers le package.json racine.json. Cela signifie des dossiers node_modules plus petits et une meilleure expérience de développement local. Pour installer une dépendance pour l'ensemble du monorepo, utilisez l'indicateur -W des espaces de travail avec yarn add .

Packages de versioning et de publication

Ce référentiel utilise des ensembles de changes pour gérer les versions, créer des changelogs et publier sur NPM. Il est préconfiguré pour que vous puissiez commencer à publier des packages immédiatement.

Génération du changelog

Pour générer votre changelog, exécutez yarn changeset localement:

1. Quels packages aimeriez-vous inclure? - Cela montre quels packages et ont changé et qui sont restés les mêmes. Par défaut, aucun package n'est inclus. Appuyez sur space pour sélectionner les packages que vous souhaitez inclure dans l' changeset .
2. Quels forfaits devraient avoir une bosse majeure? - Appuyez sur space pour sélectionner les packages pour lesquels vous souhaitez baisser les versions.
3. Si vous effectuez la première version majeure, confirmez que vous souhaitez publier.
4. Écrivez un résumé pour les modifications.
5. Confirmez que les changements ont l'air comme prévu.
6. Un nouveau fichier Markdown sera créé dans le dossier changeset avec le résumé et une liste des packages inclus.

Libération

Lorsque vous poussez votre code vers GitHub, l'action GitHub exécutera le script release défini dans le package.json racine.json:

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

TurborePo exécute le script build pour tous les packages publiables (à l'exclusion des documents et publics) et publie les packages à NPM.