fileboy 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
fileboy 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
fileboy 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 Google Go
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 云中谷
适用人群 未知
收录时间 2018-09-11

软件简介

fileboy 是一个文件变更监听通知系统,使用 Go 编写。

适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。

特性

  • 极简的用法和配置
  • 支持多平台,Windows/Linux/MacOS
  • 支持自定义文件监听范围,监听指定文件夹/不监听指定文件夹/指定后缀文件
  • 支持自定义监控事件(write/rename/remove/create/chmod)
  • 支持设置多条命令
  • 命令支持变量占位符
  • 支持冗余任务丢弃,自定义冗余任务范围
  • 支持 http 通知
  • 更多...

编译环境

go version 1.13

更新日志

CHANGELOG

运行

下载二进制文件

Github: download v1.12
Gitee: dowmload v1.12

下载已经编译好的对应平台二进制文件,重命名为fileboy, 加入系统 Path 中即可。

源码编译

clone 该项目,进入主目录,运行命令:

## 安装依赖
go get -u gopkg.in/fsnotify/fsnotify.v1
go get -u gopkg.in/yaml.v2
## 编译
go build
## 运行
./fileboy

使用

fileboy 的正常运行依赖于 filegirl.yaml 配置文件,因此首次在项目中使用需要初始化 filegirl.yaml

  • 进入你想要 hot reload 的项目主目录下;
  • 运行 fileboy init,会在该目录下生成 filegirl.yaml文件;
  • 查看 filegirl.yaml,修改为适合自己项目的配置项;
  • 运行 fileboy即可.

如果你定义了 command -> exec命令,想事先确认是否能正常执行,可以运行 fileboy exec命令,系统会尝试运行你的自定义命令。
你可以使用 fileboy help查看使用帮助。

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:
        - go version
        - go env

    # 文件变更后命令在xx毫秒后才会执行,单位为毫秒
    # 一个变更事件(A)如果在定义的延迟时间(t)内,又有新的文件变更事件(B),那么A会取消执行。
    # B及以后的事件均依次类推,直到事件Z在t内没有新事件产生,Z 会执行
    # 合理设置延迟时间,将有效减少冗余和重复任务的执行
    # 如果不需要该特性,设置为 0
    delayMillSecond: 2000

# 通知器
notifier:
    # 文件更改会向该 url 发送请求(POST 一段 json 文本数据)
    # 触发请求的时机和执行 command 命令是一致的
    # 请求超时 15 秒
    # POST 格式:
    #    Content-Type: application/json;charset=UTF-8
    #    User-Agent: FileBoy Net Notifier v1.12
    #    Body: {"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}
    # 例: http://example.com/notifier/fileboy-listener
    # 不启用通知,请留空 ""
    callUrl: ""

TODO

  •  命令支持变量占位符
  •  支持多命令
  •  支持监听指定文件夹
  •  支持不监听指定文件夹
  •  支持监听指定后缀文件
  •  支持自定事件监听
  •  支持 http 通知
  •  支持冗余任务丢弃
  •  支持 http 合并任务的通知
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (1)

加载中
windows 下 好像配置 监控的文件夹 不管什么格式都不监控
2018/09/29 18:25
回复
举报
更多评论
发表于运维专区
2019/12/19 10:10

fileboy v1.12 发布,文件变更监听通知系统,开发利器!

fileboy,文件变更监听通知系统,使用 Go 编写。 适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 v1.12 更新日志: 增加 自定义监控事件(write/rename/remove/create/chmod) 增加 {{event}} 事件名占位符 / event 网络通知字段 增加 文件(夹)变更动态添加/删除监听(beta) 优化 init 命令,如果已有filegirl.yaml现在提示错误,不会自动覆盖 优化 日志输出...

4
50
发表于运维专区
2019/04/18 09:21

fileboy v1.9 发布,文件变更监听通知系统

fileboy,文件变更监听通知系统,使用 Go 编写。 适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 v1.9 版本更新日志: 优化 文件夹监听效率,减少大量深层文件夹遍历的时间 优化 代码逻辑 增加 readme 英文说明 修复 偶现监听项目主目录无效的问题 增加 includeDirs 参数规则验证 修改 delayMillSecond 默认值,2000 修复 time 内存 修复 某些情况下cmd异常...

0
47
发表于DevOps专区
2019/01/04 09:30

fileboy v1.5 发布,文件变更监听通知系统

fileboy,文件变更监听通知系统,使用 Go 编写。 适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 v1.5 版本更新日志: 增加 http 通知 增加 callUrl 参数 优化 command 稳定性 增加 command -> delayMillSecond 参数 优化 文案 增加 在指定时间内堆叠的任务自动丢弃 增加 version 信息 优化 代码逻辑 下载(Giteee源): Windows | Linux | Darwin 下载(Gite...

5
51
发表于DevOps专区
2018/09/20 09:16

fileboy v1.1 发布,文件变更监听通知系统

fileboy,文件变更监听通知系统,使用 GO 编写。 适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 Release v1.1 更新说明: 增加 command 命令支持变量占位符 {{file}}、{{ext}}、{{changed}}; # {{file}}    文件名(如 a.txt 、test/test2/a.go) # {{ext}}     文件后缀(如 .go) # {{changed}} 文件更新的本地时间戳(纳秒,如 1537326...

2
13
发表于DevOps专区
2018/09/12 09:29

fileboy v1.0 发布,文件变更监听通知系统

fileboy,文件变更监听通知系统,使用 Go 编写。适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 v1.0 更新日志: - 文件变更监听支持多平台 (windows/linux测试,mac未测试); - 支持灵活配置监听 包含文件夹/排除文件夹/特定文件类型; - 支持配置变更要运行命令,可以有多条,会依次执行; - 支持 fileboy init 初始化配置,生成 filegirl.yaml 文件;...

0
12
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表于开发技能专区
2020/08/22 10:06

hyperf 学习小记 - 3 精简入门实践教程

# hyperf 学习小记 - 3 精简入门实践教程 ## 摘要 | 条目 | 说明 | |--|--| |内容说明|可以快速套用熟悉的MVC模式进入实战的最简引导教程| |上手难度|中低| |花费时间|边看边练,1小时左右| ## 练习目标 可以试着以最原始的练习题目 —— 实现一个留言板功能 —— 为小目标去学习,将下面的知识串联起来。 ## 常用组件/功能 ### 配置 此处仅介绍主要需要关注的文件: **环境变量 .env** 默认没有,请手动拷贝 .env.example 生成...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
1 评论
58 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部