mcpField
B
bitrix-modules

bitrix-modules

github.com/bxmaximum開発47308 回インストール2 週間前に更新
リポジトリ

bitrix-modules について

Bitrix 開発者向けのモジュール開発リファレンススキルです。モジュール構成、インストール時のマイグレーション、オプション画面、自動読み込み、ルートを扱い、登録や再実行可能なインストール、対称的なアンインストールの要件を示します。

主な機能

  1. 01モジュール構成とインストーラー規則
  2. 02マイグレーションでのテーブル、イベント、エージェント
  3. 03オプション画面と PSR-4 自動読み込み
  4. 04モジュールルーティングの指針
  5. 05対称的なインストールとアンインストールの制約

活用シーン

  1. 01新しい Bitrix モジュールの骨組み作成
  2. 02モジュールのインストールとアンインストール処理
  3. 03オプション画面と自動読み込みの設定
  4. 04モジュール登録やルーティングの問題調査

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/bxmaximum/bitrix-framework-skills --skill bitrix-modules

インストール後、Claude Code で/bitrix-modulesを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

rules/
install-migrations.md
installer.md
options-autoload.md

詳細

Bitrix モジュール

ベースライン:main 23.0+ · 検証済み:main 26.800.0

タスク参照先
新しいモジュール:ID、スケルトン、install/index.php、バージョン、言語、アンインストールrules/installer.md
install/migrations/*.php でのテーブル、イベント、エージェント(main 26.600+)rules/install-migrations.md
オプションページ、default_option.php、PSR-4 オートロード、モジュールのルートrules/options-autoload.md

不変条件

  • モジュールのディレクトリは /local/modules/<vendor>.<module>/、ID は小文字の vendor.module、インストーラークラスは vendor_module、名前空間は Vendor\Module です(ID が1語の mymodule の場合は Bitrix\Mymodule)。
  • モジュールが b_module に登録されるまでは、何も動作しません。Loader::includeModule() は false を返し、モジュールの .settings.php(services、controllers、console、messenger)も読み込まれません。
  • インストールとアンインストールは対称にします。作成するテーブル、ハンドラー、エージェント、オプションにはすべて削除処理を用意し、インストールを再実行しても失敗しないようにします。
  • イベントの登録には、カーネルのパラメーター名(fromModuleId:)または位置引数を使用します。ハンドラーのシグネチャーはディスパッチャーによって異なります — bitrix-events。
  • モジュールのルートは /local/routes/web.php から require されます。モジュールの .settings.php にある routing セクションは無視されます(bitrix-routing)。
  • プロジェクトのデータ/コンテンツのマイグレーション(iblock、環境ごとのオプション)はインストーラーではなく、bitrix-sprint-migration に属します。

コメント