首页
/ 黑铁匠(Blacksmith):代码生成利器

黑铁匠(Blacksmith):代码生成利器

2024-05-29 13:02:09作者:戚魁泉Nursing

Blacksmith Logo

黑铁匠 是一个自动化代码生成工具,它能为你应用中的每个实体自动生成常见的文件。与Laravel PHP框架配合得相当默契,但其实独立于Laravel,可单独用于任何文件系统的代码生成。甚至,即使你的代码采用驼峰命名和下划线命名规则,如Java或JavaScript等,也能利用它进行定制。

黑铁匠核心特性

  • 灵活性:虽然内置了Laravel的六边形架构配置和模板,但黑铁匠允许你创建自己的模板并指定配置文件路径,从而实现完全自定义。
  • 多语言支持:尽管最初是为PHP和Laravel设计的,但通过模板变量,可以轻松适应其他编程语言的代码生成需求。
  • 一键更新:通过blacksmith self-update命令轻松升级到最新版本。
  • 智能Laravel生成器:特定的模板变量和后处理任务,使得与Laravel集成更为顺畅。

开箱即用的功能

黑铁匠默认提供以下单个生成器(生成单一文件):

  • model
  • controller
  • seed
  • migration_create
  • view_create
  • view_update
  • view_show
  • view_index
  • form
  • test_unit
  • test_functional
  • service_creator
  • service_updater
  • service_destroyer
  • validator

以及一个聚合生成器(调用多个生成器):

  • scaffold:一次性生成所有相关文件。

安装与使用

  1. 下载PHAR包:直接从本仓库下载blacksmith.phar,并将文件移到/usr/local/bin目录下命名为blacksmith,方便全局调用。
  2. 源码编译:通过Git克隆本项目,然后运行box build编译PHAR文件。
  3. 更新黑铁匠:使用blacksmith self-update命令获取最新版本。

使用示例:

blacksmith generate 用户 scaffold /path/to/config/file.json --fields="用户名:string, 年龄:integer"

这里用户是实体名称,scaffold是生成器,/path/to/config/file.json是配置文件路径,--fields用于指定字段。

自定义配置与模板

  • 配置文件:JSON格式,按需定制每个生成器的模板、目录和文件名。
  • 模板:基于Mustache语法的文本文件,可以使用提供的变量进行填充。

要了解更多详情,请查看项目完整README文档。

开始你的代码自动化之旅,让黑铁匠成为你开发过程中的得力助手!

登录后查看全文
热门项目推荐