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 mymodule → Bitrix\Mymodule)。
  • 模块在 b_module 中注册之前,任何功能都无法运行:Loader::includeModule() 会返回 false,且不会读取模块的 .settings.php(services、controllers、console、messenger)。
  • 安装与卸载必须对称:创建的每个表、处理器、代理任务和选项都必须有对应的移除方式;重复运行安装不得失败。
  • 事件注册使用内核参数名(fromModuleId:)或位置参数;处理器签名取决于分发器 — bitrix-events。
  • 模块路由通过 require 从 /local/routes/web.php 加载;模块 .settings.php 中的 routing 部分会被忽略(bitrix-routing)。
  • 项目数据/内容迁移(iblock、各环境的选项)应交由 bitrix-sprint-migration 处理,而非安装器。

评论

支持 Markdown