Adding lua function to use result of updated RunBackgroundShell

Using Jobs channel to call lua callback

Author: Neko-Box-Coder

cmd/micro/initlua.go

@@ -101,6 +101,8 @@ func luaImportMicroShell() *lua.LTable {
 	ulua.L.SetField(pkg, "ExecCommand", luar.New(ulua.L, shell.ExecCommand))
 	ulua.L.SetField(pkg, "RunCommand", luar.New(ulua.L, shell.RunCommand))
 	ulua.L.SetField(pkg, "RunBackgroundShell", luar.New(ulua.L, shell.RunBackgroundShell))
+	ulua.L.SetField(pkg, "ExecBackgroundCommand", luar.New(ulua.L, shell.ExecBackgroundCommand))
+	ulua.L.SetField(pkg, "RunBackgroundCommand", luar.New(ulua.L, shell.RunBackgroundCommand))
 	ulua.L.SetField(pkg, "RunInteractiveShell", luar.New(ulua.L, shell.RunInteractiveShell))
 	ulua.L.SetField(pkg, "JobStart", luar.New(ulua.L, shell.JobStart))
 	ulua.L.SetField(pkg, "JobSpawn", luar.New(ulua.L, shell.JobSpawn))

internal/action/command.go

@@ -873,15 +873,17 @@ func (h *BufPane) UnbindCmd(args []string) {
 
 // RunCmd runs a shell command in the background
 func (h *BufPane) RunCmd(args []string) {
-	runf, err := shell.RunBackgroundShell(shellquote.Join(args...))
-	if err != nil {
-		InfoBar.Error(err)
-	} else {
-		go func() {
-			InfoBar.Message(runf())
-			screen.Redraw()
-		}()
+	if len(args) == 0 {
+		InfoBar.Error("No arguments")
+		return
 	}
+
+	shell.ExecBackgroundCommand(func(output string, runErr error) {
+		if runErr != nil {
+			output = fmt.Sprint(args[0], " exited with error: ", runErr)
+		}
+		InfoBar.Message(output)
+	}, args[0], args[1:]...)
 }
 
 // QuitCmd closes the main view

internal/shell/shell.go

@@ -45,6 +45,7 @@ func RunCommand(input string) (string, error) {
 	return ExecCommand(inputCmd, args[1:]...)
 }
 
+// **Deprecated, don't use**
 // RunBackgroundShell runs a shell command in the background
 // It returns a function which will run the command and returns a string
 // message result
@@ -68,6 +69,43 @@ func RunBackgroundShell(input string) (func() string, error) {
 	}, nil
 }
 
+// ExecBackgroundCommand is similar to ExecCommand except it runs in the
+// background and accept an optional callback function for the command output
+// or error if any.
+func ExecBackgroundCommand(cb func(string, error), name string, args ...string) {
+	go func() {
+		output, runErr := ExecCommand(name, args[0:]...)
+		if cb != nil {
+			wrapperFunc := func(output string, args []any) {
+				errVal, _ := args[0].(error)
+				cb(output, errVal)
+			}
+
+			var passArgs []any
+			passArgs = append(passArgs, runErr)
+			jobFunc := JobFunction{wrapperFunc, output, passArgs}
+			Jobs <- jobFunc
+		}
+	}()
+}
+
+// RunBackgroundCommand is similar to RunCommand except it runs in the 
+// background and accept an optional callback function for the command output
+// or error if any.
+// It returns an error immediately if it fails to split the input command
+func RunBackgroundCommand(input string, cb func(string, error)) error {
+	args, err := shellquote.Split(input)
+	if err != nil {
+		return err
+	}
+	if len(args) == 0 {
+		return errors.New("No arguments")
+	}
+
+	ExecBackgroundCommand(cb, args[0], args[1:]...)
+	return nil
+}
+
 // RunInteractiveShell runs a shellcommand interactively
 func RunInteractiveShell(input string, wait bool, getOutput bool) (string, error) {
 	args, err := shellquote.Split(input)

runtime/help/plugins.md

@@ -253,8 +253,18 @@ The packages and their contents are listed below (in Go type signatures):
        two arguments in the `ExecCommand` argument list (quoting arguments
        will preserve spaces).
 
-    - `RunBackgroundShell(input string) (func() string, error)`: returns a
-       function that will run the given shell command and return its output.
+    - **Deprecated** `RunBackgroundShell(input string) (func() string, error)`:
+       returns a function that will run the given shell command and return
+       its output.
+
+    - `ExecBackgroundCommand(cb func(string, error), name string, args ...string)`:
+       similar to ExecCommand except it runs in the background and accept
+       an optional callback function for the command output or error if any.
+
+    - `RunBackgroundCommand(input string, cb func(string, error)) error`:
+       similar to RunCommand except it runs in the background and accept
+       an optional callback function for the command output or error if any.
+       It returns an error immediately if it fails to split the input command
 
     - `RunInteractiveShell(input string, wait bool, getOutput bool)
                           (string, error)`: