🧰 ThinkPlugsHelper

ThinkPlugsHelper 是面向 ThinkAdmin 开发阶段的辅助工具包，提供模型字段注释生成与 MySQL 索引命名辅助命令。

🚀 主要功能

模型字段注释: 根据数据表字段生成模型属性注释，提升 IDE 提示体验。
索引命名辅助: 读取 MySQL 索引结构，并按 ThinkAdmin 索引命名规则重命名非主键索引。
命令行集成: 通过 ThinkPHP Command 注册开发辅助命令，适合开发环境按需使用。
轻量设计: 不创建独立业务数据表，建议作为开发依赖安装。

⚠️ 重要提示

开发依赖: 该插件面向开发阶段，建议通过 --dev 安装。

运行要求: 当前插件 composer.json 要求 PHP ^8.1。

卸载注意: 插件不创建独立数据表，卸载时只需移除 Composer 依赖。

加入我们

我们的代码仓库已移至 Github，而 Gitee 则仅作为国内镜像仓库，方便广大开发者获取和使用。若想提交 PR 或 ISSUE 请在 ThinkAdminDeveloper 仓库进行操作，如果在其他仓库操作或提交问题将无法处理！。

安装插件

**安装前建议尝试更新所有组件**
composer update --optimize-autoloader

**安装稳定版本（当前插件要求 PHP ^8.1，建议作为开发依赖安装）**
composer require zoujingli/think-plugs-helper --optimize-autoloader --dev

使用注释

执行下面的指令即可生成模型字段注释。

php think xadmin:helper:model
php think xadmin:helper:model app\\admin\\model\\SystemUser --reset --overwrite

使用索引辅助

该命令只允许在调试模式下执行，会遍历当前数据库表，并按 ThinkAdmin 索引命名规则重命名非主键索引。当前实现使用 MySQL 的 SHOW INDEX 与 ALTER TABLE RENAME INDEX，建议仅在开发环境确认后执行。

php think xadmin:helper:index

命令注册

插件服务类 plugin\helper\Service 继承 think\Service，在 boot() 中注册 DbModelStruct 与 DbIndexStruct 两个命令。该插件不是后台业务插件，不实现插件中心菜单，也不创建迁移表。

卸载插件

composer remove zoujingli/think-plugs-helper

插件数据

该插件不创建独立数据表。

版权说明

ThinkPlugsHelper 遵循 Apache2 开源协议发布，并提供免费使用。

本项目包含的第三方源码和二进制文件之版权信息另行标注。