feat(runner): add include_dir (#40)

Author: cosmtrek

Diff for: air_example.conf

@@ -3,8 +3,6 @@
 # Working directory
 # . or absolute path, please note that the directories following must be under root.
 root = "." 
-# Optional! If `watch_dir` is empty, use `root`.
-watch_dir = ""
 tmp_dir = "tmp"
 
 [build]
@@ -14,16 +12,18 @@ cmd = "go build -o ./tmp/main main.go"
 bin = "tmp/main"
 # Customize binary.
 full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
-# This log file places in your tmp_dir.
-log = "air_errors.log"
 # Watch these filename extensions.
 include_ext = ["go", "tpl", "tmpl", "html"]
 # Ignore these filename extensions or directories.
 exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
+# Watch these directories if you specified.
+include_dir = []
 # It's not necessary to trigger build each time file changes if it's too frequent.
 delay = 1000 # ms
 # Stop to run old binary when build errors occur.
 stop_on_error = true
+# This log file places in your tmp_dir.
+log = "air_errors.log"
 
 [log]
 # Show log time

Diff for: runner/config.go

@@ -16,13 +16,12 @@ const (
 )
 
 type config struct {
-	Root     string   `toml:"root"`
-	WatchDir string   `toml:"watch_dir"`
-	TmpDir   string   `toml:"tmp_dir"`
-	Build    cfgBuild `toml:"build"`
-	Color    cfgColor `toml:"color"`
-	Log      cfgLog   `toml:"log"`
-	Misc     cfgMisc  `toml:"misc"`
+	Root   string   `toml:"root"`
+	TmpDir string   `toml:"tmp_dir"`
+	Build  cfgBuild `toml:"build"`
+	Color  cfgColor `toml:"color"`
+	Log    cfgLog   `toml:"log"`
+	Misc   cfgMisc  `toml:"misc"`
 }
 
 type cfgBuild struct {
@@ -32,6 +31,7 @@ type cfgBuild struct {
 	Log         string   `toml:"log"`
 	IncludeExt  []string `toml:"include_ext"`
 	ExcludeDir  []string `toml:"exclude_dir"`
+	IncludeDir  []string `toml:"include_dir"`
 	Delay       int      `toml:"delay"`
 	StopOnError bool     `toml:"stop_on_error"`
 }
@@ -106,13 +106,12 @@ func defaultConfig() config {
 		CleanOnExit: false,
 	}
 	return config{
-		Root:     ".",
-		TmpDir:   "tmp",
-		WatchDir: "",
-		Build:    build,
-		Color:    color,
-		Log:      log,
-		Misc:     misc,
+		Root:   ".",
+		TmpDir: "tmp",
+		Build:  build,
+		Color:  color,
+		Log:    log,
+		Misc:   misc,
 	}
 }
 
@@ -216,13 +215,6 @@ func dftConfPath() (string, error) {
 	return filepath.Join(wd, dftConf), nil
 }
 
-func (c *config) watchDirRoot() string {
-	if c.WatchDir != "" {
-		return c.fullPath(c.WatchDir)
-	}
-	return c.Root
-}
-
 func (c *config) buildLogPath() string {
 	return filepath.Join(c.tmpPath(), c.Build.Log)
 }

Diff for: runner/engine.go

@@ -69,7 +69,7 @@ func (e *Engine) Run() {
 	if err = e.checkRunEnv(); err != nil {
 		os.Exit(1)
 	}
-	if err = e.watching(e.config.watchDirRoot()); err != nil {
+	if err = e.watching(e.config.Root); err != nil {
 		os.Exit(1)
 	}
 
@@ -109,7 +109,15 @@ func (e *Engine) watching(root string) error {
 			e.watcherLog("!exclude %s", e.config.rel(path))
 			return filepath.SkipDir
 		}
-		return e.watchDir(path)
+		isIn, walkDir := e.checkIncludeDir(path)
+		if !walkDir {
+			e.watcherLog("!exclude %s", e.config.rel(path))
+			return filepath.SkipDir
+		}
+		if isIn {
+			return e.watchDir(path)
+		}
+		return nil
 	})
 }
 

Diff for: runner/util.go

@@ -69,15 +69,40 @@ func cleanPath(path string) string {
 }
 
 func (e *Engine) isExcludeDir(path string) bool {
-	rp := e.config.rel(path)
+	cleanName := cleanPath(e.config.rel(path))
 	for _, d := range e.config.Build.ExcludeDir {
-		if cleanPath(rp) == d {
+		if cleanName == d {
 			return true
 		}
 	}
 	return false
 }
 
+// return isIncludeDir, walkDir
+func (e *Engine) checkIncludeDir(path string) (bool, bool) {
+	cleanName := cleanPath(e.config.rel(path))
+	iDir := e.config.Build.IncludeDir
+	if len(iDir) == 0 { // ignore empty
+		return true, true
+	}
+	if cleanName == "." {
+		return false, true
+	}
+	walkDir := false
+	for _, d := range iDir {
+		if d == cleanName {
+			return true, true
+		}
+		if strings.HasPrefix(cleanName, d) { // current dir is sub-directory of `d`
+			return true, true
+		}
+		if strings.HasPrefix(d, cleanName) { // `d` is sub-directory of current dir
+			walkDir = true
+		}
+	}
+	return false, walkDir
+}
+
 func (e *Engine) isIncludeExt(path string) bool {
 	ext := filepath.Ext(path)
 	for _, v := range e.config.Build.IncludeExt {