Skip to content

caixw/gobuild

Repository files navigation

gobuild

Latest Release Test PkgGoDev Go version License codecov

gobuild 是一个简单的 Go 代码热编译工具。 会实时监控指定目录下的文件变化(重命名,删除,创建,添加),并编译和运行程序。

  • 采用配置文件,表达更加方便和直观;
  • 自动生成配置文件;
  • 自动监视 go.mod 中的 Replace 目录;
  • 本地化支持;

命令行语法

主要包含了 watch 和 init 两个子命令。具体的子命令可以通过 gobuild help 查看。

init

初始化项目,添加项目的必备的文件,比如热编译的配置文件 .gobuild.yaml。 如果是空目录,还会顺带初始化 go.mod 等文件。

gobuild init github.com/owner/mod

watch

监视文件并进行热编译,热编译的配置项从当前目录下的 .gobuild.yaml 加载。

gobuild watch [options]

配置文件

配置文件为当前目录下的 .gobuild.yaml,可由 gobuild init 子命令生成,包含了以下字段:

字段 类型 描述
main string 指定需要编译的文件,如果为空表示当前目录。
output string 指定可执行文件输出的文件路径
args string 传递给编译器的参数
exts []string 指定监视的文件扩展名,如果包含了 *,表示所有文件类型,包括没有扩展名的。
appArgs string 传递给编译成功后的程序的参数
freq duration 监视器的更新频率
excludes []string 忽略的文件,glob 格式,高于 exts 配置项。

安装

macOS 和 linux 用户可以直接使用 brew 进行安装:

brew tap caixw/brew
brew install caixw/brew/gobuild

常用平台可以从 https://github.com/caixw/gobuild/releases 下载,并将二进制文件放入 PATH 即可。

如果不存在你当前平台的二进制,可以自己编译:

git clone https://github.com/caixw/gobuild.git
cd gobuild
./build.sh

版权

本项目采用 MIT 开源授权许可证,完整的授权说明可在 LICENSE 文件中找到。