Compare commits
37 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
2436e7b4e1 | ||
|
09b1de75b3 | ||
|
27f934d6fb | ||
|
92af817777 | ||
|
5f0b16cbdb | ||
|
4fbe75f828 | ||
|
4f6d1bd68c | ||
|
3ffa24d4fa | ||
|
87cde6a03a | ||
|
84aad1bfb8 | ||
|
a1cfbb0c73 | ||
|
7cb0231a1d | ||
|
c1affe1109 | ||
|
4ff6fce5d2 | ||
|
331f449733 | ||
|
7604ec07f7 | ||
|
afcceb7753 | ||
|
755a7e8c07 | ||
|
308ff29151 | ||
|
22072d1e49 | ||
|
19c5eaa819 | ||
|
3e31b5b375 | ||
|
a5fb3aea36 | ||
|
cae4bf355e | ||
|
22fca4f68e | ||
|
b40feaf441 | ||
|
e9ed699f71 | ||
|
3739cbe98e | ||
|
d486353d9b | ||
|
2a87304923 | ||
|
73b048ad1a | ||
|
2b6d37659a | ||
|
7c77562909 | ||
|
0639b906ec | ||
|
843fe170ae | ||
|
0490cb7ad2 | ||
|
98c6ef9b3f |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -2,3 +2,7 @@
|
|||||||
fileboy
|
fileboy
|
||||||
fileboy.exe
|
fileboy.exe
|
||||||
filegirl.yaml
|
filegirl.yaml
|
||||||
|
fileboy-darwin-amd64.bin
|
||||||
|
fileboy-linux-amd64.bin
|
||||||
|
fileboy-windows-amd64.exe
|
||||||
|
|
||||||
|
68
CHANGELOG.md
Normal file
68
CHANGELOG.md
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
### Release v1.5
|
||||||
|
|
||||||
|
2019.01.03
|
||||||
|
|
||||||
|
- 增加 http 通知
|
||||||
|
- 增加 callUrl 参数
|
||||||
|
- 优化 command 稳定性
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
2019.01.02
|
||||||
|
|
||||||
|
- 增加 command -> delayMillSecond 参数
|
||||||
|
- 优化 文案
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
2018.12.30
|
||||||
|
|
||||||
|
- 增加 在指定时间内堆叠的任务自动丢弃
|
||||||
|
- 增加 version 信息
|
||||||
|
- 优化 代码逻辑
|
||||||
|
- 优化 提示文案
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Release v1.2
|
||||||
|
|
||||||
|
2018.09.30
|
||||||
|
|
||||||
|
- 修复 递归监听会忽略主级目录的bug
|
||||||
|
- 增加 `fileboy version`命令
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Release v1.1
|
||||||
|
|
||||||
|
2018.09.19
|
||||||
|
|
||||||
|
- command 命令支持变量占位符 `{{file}}`、`{{ext}}`、`{{changed}}`;
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# {{file}} 文件名(如 a.txt 、test/test2/a.go)
|
||||||
|
# {{ext}} 文件后缀(如 .go)
|
||||||
|
# {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400)
|
||||||
|
# 变量占位符使用示例:cp {{file}} /root/sync -rf 、 myCommand --{{ext}} {{changed}}
|
||||||
|
```
|
||||||
|
|
||||||
|
- 增加 较深目录递归提示;
|
||||||
|
- 优化 文字提示;
|
||||||
|
- 修复 command 命令执行时目录不正确的问题;
|
||||||
|
- 修复 其他bug;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Release v1.0
|
||||||
|
|
||||||
|
2018.09.10
|
||||||
|
|
||||||
|
- 文件变更监听支持多平台 (windows/linux测试,mac未测试);
|
||||||
|
|
||||||
|
- 支持灵活配置监听 包含文件夹/排除文件夹/特定文件类型;
|
||||||
|
|
||||||
|
- 支持配置变更要运行命令,可以有多条,会依次执行;
|
||||||
|
|
||||||
|
- 支持 fileboy init 初始化配置,生成 filegirl.yaml 文件;
|
||||||
|
|
||||||
|
- 支持 fileboy exec 直接执行配置的 command 命令;
|
104
README.md
104
README.md
@@ -1,18 +1,37 @@
|
|||||||
## 项目说明
|
## 项目说明
|
||||||
|
|
||||||
fileboy,文件变更监听通知系统,使用 GO 编写。
|
fileboy,文件变更监听通知系统,使用 Go 编写。
|
||||||
|
|
||||||
适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。
|
适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。
|
||||||
|
|
||||||
|
## 特性
|
||||||
|
|
||||||
|
- 极简的用法和配置
|
||||||
|
- 支持多平台,Windows/Linux/MacOS
|
||||||
|
- 支持自定义文件监听范围,监听指定文件夹/不监听指定文件夹/指定后缀文件
|
||||||
|
- 支持设置多条命令
|
||||||
|
- 命令支持变量占位符
|
||||||
|
- 支持冗余任务丢弃,自定义冗余任务范围
|
||||||
|
- 支持 http 通知
|
||||||
|
- 更多...
|
||||||
|
|
||||||
## 编译环境
|
## 编译环境
|
||||||
|
|
||||||
go version >=1.10
|
go version >=1.10,推荐 1.11
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
|
||||||
|
[CHANGELOG](CHANGELOG.md)
|
||||||
|
|
||||||
|
|
||||||
## 运行
|
## 运行
|
||||||
|
|
||||||
### 直接下载二进制文件
|
### 下载二进制文件
|
||||||
|
|
||||||
直接下载已经编译好的对应平台二进制文件,加入系统 Path 中即可。
|
Github: [正式版 v1.5](https://github.com/dengsgo/fileboy/releases)
|
||||||
|
Gitee: [正式版 v1.5](https://gitee.com/dengsgo/fileboy/releases)
|
||||||
|
|
||||||
|
下载已经编译好的对应平台二进制文件,重命名为`fileboy`, 加入系统 Path 中即可。
|
||||||
|
|
||||||
### 源码编译
|
### 源码编译
|
||||||
|
|
||||||
@@ -40,7 +59,7 @@ fileboy 的正常运行依赖于 `filegirl.yaml` 配置,所以首次在项目
|
|||||||
|
|
||||||
- 运行 `fileboy`即可.
|
- 运行 `fileboy`即可.
|
||||||
|
|
||||||
如果你定义了 `commend -> exec`命令,想事先确认是否能正常执行,可以运行 `fileboy exec`命令,系统会尝试运行你的自定义命令。
|
如果你定义了 `command -> exec`命令,想事先确认是否能正常执行,可以运行 `fileboy exec`命令,系统会尝试运行你的自定义命令。
|
||||||
|
|
||||||
你可以使用 `fileboy help`查看使用帮助。
|
你可以使用 `fileboy help`查看使用帮助。
|
||||||
|
|
||||||
@@ -68,10 +87,12 @@ monitor:
|
|||||||
- .idea
|
- .idea
|
||||||
- .git
|
- .git
|
||||||
- .vscode
|
- .vscode
|
||||||
|
- node_modules
|
||||||
|
- vendor
|
||||||
|
|
||||||
# 监听文件的格式,此类文件更改会执行 commend 中的命令
|
# 监听文件的格式,此类文件更改会执行 command 中的命令
|
||||||
# .go 后缀为 .go 的文件更改,会执行 commend 中的命令
|
# .go 后缀为 .go 的文件更改,会执行 command 中的命令
|
||||||
# .* 所有的文件更改都会执行 commend 中的命令
|
# .* 所有的文件更改都会执行 command 中的命令
|
||||||
types:
|
types:
|
||||||
- .go
|
- .go
|
||||||
|
|
||||||
@@ -81,11 +102,49 @@ command:
|
|||||||
# 可以有多条命令,会依次执行
|
# 可以有多条命令,会依次执行
|
||||||
# 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行
|
# 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行
|
||||||
# 如遇交互式命令,允许外部获取输入
|
# 如遇交互式命令,允许外部获取输入
|
||||||
|
# 支持变量占位符,运行命令时会替换成实际值:
|
||||||
|
# {{file}} 文件名(如 a.txt 、test/test2/a.go)
|
||||||
|
# {{ext}} 文件后缀(如 .go)
|
||||||
|
# {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400)
|
||||||
|
# 变量占位符使用示例:cp {{file}} /root/sync -rf 、 myCommand --{{ext}} {{changed}}
|
||||||
exec:
|
exec:
|
||||||
- go version
|
- go version
|
||||||
- go env
|
- go env
|
||||||
|
|
||||||
|
# 文件变更后命令会在xx毫秒后才会执行,单位为毫秒
|
||||||
|
# 一个变更事件(A)如果在定义的延迟时间(t)内,又有新的文件变更事件(B),那么A会取消执行。
|
||||||
|
# B及以后的事件均依次类推,直到事件Z在t内没有新事件产生,Z 会执行
|
||||||
|
# 合理设置延迟时间,将有效减少冗余和重复任务的执行
|
||||||
|
# 如果不需要该特性,设置为 0
|
||||||
|
delayMillSecond: 1000
|
||||||
|
|
||||||
|
# 通知器
|
||||||
|
notifier:
|
||||||
|
# 文件更改会向该 url 发送请求(POST 一段 json 文本数据)
|
||||||
|
# 触发请求的时机和执行 command 命令是一致的
|
||||||
|
# 请求超时 15 秒
|
||||||
|
# POST 格式:
|
||||||
|
# Content-Type: application/json;charset=UTF-8
|
||||||
|
# User-Agent: FileBoy Net Notifier v1.5
|
||||||
|
# Body: {"project_folder":"/watcher-dirs","file":"test.go","changed":1546421173070433800,"ext":".go"}
|
||||||
|
# 例: http://example.com/notifier/fileboy-listener
|
||||||
|
# 不启用通知,请留空
|
||||||
|
callUrl: ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### TODO
|
||||||
|
|
||||||
|
- [x] 命令支持变量占位符
|
||||||
|
- [x] 支持多命令
|
||||||
|
- [x] 支持监听指定文件夹
|
||||||
|
- [x] 支持不监听指定文件夹
|
||||||
|
- [x] 支持监听指定后缀文件
|
||||||
|
- [x] 支持 http 通知
|
||||||
|
- [x] 支持冗余任务丢弃
|
||||||
|
- [ ] 支持 http 合并任务的通知
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## QA
|
## QA
|
||||||
|
|
||||||
#### 很多框架都自带了 hot reload 的功能,为什么还要单独写个 fileboy 呢?
|
#### 很多框架都自带了 hot reload 的功能,为什么还要单独写个 fileboy 呢?
|
||||||
@@ -96,17 +155,21 @@ command:
|
|||||||
|
|
||||||
在开发中,我们很需要一款可以帮助我们自动打包编译的工具,那 fileboy 就非常适合这样的场景。比如 go 项目的热编译,让我们可以边修改代码边运行得到反馈。又比如 PHP Swoole 框架,由于常驻进程的原因,无法更改代码立即reload,使用 fileboy 就可以辅助做到传统 PHP 开发的体验。
|
在开发中,我们很需要一款可以帮助我们自动打包编译的工具,那 fileboy 就非常适合这样的场景。比如 go 项目的热编译,让我们可以边修改代码边运行得到反馈。又比如 PHP Swoole 框架,由于常驻进程的原因,无法更改代码立即reload,使用 fileboy 就可以辅助做到传统 PHP 开发的体验。
|
||||||
|
|
||||||
对于一些需要监控文件日志或者配置变动的场景, fileboy 同样适合。你可以事先编写好相应的通知报警脚本,然后定义`filegirl.yaml`中的`commend`命令,交由 fileboy 自动运行监控报警。
|
对于一些需要监控文件日志或者配置变动的场景, fileboy 同样适合。你可以事先编写好相应的通知报警脚本,然后定义`filegirl.yaml`中的`command`命令,交由 fileboy 自动运行监控报警。
|
||||||
|
|
||||||
#### idea 下更改文件,为什么会执行两次或者多次 commend ?
|
#### 通知器在什么时候会发送 http 请求 ?
|
||||||
|
|
||||||
由于 idea 系列软件特殊的文件保存策略,他会自动创建一些临时文件,并且在需要时多次重写文件,所以有时反映在文件上就是有多次的更改,所以会出现这种情况。这个后续会做优化.
|
通知器发送 http 通知的前提是在配置文件中设置了 `callUrl` 参数(不为空即为已设置)。触发请求的时机和执行 command 命令是一致的,`command -> delayMillSecond` 参数对于触发器同样有效。请求超时默认15秒.
|
||||||
|
|
||||||
#### filegirl.yaml 里面的 commend 不支持复杂的命令吗?
|
#### idea 下更改文件,为什么会执行两次或者多次 command ?
|
||||||
|
|
||||||
|
由于 idea 系列软件特殊的文件保存策略,他会自动创建一些临时文件,并且在需要时多次重写文件,所以有时反映在文件上就是有多次的更改,所以会出现这种情况。1.5版本增加了 `delayMillSecond` 参数,可以解决这个问题。
|
||||||
|
|
||||||
|
#### filegirl.yaml 里面的 command 不支持复杂的命令吗?
|
||||||
|
|
||||||
对于“很复杂的命令”这种说法很难去定义,比如 `echo "hello world"`并不复杂,但是对于 fileboy 来讲,目前无法解析这种命令。
|
对于“很复杂的命令”这种说法很难去定义,比如 `echo "hello world"`并不复杂,但是对于 fileboy 来讲,目前无法解析这种命令。
|
||||||
|
|
||||||
fileboy 目前支持 `命令 + 参数`这种形式的 commend,而且 参数中不能有""符号或者有空格。如:
|
fileboy 目前支持 `命令 + 参数`这种形式的 command,而且 参数中不能有""符号或者有空格。如:
|
||||||
|
|
||||||
`go build`:支持;
|
`go build`:支持;
|
||||||
|
|
||||||
@@ -116,12 +179,19 @@ fileboy 目前支持 `命令 + 参数`这种形式的 commend,而且 参数中
|
|||||||
|
|
||||||
`cat a.txt | grep "q" | wc -l`:不支持
|
`cat a.txt | grep "q" | wc -l`:不支持
|
||||||
|
|
||||||
对于不支持的命令,可以把它写到一个文件里,然后在 commend 中执行这个文件来解决。
|
对于不支持的命令,可以把它写到一个文件里,然后在 command 中执行这个文件来解决。
|
||||||
|
|
||||||
#### 为什么起名为 fileboy,又把配置名叫做 filegirl ?
|
#### 为什么起名为 fileboy,又把配置名叫做 filegirl ?
|
||||||
|
|
||||||
因为爱情~~
|
因为爱情~~ (◡ᴗ◡✿)
|
||||||
|
|
||||||
#### 听说有彩蛋?
|
|
||||||
|
|
||||||
(◡ᴗ◡✿)
|
|
||||||
|
### 贡献者
|
||||||
|
|
||||||
|
> 排名不分先后
|
||||||
|
|
||||||
|
[@dengsgo](https://www.yoytang.com) <dengsgo@yoytang.com>
|
||||||
|
|
||||||
|
[@itwesley](https://github.com/itwesley) <wcshen1126@gmail.com>
|
||||||
|
|
||||||
|
@@ -3,6 +3,6 @@ echo build start...
|
|||||||
SET CGO_ENABLED=0
|
SET CGO_ENABLED=0
|
||||||
SET GOOS=darwin
|
SET GOOS=darwin
|
||||||
SET GOARCH=amd64
|
SET GOARCH=amd64
|
||||||
go build -ldflags "-s -w"
|
go build -ldflags "-s -w" -o fileboy-darwin-amd64.bin
|
||||||
echo build success
|
echo build success
|
||||||
pause
|
pause
|
@@ -3,6 +3,6 @@ echo build start...
|
|||||||
SET CGO_ENABLED=0
|
SET CGO_ENABLED=0
|
||||||
SET GOOS=linux
|
SET GOOS=linux
|
||||||
SET GOARCH=amd64
|
SET GOARCH=amd64
|
||||||
go build -ldflags "-s -w"
|
go build -ldflags "-s -w" -o fileboy-linux-amd64.bin
|
||||||
echo build success
|
echo build success
|
||||||
pause
|
pause
|
@@ -3,6 +3,6 @@ echo build start...
|
|||||||
SET CGO_ENABLED=0
|
SET CGO_ENABLED=0
|
||||||
SET GOOS=windows
|
SET GOOS=windows
|
||||||
SET GOARCH=amd64
|
SET GOARCH=amd64
|
||||||
go build -ldflags "-s -w"
|
go build -ldflags "-s -w" -o fileboy-windows-amd64.exe
|
||||||
echo build success
|
echo build success
|
||||||
pause
|
pause
|
97
fileboy.go
97
fileboy.go
@@ -1,18 +1,14 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"gopkg.in/fsnotify/fsnotify.v1"
|
"gopkg.in/fsnotify/fsnotify.v1"
|
||||||
"gopkg.in/yaml.v2"
|
"gopkg.in/yaml.v2"
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"log"
|
"log"
|
||||||
"math/rand"
|
"math/rand"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
|
||||||
"path"
|
"path"
|
||||||
"sync"
|
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -21,20 +17,19 @@ const (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
projectFolder string = "."
|
projectFolder = "."
|
||||||
|
|
||||||
cfg *FileGirl
|
cfg *FileGirl
|
||||||
|
|
||||||
watcher *fsnotify.Watcher
|
watcher *fsnotify.Watcher
|
||||||
|
|
||||||
cmd *exec.Cmd
|
taskMan *TaskMan
|
||||||
|
|
||||||
runLock sync.Mutex
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type wDirState struct {
|
type changedFile struct {
|
||||||
Name string
|
Name string
|
||||||
Recursive bool
|
Changed int64
|
||||||
|
Ext string
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseConfig() {
|
func parseConfig() {
|
||||||
@@ -62,61 +57,22 @@ func eventDispatcher(event fsnotify.Event) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
switch event.Op {
|
switch event.Op {
|
||||||
case fsnotify.Create:
|
case
|
||||||
case fsnotify.Write:
|
fsnotify.Write,
|
||||||
log.Println("event write : ", event.Name)
|
fsnotify.Rename:
|
||||||
if cmd != nil {
|
log.Println("EVENT", event.Op.String(), ":", event.Name)
|
||||||
err := cmd.Process.Kill()
|
taskMan.Put(&changedFile{
|
||||||
if err != nil {
|
Name: relativePath(projectFolder, event.Name),
|
||||||
log.Println("err: ", err)
|
Changed: time.Now().UnixNano(),
|
||||||
}
|
Ext: ext,
|
||||||
log.Println("stop old process ")
|
})
|
||||||
}
|
|
||||||
go run()
|
|
||||||
case fsnotify.Remove:
|
case fsnotify.Remove:
|
||||||
case fsnotify.Rename:
|
case fsnotify.Create:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func run() {
|
|
||||||
runLock.Lock()
|
|
||||||
defer runLock.Unlock()
|
|
||||||
for i := 0; i < len(cfg.Command.Exec); i++ {
|
|
||||||
carr := cmdParse2Array(cfg.Command.Exec[i])
|
|
||||||
cmd = exec.Command(carr[0], carr[1:]...)
|
|
||||||
//cmd.SysProcAttr = &syscall.SysProcAttr{CreationFlags: syscall.CREATE_UNICODE_ENVIRONMENT}
|
|
||||||
cmd.Stdin = os.Stdin
|
|
||||||
//cmd.Stdout = os.Stdout
|
|
||||||
cmd.Stderr = os.Stderr
|
|
||||||
stdout, err := cmd.StdoutPipe()
|
|
||||||
if err != nil {
|
|
||||||
log.Println("error=>", err.Error())
|
|
||||||
return
|
|
||||||
}
|
|
||||||
cmd.Start()
|
|
||||||
reader := bufio.NewReader(stdout)
|
|
||||||
for {
|
|
||||||
line, err2 := reader.ReadString('\n')
|
|
||||||
if err2 != nil || io.EOF == err2 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
log.Print(line)
|
|
||||||
}
|
|
||||||
err = cmd.Wait()
|
|
||||||
if err != nil {
|
|
||||||
log.Println("cmd wait err ", err)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
err = cmd.Process.Kill()
|
|
||||||
if err != nil {
|
|
||||||
log.Println("cmd cannot kill ", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Println("end ")
|
|
||||||
}
|
|
||||||
|
|
||||||
func addWatcher() {
|
func addWatcher() {
|
||||||
|
log.Println("collecting directory information...")
|
||||||
dirs := make([]string, 0)
|
dirs := make([]string, 0)
|
||||||
for i := 0; i < len(cfg.Monitor.IncludeDirs); i++ {
|
for i := 0; i < len(cfg.Monitor.IncludeDirs); i++ {
|
||||||
darr := dirParse2Array(cfg.Monitor.IncludeDirs[i])
|
darr := dirParse2Array(cfg.Monitor.IncludeDirs[i])
|
||||||
@@ -135,12 +91,14 @@ func addWatcher() {
|
|||||||
}
|
}
|
||||||
break
|
break
|
||||||
} else {
|
} else {
|
||||||
|
md := projectFolder + "/" + darr[0]
|
||||||
if len(darr) == 2 && darr[1] == "*" {
|
if len(darr) == 2 && darr[1] == "*" {
|
||||||
listFile(projectFolder+"/"+darr[0], func(d string) {
|
dirs = arrayUniqueAdd(dirs, md)
|
||||||
|
listFile(md, func(d string) {
|
||||||
dirs = arrayUniqueAdd(dirs, d)
|
dirs = arrayUniqueAdd(dirs, d)
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
dirs = arrayUniqueAdd(dirs, projectFolder+"/"+darr[0])
|
dirs = arrayUniqueAdd(dirs, md)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -172,6 +130,7 @@ func initWatcher() {
|
|||||||
defer watcher.Close()
|
defer watcher.Close()
|
||||||
|
|
||||||
done := make(chan bool)
|
done := make(chan bool)
|
||||||
|
taskMan = newTaskMan(cfg.Command.DelayMillSecond, cfg.Notifier.CallUrl)
|
||||||
go func() {
|
go func() {
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
@@ -197,9 +156,8 @@ func parseArgs() {
|
|||||||
if l == 1 {
|
if l == 1 {
|
||||||
_, err := ioutil.ReadFile(projectFolder + "/filegirl.yaml")
|
_, err := ioutil.ReadFile(projectFolder + "/filegirl.yaml")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Println("the filegirl.yaml file is not exist! ", err)
|
log.Println("the filegirl.yaml file does not exist! ", err)
|
||||||
fmt.Print(firstRunHelp)
|
fmt.Print(firstRunHelp)
|
||||||
fmt.Print(helpStr)
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
initWatcher()
|
initWatcher()
|
||||||
@@ -218,8 +176,10 @@ func parseArgs() {
|
|||||||
return
|
return
|
||||||
case "exec":
|
case "exec":
|
||||||
parseConfig()
|
parseConfig()
|
||||||
run()
|
newTaskMan(0, cfg.Notifier.CallUrl).run(new(changedFile))
|
||||||
return
|
return
|
||||||
|
case "version", "v", "-v", "--version":
|
||||||
|
fmt.Println(versionDesc)
|
||||||
default:
|
default:
|
||||||
fmt.Print(helpStr)
|
fmt.Print(helpStr)
|
||||||
}
|
}
|
||||||
@@ -230,8 +190,9 @@ func parseArgs() {
|
|||||||
func show() {
|
func show() {
|
||||||
fmt.Print(logo)
|
fmt.Print(logo)
|
||||||
rand.Seed(time.Now().UnixNano())
|
rand.Seed(time.Now().UnixNano())
|
||||||
fmt.Println(englishSay[rand.Intn(len(englishSay))], "\r\n")
|
fmt.Println(englishSay[rand.Intn(len(englishSay))])
|
||||||
fmt.Println("Version: ", Version, " Author: deng@yoytang.com")
|
fmt.Println("")
|
||||||
|
fmt.Println(statement)
|
||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
@@ -10,8 +10,10 @@ type FileGirl struct {
|
|||||||
ExceptDirs []string `yaml:"exceptDirs"`
|
ExceptDirs []string `yaml:"exceptDirs"`
|
||||||
}
|
}
|
||||||
Command struct {
|
Command struct {
|
||||||
//BeforeExec string `yaml:"beforeExec"`
|
Exec []string `yaml:"exec"`
|
||||||
Exec []string `yaml:"exec"`
|
DelayMillSecond int `yaml:"delayMillSecond"`
|
||||||
//AfterExec string `yaml:"afterExec"`
|
}
|
||||||
|
Notifier struct {
|
||||||
|
CallUrl string `yaml:"callUrl"`
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
70
notifer.go
Normal file
70
notifer.go
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type postParams struct {
|
||||||
|
ProjectFolder string `json:"project_folder"`
|
||||||
|
File string `json:"file"`
|
||||||
|
Changed int64 `json:"changed"`
|
||||||
|
Ext string `json:"ext"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type NetNotifier struct {
|
||||||
|
CallUrl string
|
||||||
|
CanPost bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newNetNotifier(callUrl string) *NetNotifier {
|
||||||
|
callPost := true
|
||||||
|
if strings.TrimSpace(callUrl) == "" {
|
||||||
|
callPost = false
|
||||||
|
}
|
||||||
|
return &NetNotifier{
|
||||||
|
CallUrl: callUrl,
|
||||||
|
CanPost: callPost,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *NetNotifier) Put(cf *changedFile) {
|
||||||
|
if !n.CanPost {
|
||||||
|
log.Println("notifier call url ignore. ", n.CallUrl)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
n.dispatch(&postParams{
|
||||||
|
ProjectFolder: projectFolder,
|
||||||
|
File: cf.Name,
|
||||||
|
Changed: cf.Changed,
|
||||||
|
Ext: cf.Ext,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *NetNotifier) dispatch(params *postParams) {
|
||||||
|
b, err := json.Marshal(params)
|
||||||
|
if err != nil {
|
||||||
|
log.Println("error: json.Marshal n.params. ", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
client := &http.Client{
|
||||||
|
Timeout: time.Second * 15,
|
||||||
|
}
|
||||||
|
req, err := http.NewRequest("POST", n.CallUrl, bytes.NewBuffer(b))
|
||||||
|
if err != nil {
|
||||||
|
log.Println("error: http.NewRequest. ", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", "application/json;charset=UTF-8")
|
||||||
|
req.Header.Set("User-Agent", "FileBoy Net Notifier v1.5")
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode >= 300 {
|
||||||
|
// todo retry???
|
||||||
|
}
|
||||||
|
log.Println("notifier done .")
|
||||||
|
}
|
53
raw.go
53
raw.go
@@ -1,5 +1,7 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
var exampleFileGirl string = `# 主配置
|
var exampleFileGirl string = `# 主配置
|
||||||
core:
|
core:
|
||||||
# 配置版本号
|
# 配置版本号
|
||||||
@@ -21,10 +23,12 @@ monitor:
|
|||||||
- .idea
|
- .idea
|
||||||
- .git
|
- .git
|
||||||
- .vscode
|
- .vscode
|
||||||
|
- node_modules
|
||||||
|
- vendor
|
||||||
|
|
||||||
# 监听文件的格式,此类文件更改会执行 commend 中的命令
|
# 监听文件的格式,此类文件更改会执行 command 中的命令
|
||||||
# .go 后缀为 .go 的文件更改,会执行 commend 中的命令
|
# .go 后缀为 .go 的文件更改,会执行 command 中的命令
|
||||||
# .* 所有的文件更改都会执行 commend 中的命令
|
# .* 所有的文件更改都会执行 command 中的命令
|
||||||
types:
|
types:
|
||||||
- .go
|
- .go
|
||||||
|
|
||||||
@@ -34,14 +38,39 @@ command:
|
|||||||
# 可以有多条命令,会依次执行
|
# 可以有多条命令,会依次执行
|
||||||
# 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行
|
# 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行
|
||||||
# 如遇交互式命令,允许外部获取输入
|
# 如遇交互式命令,允许外部获取输入
|
||||||
|
# 支持变量占位符,运行命令时会替换成实际值:
|
||||||
|
# {{file}} 文件名(如 a.txt 、test/test2/a.go)
|
||||||
|
# {{ext}} 文件后缀(如 .go)
|
||||||
|
# {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400)
|
||||||
|
# 变量占位符使用示例:cp {{file}} /root/sync -rf 、 myCommand --{{ext}} {{changed}}
|
||||||
exec:
|
exec:
|
||||||
- go version
|
- go version
|
||||||
- go env
|
- go env
|
||||||
|
|
||||||
|
# 文件变更后命令会在xx毫秒后才会执行,单位为毫秒
|
||||||
|
# 一个变更事件(A)如果在定义的延迟时间(t)内,又有新的文件变更事件(B),那么A会取消执行。
|
||||||
|
# B及以后的事件均依次类推,直到事件Z在t内没有新事件产生,Z 会执行
|
||||||
|
# 合理设置延迟时间,将有效减少冗余和重复任务的执行
|
||||||
|
# 如果不需要该特性,设置为 0
|
||||||
|
delayMillSecond: 1000
|
||||||
|
|
||||||
|
# 通知器
|
||||||
|
notifier:
|
||||||
|
# 文件更改会向该 url 发送请求(POST 一段 json 文本数据)
|
||||||
|
# 触发请求的时机和执行 command 命令是一致的
|
||||||
|
# 请求超时 15 秒
|
||||||
|
# POST 格式:
|
||||||
|
# Content-Type: application/json;charset=UTF-8
|
||||||
|
# User-Agent: FileBoy Net Notifier v1.5
|
||||||
|
# Body: {"project_folder":"/watcher-dirs","file":"test.go","changed":1546421173070433800,"ext":".go"}
|
||||||
|
# 例: http://example.com/notifier/fileboy-listener
|
||||||
|
# 不启用通知,请留空
|
||||||
|
callUrl: ""
|
||||||
`
|
`
|
||||||
|
|
||||||
var firstRunHelp = `第一次运行 fileboy ?
|
var firstRunHelp = `第一次运行 fileboy ?
|
||||||
你可能需要先执行 fileboy init 生成配置。
|
你可能需要先执行 fileboy init 生成配置。
|
||||||
更多信息查看帮助:
|
更多信息使用 fileboy help 查看帮助
|
||||||
`
|
`
|
||||||
|
|
||||||
var helpStr = `fileboy [option]
|
var helpStr = `fileboy [option]
|
||||||
@@ -51,7 +80,9 @@ Usage of fileboy:
|
|||||||
init
|
init
|
||||||
初始化 fileboy, 在当前目录生成 filegirl.yaml 配置文件
|
初始化 fileboy, 在当前目录生成 filegirl.yaml 配置文件
|
||||||
exec
|
exec
|
||||||
尝试运行定义的 commend 命令
|
尝试运行定义的 command 命令
|
||||||
|
version
|
||||||
|
查看当前版本信息
|
||||||
`
|
`
|
||||||
|
|
||||||
var englishSay = []string{
|
var englishSay = []string{
|
||||||
@@ -73,5 +104,15 @@ var logo = `
|
|||||||
_____ _ | | _____ ____) ) | | | |___| |
|
_____ _ | | _____ ____) ) | | | |___| |
|
||||||
| ___) | | | | | ___) | __ (| | | |\_____/
|
| ___) | | | | | ___) | __ (| | | |\_____/
|
||||||
| | _| |_| |_____| |_____| |__) ) |___| | ___
|
| | _| |_| |_____| |_____| |__) ) |___| | ___
|
||||||
|_| (_____)_______)_______)______/ \_____/ (___)
|
|_| (_____)_______)_______)______/ \_____/ (___) V1.5
|
||||||
|
`
|
||||||
|
var statement = `Dengsgo [dengsgo@gmail.com] Open Source with MIT License`
|
||||||
|
|
||||||
|
var versionDesc = `
|
||||||
|
Version fileboy: v1.5 filegirl: v` + strconv.Itoa(Version) + `
|
||||||
|
Released 2019.1.3
|
||||||
|
Licence MIT
|
||||||
|
Author dengsgo [dengsgo@gmail.com]
|
||||||
|
Website https://github.com/dengsgo/fileboy
|
||||||
|
Blog https://www.yoytang.com
|
||||||
`
|
`
|
||||||
|
102
taskman.go
Normal file
102
taskman.go
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type TaskMan struct {
|
||||||
|
lastTaskId int64
|
||||||
|
delay int
|
||||||
|
cmd *exec.Cmd
|
||||||
|
notifier *NetNotifier
|
||||||
|
putLock sync.Mutex
|
||||||
|
runLock sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
func newTaskMan(delay int, callUrl string) *TaskMan {
|
||||||
|
return &TaskMan{
|
||||||
|
delay: delay,
|
||||||
|
notifier: newNetNotifier(callUrl),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *TaskMan) Put(cf *changedFile) {
|
||||||
|
if t.delay < 1 {
|
||||||
|
t.preRun(cf)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.putLock.Lock()
|
||||||
|
defer t.putLock.Unlock()
|
||||||
|
t.lastTaskId = cf.Changed
|
||||||
|
go func() {
|
||||||
|
<-time.Tick(time.Millisecond * time.Duration(t.delay))
|
||||||
|
if t.lastTaskId > cf.Changed {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.preRun(cf)
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *TaskMan) preRun(cf *changedFile) {
|
||||||
|
if t.cmd != nil && t.cmd.Process != nil {
|
||||||
|
err := t.cmd.Process.Kill()
|
||||||
|
if err != nil {
|
||||||
|
log.Println("err: ", err)
|
||||||
|
}
|
||||||
|
log.Println("stop old process ")
|
||||||
|
}
|
||||||
|
go t.run(cf)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *TaskMan) run(cf *changedFile) {
|
||||||
|
go t.notifier.Put(cf)
|
||||||
|
t.runLock.Lock()
|
||||||
|
defer t.runLock.Unlock()
|
||||||
|
for i := 0; i < len(cfg.Command.Exec); i++ {
|
||||||
|
carr := cmdParse2Array(cfg.Command.Exec[i], cf)
|
||||||
|
log.Println("EXEC", carr)
|
||||||
|
t.cmd = exec.Command(carr[0], carr[1:]...)
|
||||||
|
//cmd.SysProcAttr = &syscall.SysProcAttr{CreationFlags: syscall.CREATE_UNICODE_ENVIRONMENT}
|
||||||
|
t.cmd.Stdin = os.Stdin
|
||||||
|
//cmd.Stdout = os.Stdout
|
||||||
|
t.cmd.Stderr = os.Stderr
|
||||||
|
t.cmd.Dir = projectFolder
|
||||||
|
t.cmd.Env = os.Environ()
|
||||||
|
stdout, err := t.cmd.StdoutPipe()
|
||||||
|
if err != nil {
|
||||||
|
log.Println("error=>", err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
err = t.cmd.Start()
|
||||||
|
if err != nil {
|
||||||
|
log.Println("run command", carr, "error. ", err)
|
||||||
|
}
|
||||||
|
reader := bufio.NewReader(stdout)
|
||||||
|
for {
|
||||||
|
line, err2 := reader.ReadString('\n')
|
||||||
|
if err2 != nil || io.EOF == err2 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
fmt.Print(line)
|
||||||
|
}
|
||||||
|
err = t.cmd.Wait()
|
||||||
|
if err != nil {
|
||||||
|
log.Println("cmd wait err ", err)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if t.cmd.Process != nil {
|
||||||
|
if err = t.cmd.Process.Kill(); err != nil {
|
||||||
|
log.Println("cmd cannot kill ", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Println("end ")
|
||||||
|
}
|
27
util.go
27
util.go
@@ -2,6 +2,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -14,17 +15,27 @@ func inStringArray(value string, arr []string) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
func cmdParse2Array(s string) []string {
|
func cmdParse2Array(s string, cf *changedFile) []string {
|
||||||
a := strings.Split(s, " ")
|
a := strings.Split(s, " ")
|
||||||
r := make([]string, 0)
|
r := make([]string, 0)
|
||||||
for i := 0; i < len(a); i++ {
|
for i := 0; i < len(a); i++ {
|
||||||
if ss := strings.Trim(a[i], " "); ss != "" {
|
if ss := strings.Trim(a[i], " "); ss != "" {
|
||||||
r = append(r, ss)
|
r = append(r, strParseRealStr(ss, cf))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return r
|
return r
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func strParseRealStr(s string, cf *changedFile) string {
|
||||||
|
return strings.Replace(
|
||||||
|
strings.Replace(
|
||||||
|
strings.Replace(s, "{{file}}", cf.Name, -1),
|
||||||
|
"{{ext}}", cf.Ext, -1,
|
||||||
|
),
|
||||||
|
"{{changed}}", strconv.FormatInt(cf.Changed, 10), -1,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
func dirParse2Array(s string) []string {
|
func dirParse2Array(s string) []string {
|
||||||
a := strings.Split(s, ",")
|
a := strings.Split(s, ",")
|
||||||
r := make([]string, 0)
|
r := make([]string, 0)
|
||||||
@@ -55,12 +66,22 @@ func arrayUniqueAdd(a []string, add string) []string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func arrayRemoveElement(a []string, r string) []string {
|
func arrayRemoveElement(a []string, r string) []string {
|
||||||
i := 0
|
i := -1
|
||||||
for k, v := range a {
|
for k, v := range a {
|
||||||
if v == r {
|
if v == r {
|
||||||
i = k
|
i = k
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if i == -1 {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
if len(a) == 1 && i == 0 {
|
||||||
|
return []string{}
|
||||||
|
}
|
||||||
return append(a[:i], a[i+1:]...)
|
return append(a[:i], a[i+1:]...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func relativePath(folder, p string) string {
|
||||||
|
return strings.TrimPrefix(p, folder)
|
||||||
|
}
|
||||||
|
Reference in New Issue
Block a user