ontwik ui

Ontwik-Ui

Perpustakaan UI tanpa kepala dan generator tema CLI

Didukung oleh:

• ? Turborepo-Sistem pembangunan kinerja tinggi untuk monorepos
• Bereaksi - Perpustakaan JavaScript untuk Antarmuka Pengguna
• ? TSUP - TypeScript Bundler Didukung oleh Esbuild
• Buku Story - Lingkungan Komponen UI Didukung oleh Vite

Serta beberapa alat lainnya yang dikonfigurasikan sebelumnya:

• TypeScript untuk memeriksa tipe statis
• Perubahan untuk mengelola versi dan changelogs
• Tindakan GitHub untuk penerbitan paket otomatis sepenuhnya

Memulai

Dokumen

Perintah yang berguna

• yarn dev - Jalankan semua paket secara lokal dan pratinjau dengan buku cerita
• yarn build - Bangun Semua Paket Termasuk Situs Buku Story
• yarn lint - serat semua paket
• yarn changeset - menghasilkan perubahan
• yarn clean - Bersihkan semua node_modules dan folder dist (menjalankan skrip bersih setiap paket)

Aplikasi & Paket

Monorepo ini mencakup paket dan aplikasi berikut:

• apps/docs : Situs dokumentasi komponen dengan buku cerita
• apps/public-docs : Dokumen publik yang didukung oleh Nextra
• packages/ontwik-ui : Komponen Inti Bereaksi

Setiap paket dan aplikasi adalah naskah 90%. Ruang kerja benang memungkinkan kita untuk "hoist" dependensi yang dibagi antara paket ke package.json root.json. Ini berarti folder node_modules yang lebih kecil dan pengalaman dev lokal yang lebih baik. Untuk menginstal ketergantungan untuk seluruh monorepo, gunakan bendera ruang kerja -W dengan yarn add .

Paket Versi & Penerbitan

Repositori ini menggunakan Changesets untuk mengelola versi, membuat changelog, dan menerbitkan ke NPM. Ini sudah dikonfigurasi ulang sehingga Anda dapat mulai menerbitkan paket segera.

Menghasilkan changelog

Untuk menghasilkan changelog Anda, jalankan yarn changeset secara lokal:

1. Paket mana yang ingin Anda sertakan? - Ini menunjukkan paket mana dan berubah dan mana yang tetap sama. Secara default, tidak ada paket yang disertakan. Tekan space untuk memilih paket yang ingin Anda sertakan di changeset .
2. Paket mana yang harus memiliki benjolan besar? - Tekan space untuk memilih paket yang ingin Anda bumpik versi.
3. Jika melakukan versi utama pertama, konfirmasi Anda ingin merilis.
4. Tulis ringkasan untuk perubahan.
5. Konfirmasikan perubahan yang terlihat seperti yang diharapkan.
6. File Markdown baru akan dibuat di folder changeset dengan ringkasan dan daftar paket yang disertakan.

Melepaskan

Saat Anda mendorong kode Anda ke GitHub, tindakan GitHub akan menjalankan skrip release yang ditentukan dalam package.json root.json:

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

Turborepo menjalankan skrip build untuk semua paket yang dapat diterbitkan (tidak termasuk dokumen & docs publik) dan menerbitkan paket ke NPM.