diepmyduong/loctroi-farmer

生成数据工具 (GENERATE DATA TOOL)

镜像概述和主要用途

该镜像提供基于hygen的开发资源生成工具，旨在帮助开发者快速创建项目中的各类组件和资源，减少手动编写基础代码的工作量，统一代码风格，提升开发效率。

核心功能和特性

• 支持多种开发资源生成：组件（Component）、GraphQL接口、API、任务（Job）、服务提供者（Provider）和仓库（Repository）
• 基于hygen模板引擎，可灵活扩展生成规则
• 命令行操作简洁，易于集成到现有开发流程

使用场景和适用范围

适用于需要快速搭建项目结构的开发者，尤其适合前端、后端或全栈项目开发中需统一代码规范和结构的团队，可显著减少重复编码工作。

安装与使用方法

安装hygen

首先需全局安装hygen工具：

bash
npm i -g hygen

生成组件 (COMPONENT)

生成指定名称的组件：

bash
hygen generate component <name>

参数说明：<name> 为组件名称

生成GraphQL

生成指定模块和函数名的GraphQL接口：

bash
hygen generate graphql <module> -f <function-name>

参数说明：<module> 为模块名称，<function-name> 为函数名称

生成API

生成指定名称的API：

bash
hygen generate api <name>

参数说明：<name> 为API名称

生成任务 (JOB)

生成指定名称的任务：

bash
hygen generate job <name>

参数说明：<name> 为任务名称

生成服务提供者 (PROVIDER)

生成指定路径和名称的服务提供者：

bash
hygen generate provider <path> -n <name>

参数说明：<path> 为路径，<name> 为服务提供者名称

生成仓库 (REPOSITORY)

生成指定路径和名称的仓库：

bash
hygen generate repository <path> -n <name>

参数说明：<path> 为路径，<name> 为仓库名称

消息标题动词使用规范

提交生成资源相关代码时，建议遵循以下动词规范：

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