Develop - secchanu/nodecg-template GitHub Wiki
※NodeCGの導入とNodeCG-Bundleの導入が済んでいることが前提です
ディレクトリ構造
バンドル名/
├─schemas/ nodecgでやり取りするデータ型のjsonスキーマを入れる
├─src/
│ ├─browser/
│ │ ├─common/ #共通のコンポーネントや関数を入れる用
│ │ ├─dashboard/ #この中の*.tsxがダッシュボードとしてビルドされる
│ │ ├─graphics/ #この中の*.tsxがグラフィックスとしてビルドされる
│ │ └─use-replicant.ts #Replicantを使うためのカスタムフックuseRep
│ ├─extension/ #この中のindex.tsが拡張機能としてビルドされる
│ └─nodecg/
│ ├─generated/ #schemasから生成された型定義が入る
│ ├─messages.ts #sendMessageで送られるメッセージの型定義
│ └─replicants.ts #Replicantで送られるデータの型定義
├─configschema.json #バンドルの設定ファイルのjsonスキーマ
└─package.json #"nodecg"に表示するファイル等のManifestを書く
よく使うコマンド
必要パッケージのインストール
pnpm install
追加パッケージのインストール
pnpm add "パッケージ名"
コードを変更しながら試す（開発時用）
pnpm dev
フォーマット（コードの整形）
pnpm format
テスト（コードの検証）
pnpm test
ビルド（本番用）
pnpm build
NodeCGの実行
pnpm start