增加 release

Update README.md

CHANGELOG.md

@@ -0,0 +1,42 @@
+### 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 命令；  

README.md

@@ -1,18 +1,26 @@
 ## 项目说明  
 
-fileboy，文件变更监听通知系统，使用 GO 编写。  
+fileboy，文件变更监听通知系统，使用 Go 编写。  
 
 适用于 Hot Reload （典型的如开发go项目，无需每次手动执行 go build；又比如前端 node 打包） 或者 系统监控的场景。  
 
 ## 编译环境    
 
-go version >=1.10    
+go version >=1.10，推荐 1.11   
+
+## 更新日志  
+
+[CHANGELOG](CHANGELOG.md)  
+
 
 ## 运行    
 
-### 直接下载二进制文件   
+### 下载二进制文件   
 
-直接下载已经编译好的对应平台二进制文件，加入系统 Path 中即可。 
+Github: [正式版 v1.2](https://github.com/dengsgo/fileboy/releases)  
+Gitee:  [正式版 v1.2](https://gitee.com/dengsgo/fileboy/releases)  
+
+下载已经编译好的对应平台二进制文件，重命名为`fileboy`, 加入系统 Path 中即可。 
 
 ### 源码编译   
 
@@ -40,7 +48,7 @@ fileboy 的正常运行依赖于 `filegirl.yaml` 配置，所以首次在项目
 
 - 运行 `fileboy`即可.  
 
-  如果你定义了 `commend -> exec`命令，想事先确认是否能正常执行，可以运行 `fileboy exec`命令，系统会尝试运行你的自定义命令。  
+  如果你定义了 `command -> exec`命令，想事先确认是否能正常执行，可以运行 `fileboy exec`命令，系统会尝试运行你的自定义命令。  
 
 你可以使用 `fileboy help`查看使用帮助。  
 
@@ -68,10 +76,12 @@ monitor:
         - .idea
         - .git
         - .vscode
+        - node_modules
+        - vendor
 
-    # 监听文件的格式，此类文件更改会执行 commend 中的命令
-    # .go   后缀为 .go 的文件更改，会执行 commend 中的命令
-    # .*    所有的文件更改都会执行 commend 中的命令
+    # 监听文件的格式，此类文件更改会执行 command 中的命令
+    # .go   后缀为 .go 的文件更改，会执行 command 中的命令
+    # .*    所有的文件更改都会执行 command 中的命令
     types:
         - .go
 
@@ -81,11 +91,29 @@ command:
     # 可以有多条命令，会依次执行
     # 如有多条命令，每条命令都会等待上一条命令执行完毕后才会执行
     # 如遇交互式命令，允许外部获取输入
+    # 支持变量占位符,运行命令时会替换成实际值：
+    #    {{file}}    文件名(如 a.txt 、test/test2/a.go)
+    #    {{ext}}     文件后缀(如 .go)
+    #    {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400)
+    # 变量占位符使用示例：cp {{file}} /root/sync -rf  、 myCommand --{{ext}} {{changed}}
     exec:
         - go version
         - go env
+        - echo {{file}}
 ```
 
+### TODO
+
+- [x] 命令支持变量占位符  
+- [x] 支持多命令  
+- [x] 支持监听指定文件夹  
+- [x] 支持不监听指定文件夹  
+- [x] 支持监听指定后缀文件  
+- [ ] 支持 http 通知  
+- [ ] 支持冗余任务丢弃
+
+
+
 ## QA
 
 #### 很多框架都自带了 hot reload 的功能，为什么还要单独写个 fileboy 呢？  
@@ -96,17 +124,17 @@ command:
 
 在开发中，我们很需要一款可以帮助我们自动打包编译的工具，那 fileboy 就非常适合这样的场景。比如 go 项目的热编译，让我们可以边修改代码边运行得到反馈。又比如 PHP Swoole 框架，由于常驻进程的原因，无法更改代码立即reload，使用 fileboy 就可以辅助做到传统 PHP 开发的体验。  
 
-对于一些需要监控文件日志或者配置变动的场景， fileboy 同样适合。你可以事先编写好相应的通知报警脚本，然后定义`filegirl.yaml`中的`commend`命令，交由 fileboy 自动运行监控报警。  
+对于一些需要监控文件日志或者配置变动的场景， fileboy 同样适合。你可以事先编写好相应的通知报警脚本，然后定义`filegirl.yaml`中的`command`命令，交由 fileboy 自动运行监控报警。  
 
-#### idea 下更改文件，为什么会执行两次或者多次 commend ?
+#### idea 下更改文件，为什么会执行两次或者多次 command ?
 
 由于 idea 系列软件特殊的文件保存策略，他会自动创建一些临时文件，并且在需要时多次重写文件，所以有时反映在文件上就是有多次的更改，所以会出现这种情况。这个后续会做优化.  
 
-#### filegirl.yaml 里面的 commend 不支持复杂的命令吗？  
+#### filegirl.yaml 里面的 command 不支持复杂的命令吗？  
 
 对于“很复杂的命令”这种说法很难去定义，比如 `echo "hello world"`并不复杂，但是对于 fileboy 来讲，目前无法解析这种命令。  
 
-fileboy 目前支持 `命令 + 参数`这种形式的 commend，而且 参数中不能有""符号或者有空格。如：  
+fileboy 目前支持 `命令 + 参数`这种形式的 command，而且 参数中不能有""符号或者有空格。如：  
 
 `go build`:支持；  
 
@@ -116,7 +144,7 @@ fileboy 目前支持 `命令 + 参数`这种形式的 commend，而且 参数中
 
 `cat a.txt | grep "q" | wc -l`:不支持  
 
-对于不支持的命令，可以把它写到一个文件里，然后在 commend 中执行这个文件来解决。  
+对于不支持的命令，可以把它写到一个文件里，然后在 command 中执行这个文件来解决。  
 
 #### 为什么起名为 fileboy，又把配置名叫做 filegirl ？
 
@@ -124,4 +152,15 @@ fileboy 目前支持 `命令 + 参数`这种形式的 commend，而且 参数中
 
 #### 听说有彩蛋？
 
-(◡ᴗ◡✿)
+(◡ᴗ◡✿)
+
+
+
+### 贡献者
+
+> 排名不分先后
+
+[@dengsgo](https://www.yoytang.com)  <dengsgo@yoytang.com>  
+
+[@itwesley](https://github.com/itwesley)  <wcshen1126@gmail.com>  
+

build-darwin.bat

@@ -3,6 +3,6 @@ echo build start...
 SET CGO_ENABLED=0
 SET GOOS=darwin
 SET GOARCH=amd64
-go build -ldflags "-s -w"
+go build -ldflags "-s -w" -o fileboy-darwin-amd64.bin
 echo build success
 pause

build-linux.bat

@@ -3,6 +3,6 @@ echo build start...
 SET CGO_ENABLED=0
 SET GOOS=linux
 SET GOARCH=amd64
-go build -ldflags "-s -w"
+go build -ldflags "-s -w" -o fileboy-linux-amd64.bin
 echo build success
 pause

build-windows.bat

@@ -3,6 +3,6 @@ echo build start...
 SET CGO_ENABLED=0
 SET GOOS=windows
 SET GOARCH=amd64
-go build -ldflags "-s -w"
+go build -ldflags "-s -w" -o fileboy-windows-amd64.exe
 echo build success
 pause

fileboy.go

@@ -12,6 +12,7 @@ import (
 	"os"
 	"os/exec"
 	"path"
+	"strconv"
 	"sync"
 	"time"
 )
@@ -32,9 +33,10 @@ var (
 	runLock sync.Mutex
 )
 
-type wDirState struct {
-	Name      string
-	Recursive bool
+type changeFile struct {
+	Name    string
+	Changed int64
+	Ext     string
 }
 
 func parseConfig() {
@@ -72,22 +74,28 @@ func eventDispatcher(event fsnotify.Event) {
 			}
 			log.Println("stop old process ")
 		}
-		go run()
+		go run(&changeFile{
+			Name:    relativePath(projectFolder, event.Name),
+			Changed: time.Now().UnixNano(),
+			Ext:     ext,
+		})
 	case fsnotify.Remove:
 	case fsnotify.Rename:
 	}
 }
 
-func run() {
+func run(cf *changeFile) {
 	runLock.Lock()
 	defer runLock.Unlock()
 	for i := 0; i < len(cfg.Command.Exec); i++ {
-		carr := cmdParse2Array(cfg.Command.Exec[i])
+		carr := cmdParse2Array(cfg.Command.Exec[i], cf)
 		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
+		cmd.Dir = projectFolder
+		cmd.Env = os.Environ()
 		stdout, err := cmd.StdoutPipe()
 		if err != nil {
 			log.Println("error=>", err.Error())
@@ -117,6 +125,7 @@ func run() {
 }
 
 func addWatcher() {
+	log.Println("collecting directory information...")
 	dirs := make([]string, 0)
 	for i := 0; i < len(cfg.Monitor.IncludeDirs); i++ {
 		darr := dirParse2Array(cfg.Monitor.IncludeDirs[i])
@@ -135,12 +144,14 @@ func addWatcher() {
 			}
 			break
 		} else {
+			md := projectFolder + "/" + darr[0]
 			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)
 				})
 			} else {
-				dirs = arrayUniqueAdd(dirs, projectFolder+"/"+darr[0])
+				dirs = arrayUniqueAdd(dirs, md)
 			}
 		}
 
@@ -197,7 +208,7 @@ func parseArgs() {
 	if l == 1 {
 		_, err := ioutil.ReadFile(projectFolder + "/filegirl.yaml")
 		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(helpStr)
 			return
@@ -218,8 +229,12 @@ func parseArgs() {
 			return
 		case "exec":
 			parseConfig()
-			run()
+			run(new(changeFile))
 			return
+		case "version":
+			fallthrough
+		case "v":
+			fmt.Println("[VERSION] Release: v1.2   filegirl: " + strconv.Itoa(Version))
 		default:
 			fmt.Print(helpStr)
 		}
@@ -231,7 +246,7 @@ func show() {
 	fmt.Print(logo)
 	rand.Seed(time.Now().UnixNano())
 	fmt.Println(englishSay[rand.Intn(len(englishSay))], "\r\n")
-	fmt.Println("Version: ", Version, "   Author: deng@yoytang.com")
+	fmt.Println("Version: ", Version, "   Author: dengsgo@yoytang.com")
 }
 
 func main() {

raw.go

@@ -21,10 +21,12 @@ monitor:
         - .idea
         - .git
         - .vscode
+        - node_modules
+        - vendor
 
-    # 监听文件的格式，此类文件更改会执行 commend 中的命令
-    # .go   后缀为 .go 的文件更改，会执行 commend 中的命令
-    # .*    所有的文件更改都会执行 commend 中的命令
+    # 监听文件的格式，此类文件更改会执行 command 中的命令
+    # .go   后缀为 .go 的文件更改，会执行 command 中的命令
+    # .*    所有的文件更改都会执行 command 中的命令
     types:
         - .go
 
@@ -34,9 +36,15 @@ command:
     # 可以有多条命令，会依次执行
     # 如有多条命令，每条命令都会等待上一条命令执行完毕后才会执行
     # 如遇交互式命令，允许外部获取输入
+    # 支持变量占位符：
+    #    {{file}}    文件名(如 a.txt 、test/test2/a.go)
+    #    {{ext}}     文件后缀(如 .go)
+    #    {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400)
+    # 变量占位符使用示例：cp {{file}} /root/sync -rf  、 myCommand --{{ext}} {{changed}}
     exec:
         - go version
         - go env
+        - echo {{file}}
 `
 
 var firstRunHelp = `第一次运行 fileboy ?
@@ -51,7 +59,9 @@ Usage of fileboy:
     init 
         初始化 fileboy, 在当前目录生成 filegirl.yaml 配置文件
     exec 
-        尝试运行定义的 commend 命令
+        尝试运行定义的 command 命令
+    version 
+        查看当前版本号
 `
 
 var englishSay = []string{

util.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"io/ioutil"
+	"strconv"
 	"strings"
 )
 
@@ -14,17 +15,27 @@ func inStringArray(value string, arr []string) bool {
 	return false
 }
 
-func cmdParse2Array(s string) []string {
+func cmdParse2Array(s string, cf *changeFile) []string {
 	a := strings.Split(s, " ")
 	r := make([]string, 0)
 	for i := 0; i < len(a); i++ {
 		if ss := strings.Trim(a[i], " "); ss != "" {
-			r = append(r, ss)
+			r = append(r, strParseRealStr(ss, cf))
 		}
 	}
 	return r
 }
 
+func strParseRealStr(s string, cf *changeFile) 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 {
 	a := strings.Split(s, ",")
 	r := make([]string, 0)
@@ -55,12 +66,22 @@ func arrayUniqueAdd(a []string, add string) []string {
 }
 
 func arrayRemoveElement(a []string, r string) []string {
-	i := 0
+	i := -1
 	for k, v := range a {
 		if v == r {
 			i = k
 			break
 		}
 	}
+	if i == -1 {
+		return a
+	}
+	if len(a) == 1 && i == 0 {
+		return []string{}
+	}
 	return append(a[:i], a[i+1:]...)
 }
+
+func relativePath(folder, p string) string {
+	return strings.TrimPrefix(p, folder)
+}