Merge branch 'master' into patch-1

Author: xiantang

README.md

@@ -95,6 +95,23 @@ air
 
 For modifying the configuration refer to the [air_example.toml](air_example.toml) file.
 
+### Docker-compose
+
+```
+services:
+  my-project-with-air:
+    image: cosmtrek/air
+    # working_dir value has to be the same of mapped volume
+    working_dir: /project-package
+    ports:
+      - <any>:<any>
+    environment:
+      - ENV_A=${ENV_A}
+      - ENV_B=${ENV_B}
+      - ENV_C=${ENV_C}
+    volumes:
+      - ./project-relative-path/:/project-package/
+```
 
 ### Debug
 

air_example.toml

@@ -10,7 +10,7 @@ tmp_dir = "tmp"
 cmd = "go build -o ./tmp/main ."
 # Binary file yields from `cmd`.
 bin = "tmp/main"
-# Customize binary.
+# Customize binary, can setup environment variables when run your app.
 full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
 # Watch these filename extensions.
 include_ext = ["go", "tpl", "tmpl", "html"]

install.sh

@@ -66,6 +66,7 @@ get_binaries() {
     darwin/arm64) BINARIES="air" ;;
     linux/386) BINARIES="air" ;;
     linux/amd64) BINARIES="air" ;;
+    linux/arm64) BINARIES="air" ;;
     windows/386) BINARIES="air" ;;
     windows/amd64) BINARIES="air" ;;
     *)

runner/config.go

