ontwik ui

Ontwik-ui

Eine kopflose UI -Bibliothek und CLI -Themengenerator

Angetrieben von:

• ? Turborepo-Hochleistungs-Build-System für Monorepos
• React - JavaScript -Bibliothek für Benutzeroberflächen
• ? TSUP - Typscript -Bundler von Esbuild angetrieben
• Storybook - UI -Komponentenumgebung von Vite betrieben

Sowie einige andere Werkzeuge vorkonfiguriert:

• TypeScript für statische Typprüfung
• Änderungen für die Verwaltung von Versioning und Changelogs
• GitHub -Aktionen für vollständig automatisierte Paketveröffentlichung

Erste Schritte

Dokumente

Nützliche Befehle

• yarn dev - Führen Sie alle Pakete lokal aus und Vorschau mit Storybook
• yarn build - Erstellen Sie alle Pakete einschließlich der Storybook -Site
• yarn lint - FINT Alle Pakete
• yarn changeset - erzeugen einen Änderungssatz
• yarn clean - Reinigen Sie alle Ordner node_modules und dist (läuft das saubere Skript jedes Pakets)

Apps & Pakete

Dieser Monorepo enthält die folgenden Pakete und Anwendungen:

• apps/docs : Komponenten -Dokumentationsseite mit Storybook
• apps/public-docs : Öffentliche Dokumente von Nextra angetrieben
• packages/ontwik-ui : Core React-Komponenten

Jedes Paket und jede App sind zu 90% Typenkript. Mit Garn -Arbeitsbereichen können wir Abhängigkeiten "Hebe", die zwischen den Paketen an das Root package.json geteilt werden. JSON. Dies bedeutet kleinere Ordner node_modules und eine bessere lokale Entwicklererfahrung. Um eine Abhängigkeit für das gesamte Monorepo zu installieren, verwenden Sie das FLAG für -W -Arbeitsbereiche mit yarn add .

Versioning- und Verlagspakete

Dieses Repository verwendet Änderungen, um Versionen zu verwalten, ChangeLogs zu erstellen und an NPM zu veröffentlichen. Es ist vorkonfiguriert, sodass Sie mit der Veröffentlichung von Paketen sofort beginnen können.

Erzeugen des Changelogs

Um Ihr Changelog zu erzeugen, führen Sie yarn changeset lokal aus:

1. Welche Pakete möchten Sie einschließen? - Dies zeigt, welche Pakete und sich geändert und welche gleich geblieben sind. Standardmäßig sind keine Pakete enthalten. Drücken Sie space , um die Pakete auszuwählen, die Sie in den changeset aufnehmen möchten.
2. Welche Pakete sollten eine große Beule haben? - Drücken Sie space , um die Pakete auszuwählen, für die Sie Versionen stoßen möchten.
3. Wenn Sie die erste große Version durchführen, bestätigen Sie, dass Sie veröffentlichen möchten.
4. Schreiben Sie eine Zusammenfassung für die Änderungen.
5. Bestätigen Sie, dass der Änderungssatz wie erwartet aussieht.
6. Eine neue Markdown -Datei wird im Ordner changeset mit der Zusammenfassung und einer Liste der enthaltenen Pakete erstellt.

Freigeben

Wenn Sie Ihren Code in GitHub drücken, wird in der GitHub -Aktion das im Root package.json definierte release -Skript ausgeführt. JSON:

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

Turborepo führt das build -Skript für alle veröffentlichbaren Pakete (ohne DOCS & Public-Docs) aus und veröffentlicht die Pakete an NPM.