コントリビューション

ClueLens に興味を持っていただきありがとうございます。このガイドでは、ローカルセットアップ、プロジェクト構成、貢献フローを説明します。

必要環境

• Node.js 18+
• Yarn 1.x
• VS Code 推奨

クイックスタート

# リポジトリを取得
git clone https://github.com/cppakko/cluelens.git
cd cluelens

# 依存関係をインストール
yarn install

# Chrome 向け開発起動
yarn dev

# Firefox 向け開発起動
yarn dev:firefox

yarn dev を実行すると、WXT が拡張機能をビルドし、ホットリロード付きのブラウザーインスタンスを起動します。

プロジェクト構成

cluelens/
├── assets/             # グローバルスタイルと画像アセット
├── components/
│   ├── dicts/          # 辞書・翻訳モジュール
│   │   ├── index.tsx   # メタデータ登録とモジュール読み込み
│   │   ├── types.ts    # DictID、ModuleType、共通型
│   │   ├── shared/     # CommonView などの共有ビュー
│   │   ├── bing/       # 個別ソースモジュール
│   │   ├── google/
│   │   └── ...
│   ├── panel/          # 検索パネル
│   └── ui/             # 再利用可能 UI コンポーネント
├── entrypoints/
│   ├── background.ts   # バックグラウンド Service Worker
│   ├── content/        # content script
│   ├── options/        # 設定ページ
│   ├── popup/          # ポップアップ UI
│   └── sidepanel/      # サイドパネル UI
├── i18n/               # ローカライズ資源
├── utils/              # ユーティリティ関数
│   ├── storage.ts      # ストレージ定義
│   ├── messaging.ts    # メッセージ処理
│   ├── detectLanguage.ts
│   └── ...
├── wxt.config.ts       # WXT 設定
├── tsconfig.json
└── package.json

よく使うコマンド

コマンド	説明
yarn dev	Chrome 向け開発モード
yarn dev:firefox	Firefox 向け開発モード
yarn build	Chrome 向け本番ビルド
yarn build:firefox	Firefox 向け本番ビルド
yarn zip	リリース用 zip を作成
yarn compile	TypeScript 型チェック (tsc --noEmit)

Issue の報告

• GitHub Issues を利用してください
• 再現手順、ブラウザー版、関連情報を含めてください
• 機能提案も歓迎します

Pull Request の送信

1. リポジトリを Fork する
2. git checkout -b feature/your-feature でブランチを作成する
3. 変更を実装してテストする
4. main に向けて Pull Request を作成する
5. 変更内容と理由を説明する

次へ

• 新しいソースを追加したい場合は 辞書を追加する