mcomteam/apex

代码生成工具镜像

镜像概述

本镜像基于hygen工具构建，提供标准化的代码生成能力，旨在帮助开发团队快速创建项目中的常见代码文件，如组件、路由、服务和数据库迁移文件，同时规范提交消息的动词使用，提升开发效率和代码一致性。

核心功能与特性

• 集成hygen工具：通过npm全局安装hygen，提供代码生成基础能力
• 多类型代码生成：支持生成组件、路由、服务和迁移文件
• 提交消息规范：提供提交消息标题中动词的使用指南，确保提交信息清晰规范

使用场景

• 前端或后端项目开发中需要快速创建标准化代码文件时
• 团队协作中需要统一代码生成规范和提交消息格式时
• 减少重复编码工作，提升开发效率的场景

使用方法

安装hygen

首先通过以下命令全局安装hygen工具：

bash
npm i -g hygen

生成组件

使用以下命令生成组件文件：

bash
hygen generate component <name>

其中 <name> 为组件名称，需替换为实际组件标识。

生成路由

使用以下命令生成路由文件：

bash
hygen generate route <name>

其中 <name> 为路由名称，需替换为实际路由标识。

生成服务

使用以下命令生成服务文件：

bash
hygen generate service <name>

其中 <name> 为服务名称，需替换为实际服务标识。

生成迁移文件

使用以下命令生成数据库迁移文件：

bash
hygen generate migration

提交消息动词规范

在提交代码时，建议在消息标题中使用以下动词，以明确提交目的：

• Add：添加到代码中（如功能、测试、库）
• Drop：从代码中删除（如功能、测试、库）
• Fix：修复代码中的问题（如错误、拼写错误）
• Bump：更改版本（如升级使用的库版本）
• Make：更改构建工具或流程相关的基础设施
• Refactor：重构旧代码结构（如将控制器层的处理逻辑移至业务层）
• Optimize：优化旧代码性能（如为订单搜索功能添加缓存层以减少数据库查询时间）
• Reformat：重新格式化旧代码（如删除不符合编码规范的空格、空行）
• Rephrase：修改源代码中的文档（如源代码中的注释 TODO / FIXME 等）
• Document：修改源代码外的文档（如在 README.md 中添加说明）