wp-plugin-spec

本リポジトリは、WordPress や Cursor などでプラグインを開発するうえでの 共通仕様 を定義するドキュメント・リポジトリです。

Description

本リポジトリ配下で開発する WordPress プラグインにおいて、「AI 伴走開発」を行う際の共通仕様・ルールを定義します。

1. 技術スタック

• 言語: PHP (8.x 系) / TypeScript
• UI: React (Gutenberg / 管理画面)。実行時は WordPress が提供する React を使う
• 対象: WordPress プラグイン (WordPress 6.9+)
• ビルド: Vite + Dart SASS。成果物は dist/
• 依存管理: npm または PHP Composer。WordPress 本体と @wordpress/* は対象外
• テスト: PHPUnit (ドメインを厚く) + PHPCS / PHPStan + ESLint / tsc + Playwright

2. 主要な開発ルール

• ドメインの判断は、純関数とし、副作用はアダプタに閉じる。
• WordPress API / DB / HTTP / ファイルは、アダプタに閉じる。
• フック登録、REST、設定画面、ブロック登録は、アダプタであり、クラスを使ってよい。
• 継承と巨大サービス (FooService 等) は、使わない。
• エラーは、WP_Error / HTTP / notice / JS のエラー表示で表に出す。
• 実装修正の着手は、人間が許可してから実行する。

3. コーディング規約

• PHP は、WordPress コーディング規約 (PHPCS / WPCS) に準拠する。
• TypeScript は、strict: true とし、ESLint で検査する。
• アダプタは includes/ に、ドメインの純関数は includes/domain/ に置く。
• React は UI アダプタとし、ドメイン判断は utils/ の純関数に出す。
• 表示文言は、__() / @wordpress/i18n を通す。ドメインに翻訳文字列を埋め込まない。

4. 詳細な仕様

詳細は、docs/SPECS.md を参照してください。関連する別紙は、次のとおりです。

• docs/OVERVIEW_TEMPLATE.md — プロジェクトの存在理由 (ひな型)
• docs/ARCHITECTURE_TEMPLATE.md — コード構造と責務 (ひな型)
• docs/UI_API_DATA_TEMPLATE.md — 画面 / API / データ (ひな型)
• docs/I18N_AND_A11Y_TEMPLATE.md — 国際化 / アクセシビリティ (ひな型)
• docs/TEST_AND_CICD_TEMPLATE.md — テスト / CI/CD (ひな型)
• docs/AI_COLLAB_TEMPLATE.md — AI 伴走開発ルール (ひな型)
• docs/CICD.md — CI/CD

旧正本は、docs/archive/adapter-and-pure-domain/ に freeze しています。

License

このプロジェクトは、GPL v3以降の下でライセンスされています - 詳細は LICENSE ファイルを参照してください。