fileboy是一个文件变更监听通知系统,使用Go编写。
适用于HotReload(典型的如开发go项目,无需每次手动执行gobuild;又比如前端node打包)或者系统监控的场景。
特性极简的用法和配置支持多平台,Windows/Linux/MacOS支持自定义文件监听范围,监听指定文件夹/不监听指定文件夹/指定后缀文件支持自定义监控事件(write/rename/remove/create/chmod)支持设置多条命令命令支持变量占位符支持冗余任务丢弃,自定义冗余任务范围支持http通知更多...编译环境goversion1.13
更新日志CHANGELOG
运行下载二进制文件Github: downloadv1.12Gitee: dowmloadv1.12
下载已经编译好的对应平台二进制文件,重命名为fileboy,加入系统Path中即可。
源码编译clone该项目,进入主目录,运行命令:
##安装依赖goget-ugopkg.in/fsnotify/fsnotify.v1goget-ugopkg.in/yaml.v2##编译gobuild##运行./fileboy使用fileboy的正常运行依赖于 filegirl.yaml 配置文件,因此首次在项目中使用需要初始化 filegirl.yaml。
进入你想要hotreload的项目主目录下;运行 fileboyinit,会在该目录下生成 filegirl.yaml文件;查看 filegirl.yaml,修改为适合自己项目的配置项;运行 fileboy即可.如果你定义了 command->exec命令,想事先确认是否能正常执行,可以运行 fileboyexec命令,系统会尝试运行你的自定义命令。你可以使用 fileboyhelp查看使用帮助。
filegirl.yaml配置文件说明#主配置core:#配置版本号version:1#监控配置monitor:#要监听的目录#test1监听当前目录下test1目录#test1/test2监听当前目录下test1/test2目录#test1,*监听当前目录下test1目录及其所有子目录(递归)#.,*监听当前目录及其所有子目录(递归)includeDirs:-.,*#不监听的目录#.idea忽略.idea目录及其所有子目录的监听exceptDirs:-.idea-.git-.vscode-node_modules-vendor#监听文件的格式,此类文件更改会执行command中的命令#.go后缀为.go的文件更改,会执行command中的命令#.*所有的文件更改都会执行command中的命令types:-.go#监听的事件类型,发生此类事件才执行command中的命令#没有该配置默认监听所有事件#write写入文件事件#rename重命名文件事件#remove移除文件事件#create创建文件事件#chmod更新文件权限事件(类unix)events:-write-rename-remove-create-chmod#命令command:#监听的文件有更改会执行的命令#可以有多条命令,会依次执行#如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行#如遇交互式命令,允许外部获取输入#支持变量占位符,运行命令时会替换成实际值:#{{file}}文件名(如a.txt、test/test2/a.go)#{{ext}}文件后缀(如.go)#{{event}}事件(上面的events,如write)#{{changed}}文件更新的本地时间戳(纳秒,如1537326690523046400)#变量占位符使用示例:cp{{file}}/root/sync-rf、myCommand--{{ext}}{{changed}}exec:-goversion-goenv#文件变更后命令在xx毫秒后才会执行,单位为毫秒#一个变更事件(A)如果在定义的延迟时间(t)内,又有新的文件变更事件(B),那么A会取消执行。#B及以后的事件均依次类推,直到事件Z在t内没有新事件产生,Z会执行#合理设置延迟时间,将有效减少冗余和重复任务的执行#如果不需要该特性,设置为0delayMillSecond:2000#通知器notifier:#文件更改会向该url发送请求(POST一段json文本数据)#触发请求的时机和执行command命令是一致的#请求超时15秒#POST格式:#Content-Type:application/json;charset=UTF-8#User-Agent:FileBoyNetNotifierv1.12#Body:{"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}#例:https://example.com/notifier/fileboy-listener#不启用通知,请留空""callUrl:""TODO 命令支持变量占位符 支持多命令 支持监听指定文件夹 支持不监听指定文件夹 支持监听指定后缀文件 支持自定事件监听 支持http通知 支持冗余任务丢弃 支持http合并任务的通知
评论