@@ -21,13 +21,14 @@ const (
 )
 
 type config struct {
-	Root        string   `toml:"root"`
-	TmpDir      string   `toml:"tmp_dir"`
-	TestDataDir string   `toml:"testdata_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"`
+	TestDataDir string    `toml:"testdata_dir"`
+	Build       cfgBuild  `toml:"build"`
+	Color       cfgColor  `toml:"color"`
+	Log         cfgLog    `toml:"log"`
+	Misc        cfgMisc   `toml:"misc"`
+	Screen      cfgScreen `toml:"screen"`
 }
 
 type cfgBuild struct {
@@ -79,6 +80,10 @@ type cfgMisc struct {
 	CleanOnExit bool `toml:"clean_on_exit"`
 }
 
+type cfgScreen struct {
+	ClearOnRebuild bool `toml:"clear_on_rebuild"`
+}
+
 func initConfig(path string) (cfg *config, err error) {
 	if path == "" {
 		cfg, err = defaultPathConfig()

runner/engine.go

@@ -1,6 +1,7 @@
 package runner
 
 import (
+	"fmt"
 	"io"
 	"os"
 	"os/exec"
@@ -144,6 +145,9 @@ func (e *Engine) watching(root string) error {
 func (e *Engine) cacheFileChecksums(root string) error {
 	return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
+			if info == nil {
+				return err
+			}
 			if info.IsDir() {
 				return filepath.SkipDir
 			}
@@ -199,7 +203,7 @@ func (e *Engine) cacheFileChecksums(root string) error {
 
 func (e *Engine) watchDir(path string) error {
 	if err := e.watcher.Add(path); err != nil {
-		e.watcherLog("failed to watching %s, error: %s", path, err.Error())
+		e.watcherLog("failed to watch %s, error: %s", path, err.Error())
 		return err
 	}
 	e.watcherLog("watching %s", e.config.rel(path))
@@ -314,19 +318,29 @@ func (e *Engine) start() {
 					continue
 				}
 			}
+
 			time.Sleep(e.config.buildDelay())
 			e.flushEvents()
+
+			// clean on rebuild https://stackoverflow.com/questions/22891644/how-can-i-clear-the-terminal-screen-in-go
+			if e.config.Screen.ClearOnRebuild {
+				fmt.Println("\033[2J")
+			}
+
 			e.mainLog("%s has changed", e.config.rel(filename))
 		case <-firstRunCh:
 			// go down
 			break
 		}
 
+		// already build and run now
 		select {
 		case <-e.buildRunCh:
 			e.buildRunStopCh <- true
 		default:
 		}
+
+		// if current app is running, stop it
 		e.withLock(func() {
 			if e.binRunning {
 				e.binStopCh <- true
@@ -382,16 +396,16 @@ func (e *Engine) flushEvents() {
 func (e *Engine) building() error {
 	var err error
 	e.buildLog("building...")
-	cmd, stdout, stderr, err := e.startCmd(e.config.Build.Cmd)
+	cmd, stdin, stdout, stderr, err := e.startCmd(e.config.Build.Cmd)
 	if err != nil {
 		return err
 	}
 	defer func() {
 		stdout.Close()
 		stderr.Close()
+		stdin.Close()
 	}()
-	_, _ = io.Copy(os.Stdout, stdout)
-	_, _ = io.Copy(os.Stderr, stderr)
+
 	// wait for building
 	err = cmd.Wait()
 	if err != nil {
@@ -403,20 +417,15 @@ func (e *Engine) building() error {
 func (e *Engine) runBin() error {
 	var err error
 	e.runnerLog("running...")
-	cmd, stdout, stderr, err := e.startCmd(e.config.Build.Bin)
+	cmd, stdin, stdout, stderr, err := e.startCmd(e.config.Build.Bin)
 	if err != nil {
 		return err
 	}
 	e.withLock(func() {
 		e.binRunning = true
 	})
 
-	go func() {
-		_, _ = io.Copy(os.Stdout, stdout)
-		_, _ = io.Copy(os.Stderr, stderr)
-	}()
-
-	go func(cmd *exec.Cmd, stdout io.ReadCloser, stderr io.ReadCloser) {
+	go func(cmd *exec.Cmd, stdin io.WriteCloser, stdout io.ReadCloser, stderr io.ReadCloser) {
 		defer func() {
 			select {
 			case <-e.exitCh:
@@ -429,6 +438,7 @@ func (e *Engine) runBin() error {
 		defer func() {
 			stdout.Close()
 			stderr.Close()
+			stdin.Close()
 		}()
 		pid, err := e.killCmd(cmd)
 		if err != nil {
@@ -449,7 +459,7 @@ func (e *Engine) runBin() error {
 		if err = os.Remove(cmdBinPath); err != nil {
 			e.mainLog("failed to remove %s, error: %s", e.config.rel(e.config.binPath()), err)
 		}
-	}(cmd, stdout, stderr)
+	}(cmd, stdin, stdout, stderr)
 	return nil
 }
 

runner/util_darwin.go

@@ -2,11 +2,10 @@ package runner
 
 import (
 	"io"
+	"os"
 	"os/exec"
 	"syscall"
 	"time"
-
-	"github.com/creack/pty"
 )
 
 func (e *Engine) killCmd(cmd *exec.Cmd) (pid int, err error) {
@@ -26,8 +25,28 @@ func (e *Engine) killCmd(cmd *exec.Cmd) (pid int, err error) {
 	return pid, err
 }
 
-func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.ReadCloser, io.ReadCloser, error) {
+func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.WriteCloser, io.ReadCloser, io.ReadCloser, error) {
 	c := exec.Command("/bin/sh", "-c", cmd)
-	f, err := pty.Start(c)
-	return c, f, f, err
+	stderr, err := c.StderrPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	stdout, err := c.StdoutPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	stdin, err := c.StdinPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+
+	c.Stdout = os.Stdout
+	c.Stderr = os.Stderr
+	c.Stdin = os.Stdin
+
+	err = c.Start()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	return c, stdin, stdout, stderr, nil
 }

runner/util_linux.go

@@ -2,11 +2,10 @@ package runner
 
 import (
 	"io"
+	"os"
 	"os/exec"
 	"syscall"
 	"time"
-
-	"github.com/creack/pty"
 )
 
 func (e *Engine) killCmd(cmd *exec.Cmd) (pid int, err error) {
@@ -28,8 +27,27 @@ func (e *Engine) killCmd(cmd *exec.Cmd) (pid int, err error) {
 	return
 }
 
-func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.ReadCloser, io.ReadCloser, error) {
+func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.WriteCloser, io.ReadCloser, io.ReadCloser, error) {
 	c := exec.Command("/bin/sh", "-c", cmd)
-	f, err := pty.Start(c)
-	return c, f, f, err
+	stderr, err := c.StderrPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	stdout, err := c.StdoutPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	stdin, err := c.StdinPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	c.Stdout = os.Stdout
+	c.Stderr = os.Stderr
+	c.Stdin = os.Stdin
+
+	err = c.Start()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	return c, stdin, stdout, stderr, nil
 }

runner/util_windows.go

@@ -2,6 +2,7 @@ package runner
 
 import (
 	"io"
+	"os"
 	"os/exec"
 	"strconv"
 	"strings"
@@ -14,7 +15,7 @@ func (e *Engine) killCmd(cmd *exec.Cmd) (pid int, err error) {
 	return pid, kill.Run()
 }
 
-func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.ReadCloser, io.ReadCloser, error) {
+func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.WriteCloser, io.ReadCloser, io.ReadCloser, error) {
 	var err error
 
 	if !strings.Contains(cmd, ".exe") {
@@ -24,15 +25,23 @@ func (e *Engine) startCmd(cmd string) (*exec.Cmd, io.ReadCloser, io.ReadCloser,
 	c := exec.Command("cmd", "/c", cmd)
 	stderr, err := c.StderrPipe()
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, nil, nil, err
 	}
 	stdout, err := c.StdoutPipe()
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, nil, nil, err
 	}
+	stdin, err := c.StdinPipe()
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+	c.Stdout = os.Stdout
+	c.Stderr = os.Stderr
+	c.Stdin = os.Stdin
+
 	err = c.Start()
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, nil, nil, err
 	}
-	return c, stdout, stderr, err
+	return c, stdin, stdout, stderr, nil
 }