mcomteam/smart-loyalty

smart-loyalty-server 代码生成工具镜像

镜像概述

本镜像为smart-loyalty-server项目提供基于hygen的代码生成工具，旨在通过标准化的代码生成流程，帮助开发者快速创建项目所需的各类代码组件，减少重复工作，提升开发效率。

核心功能与特性

• 组件生成：快速创建标准组件文件
• 路由生成：自动生成路由配置代码
• 服务生成：创建服务层代码结构
• 迁移文件生成：生成数据库迁移相关文件
• 标准化流程：提供统一的代码生成规范

使用场景

适用于smart-loyalty-server项目开发过程中，需要快速创建组件、路由、服务或数据库迁移文件时使用，尤其适合团队协作开发，确保代码风格和结构的一致性。

使用方法

前提条件

需先全局安装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 中添加描述）