ontwik ui

ontwik-ui

ヘッドレスUIライブラリとCLIテーマジェネレーター

搭載：

• ？ Turborepo - Monorepos用の高性能ビルドシステム
• React - ユーザーインターフェイス用のJavaScriptライブラリ
• ？ TSUP - Esbuildを搭載したTypeScriptバンドラー
• ストーリーブック - Viteを搭載したUIコンポーネント環境

他のいくつかのツールと同様に、事前に設定されています：

• 静的タイプチェック用のタイプスクリプト
• バージョン化と変更ログを管理するための変更セット
• 完全に自動化されたパッケージパブリッシングのためのGitHubアクション

はじめる

ドキュメント

便利なコマンド

• yarn devすべてのパッケージをローカルで実行し、ストーリーブックでプレビューする
• yarn build - ストーリーブックサイトを含むすべてのパッケージを構築する
• yarn lintすべてのパッケージを癒します
• yarn changesetチェンジセットを生成します
• yarn cleanすべてのnode_modulesとdistフォルダーをクリーンアップします（各パッケージのクリーンスクリプトを実行します）

アプリとパッケージ

このモノレポには、次のパッケージとアプリケーションが含まれています。

• apps/docs ：ストーリーブック付きのコンポーネントドキュメントサイト
• apps/public-docs ：Nextraを搭載した公開ドキュメント
• packages/ontwik-ui ：コア反応コンポーネント

各パッケージとアプリは90％TypeScriptです。 YARNワークスペースを使用すると、Root package.jsonのパッケージ間で共有される依存関係を「ホイスト」することができます。これは、 node_modulesフォルダーが小さいことと、ローカル開発体験の向上を意味します。 Monorepo全体の依存関係をインストールするには、 yarn addとともに-Wワークスペースフラグを使用します。

バージョン化と公開パッケージ

このリポジトリは、変更セットを使用してバージョンを管理し、Changelogsを作成し、NPMに公開します。それは事前に設定されているので、すぐにパッケージの公開を開始できます。

Changelogの生成

チェンジログを生成するには、 yarn changeset 。

1. どのパッケージを含めたいですか？ - これは、どのパッケージと変更され、それらが同じままであるかを示しています。デフォルトでは、パッケージは含まれていません。 spaceを押して、 changesetに含めるパッケージを選択します。
2. どのパッケージに大きなバンプがあるはずですか？ - spaceを押して、バージョンをバンプするパッケージを選択します。
3. 最初のメジャーバージョンを実行する場合は、リリースすることを確認してください。
4. 変更の要約を書いてください。
5. 予想どおりに変更されたChangesetの確認を確認してください。
6. 新しいMarkdownファイルが、概要とパッケージのリストを含むchangesetフォルダーに作成されます。

リリース

コードをGitHubにプッシュすると、GitHubアクションは、root package.jsonで定義されたreleaseスクリプトを実行します。

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

Turborepoは、すべての公開可能なパッケージ（Docs＆Public-Docsを除く）のbuildスクリプトを実行し、パッケージをNPMに公開します。