Ionic + TypeScript + React + Bun

TypeScript + Bunで動作するテンプレートレポジトリです

技術スタック

• DevContainer
• Node.js
• Bun
• commitlint
• husky
• lint-staged
• PR Agent
• GitHub Actions

備考

• DevContainerを利用したホストマシンから分断したクリーンな開発環境
• 高速かつ軽量なNode.jsランタイムであるBunの採用
• husky+commitlintdでコミットメッセージのルールの厳格化
• lint-stagedでプッシュ前にコードフォーマットの実行
• マージ済みブランチの自動削除に対応
• GPG Keyを利用して署名付きコミットに対応
• GPG Keyによる署名の有効化
• プッシュと同時にブランチを作成するpush.autoSetupRemoteを有効化
• actを利用してローカルでGitHub Actionsのテスト実行に対応
• GitHub ActionsでCI/CDを実行
• PR AgentでChatGPTを利用した自動コードレビュー
• モジュールインポート時に@を利用して相対パスに対応
• リリースバージョンのバリデーション実行

構築

git clone https://github.com/Magisleap/TypeScript
cd TypeScript

VSCodeからcmd/ctrl + Shift + pでコマンドパレットを開き, DevContainerで立ち上げます.

DevContainerの実行にはExtensionのインストールとDocker Desktopのインストールが必要になります

開発

bun dev

で実行できます

GitHub

PR Agentを利用する場合, レポジトリシークレットにOPENAI_KEYを追加してください.

テンプレートファイルについては.pr_agent.tomlに書き込まれているので適時変更してください. デフォルトでは日本語でコメントされるようになっています.

FAQ

• Node.jsのバージョンを20.17.0以降に上げるとcommitlintが正しく動作しなくなります
• Node.jsをインストールしないとcommitlintを含む一部の機能が動作しません
• プッシュ時にリモートブランチ作成のオプションはgitのバージョンが2.37.0以降である必要があります