艦これウィジェット

インストール

ベータ版

公開版

開発

git clone git@github.com:KanCraft/kanColleWidget.git
cd kanColleWidget
git checkout develop
pnpm install
pnpm test run
pnpm build
# ここでできあがったdistフォルダを、
# chrome://extensions にて読み込む

コンテナ開発フロー

Dev Container (VS Code / Codespaces)

1. VS Code に Dev Containers 拡張を入れ、このリポジトリを開く。
2. コマンドパレットで Dev Containers: Reopen in Container を実行する。
3. .devcontainer/devcontainer.json がルートの Dockerfile をビルドし、 kcw-node-modules ボリュームを自動設定する。
4. コンテナ内のターミナルで pnpm start を実行すると vite build --watch が走り、src/ の変更が dist/ に即時反映される。
5. chrome://extensions 側で「パッケージ化されていない拡張機能を読み込む」 から dist/ を指定し、更新時は再読み込みするだけでよい。
6. 依存追加を行った場合はコンテナ内で pnpm install --frozen-lockfile を 実行し、kcw-node-modules にキャッシュされることを確認する。

Docker 単体での利用

Dev Container を使わない場合も、ルートの Dockerfile で同じ環境を 構築できる。

docker build -t kcw-dev .
docker run --rm -it \
  -v "$(pwd)":/workspace \
  -v kcw-node-modules:/workspace/node_modules \
  kcw-dev
# コンテナ内で自動的に pnpm install が実行され、続けて pnpm start が起動

• Makefile からまとめて起動したい場合は make dev を利用すると上記と 同じコマンド列が実行される。
• pnpm start は tsc && pnpm run copy-tesseract && vite build --watch を 実行し、dist/ を監視更新する。Chrome 拡張には監視済み dist/ を 読み込ませるだけでよい。
• ファイル監視を安定させるため CHOKIDAR_USEPOLLING=1 等を既定で有効化 済み。変更が伝播しない場合は pnpm start -- --poll 100 を試す。
• kcw-node-modules ボリュームを削除したい場合は docker volume rm kcw-node-modules を実行する。

リリースフロー

概要

このプロジェクトは develop ブランチで開発し、main ブランチへのマージでリリースされます。 リリースにはベータ版とプロダクション版の2段階があります。

1. 開発からベータリリースまで

1.1 バージョンアップの準備

# 1. package.json のバージョンを更新（例: 4.0.12 → 4.0.13）
vim package.json

# 2. リリースノートを自動生成
make draft
# これにより以下が自動更新されます：
#   - manifest.json のバージョン
#   - release-note.json に新しいリリースエントリ追加

# 3. release-note.json を編集してリリースメッセージを記入
vim src/release-note.json

1.2 コミット＆プッシュ

git add package.json src/public/manifest.json src/release-note.json
git commit -m "v4.0.13"
git push origin develop

1.3 プルリクエスト作成

1. develop → main へPRを作成
2. PRタイトルを [v4.0.13] の形式に編集

👉 この時点で自動的にベータ版がChrome Webstoreに公開されます

2. プロダクションリリース

2.1 ベータ版の動作確認

ベータ版（Chrome拡張ID: egkgleinehaapbpijnlpbllfeejjpceb）で動作確認を行います。

2.2 プルリクエストをマージ

PRをマージすると、以下が自動実行されます：

1. バージョン整合性チェック（PRタイトル、package.json、manifest.json、release-note.jsonが一致しているか）
2. develop ブランチに v4.0.13 タグを作成・push
3. プロダクション版ビルド実行
4. Chrome Webstoreに本番公開（Chrome拡張ID: iachoklpnnjfgmldgelflgifhdaebnol）

リリースフロー図

develop ブランチで開発
    ↓
package.json のバージョン更新
    ↓
make draft（manifest.json、release-note.json 自動更新）
    ↓
コミット & プッシュ
    ↓
develop → main へPR作成
    ↓
PRタイトルを [vX.X.X] に編集
    ↓
🚀 ベータ版リリース（自動）
    ↓
ベータ版で動作確認
    ↓
PRをマージ
    ↓
🚀 プロダクション版リリース（自動）
    ↓
develop ブランチに vX.X.X タグが作成される

注意事項

• PRタイトルは必ず [v で始める（例: [v4.0.13]、[v4.0.13] 新機能追加）
• バージョン番号は package.json、manifest.json、release-note.json で一致している必要があります
• ベータ版と本番版は異なるChrome拡張IDを使用しています

不具合報告・機能要望

• https://github.com/kancraft/kanColleWidget/issues