public poc dev version

Author: NonLogicalDev

.gitignore

@@ -1,2 +1,3 @@
 .idea
 .vscode
+goprompt

Makefile

@@ -3,14 +3,42 @@ CURRENT_DIR := $(patsubst %/,%,$(dir $(MKFILE_PATH)))
 
 ZSH_PROMPT_SETUP_SCRIPT := $(CURRENT_DIR)/plugin/zsh/prompt_asynczle_setup.zsh
 
+USR_BIN_DIR := $(HOME)/bin
+USR_ZSH_DIR := $(HOME)/.local/share/zsh-funcs
+
+build:
+	go build -o "goprompt" ./cmd/goprompt 
+
+.PHONY: install
 install:
-	go install ./cmd/goprompt
+	mkdir -p "$(USR_BIN_DIR)"
+	go build -o "$(USR_BIN_DIR)/goprompt" ./cmd/goprompt 
+	mkdir -p "$(USR_ZSH_DIR)"
+	cp "$(ZSH_PROMPT_SETUP_SCRIPT)" "$(USR_ZSH_DIR)/prompt_asynczle_setup"
+	$(MAKE) setup
 
-prompt.source:
-	@echo ". $(ZSH_PROMPT_SETUP_SCRIPT)"
+.PHONY: setup
+setup:
+	@echo '# SETUP:' >&2
+	@echo '# ------------------------------------------------------------------------------' >&2
+	@echo '# Assuming GoPrompt installed in $(USR_BIN_DIR)' >&2
+	@echo '# and zsh func in $(USR_ZSH_DIR)' >&2
+	@echo '# ------------------------------------------------------------------------------' >&2
+	@echo "# $$ make setup >> ~/.zshrc" >&2
+	@echo '# ------------------------------------------------------------------------------' >&2
+	@echo "# Add this to your ~/.zshenv" >&2
+	@echo '# ------------------------------------------------------------------------------' >&2
+	@echo ''
+	@echo '# PROMPT_ASYNC_ZLE: ------------------------------------------------------------'
+	@echo 'path+=( "$(USR_BIN_DIR)" )'
+	@echo 'fpath+=( "$(USR_ZSH_DIR)" )'
+	@echo 'autoload -Uz promptinit'
+	@echo 'promptinit && prompt_asynczle_setup'
+	@echo '# ------------------------------------------------------------------------------'
 
+.PHONY: try
 try: install
+	@echo '>> THIS NEEDS EXTRA CONFIG <<'
+	@echo '>> FOR DEVELOPMENT ONLY <<'
 	ZSH_DISABLE_PROMPT=Y ZSH_EXTRA_SOURCE="$(ZSH_PROMPT_SETUP_SCRIPT)" zsh
 
-exec: install
-	ZSH_DISABLE_PROMPT=Y ZSH_EXTRA_SOURCE="$(ZSH_PROMPT_SETUP_SCRIPT)" exec zsh -l

README.md

@@ -0,0 +1,43 @@
+# Async ZLE Based Prompt
+
+(Implemented In GoLang)
+
+## TLDR
+
+This is a non-blocking asynchronous prompt based on ZLE File Descriptor Handlers.
+
+The prompt query and rendering can be done via any command as long as it follows a line delimited protocol to communicate between the query and rendering components.
+
+
+![Demo Of GoPrompt With ZLE](./assets/Kapture%202022-07-26%20at%2010.45.33.gif "Capture")
+
+## Reference
+
+You can find the ZSH/ZLE integration in:
+
+* [prompt_asynczle_setup.zsh](./plugin/zsh/prompt_asynczle_setup.zsh)
+
+And the main POC query/rendering logic is implemented in GO
+
+* [goprompt](./cmd/goprompt)
+
+## Install
+
+```
+$ eval "$(gimme 1.18.3)"
+$ make install
+$ make setup >> ~/.zshrc
+```
+
+Assuming GoPrompt installed in `~/bin` and zsh func in `~/.local/share/zsh-funcs`
+
+`make setup` will add the following to your `~/.zshrc`:
+
+```
+# PROMPT_ASYNC_ZLE: ------------------------------------------------------------
+path+=( "$HOME/bin" )
+fpath+=( "$HOME/.local/share/zsh-funcs" )
+autoload -Uz promptinit
+promptinit && prompt_asynczle_setup
+# ------------------------------------------------------------------------------
+```

assets/Kapture 2022-07-26 at 10.45.33.gif

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 	"strings"
+	"sync"
 	"time"
 
 	ps "github.com/mitchellh/go-ps"
@@ -65,10 +66,19 @@ func timeFMT(ts time.Time) string {
 }
 
 func cmdQueryRun(_ *cobra.Command, _ []string) error {
-	printCH := make(chan shellKV)
-	defer close(printCH)
+	tasks := new(AsyncTaskDispatcher)
 
-	go shellKVStaggeredPrinter(printCH, 20*time.Millisecond, 600*time.Millisecond)
+	printCH := make(chan shellKV)
+	printerWG := new(sync.WaitGroup)
+	printerWG.Add(1)
+	go func() {
+		defer printerWG.Done()
+		shellKVStaggeredPrinter(printCH, 20*time.Millisecond, 600*time.Millisecond)
+	}()
+	printerStop := func() {
+		close(printCH)
+		printerWG.Wait()
+	}
 	printPart := func(name string, value interface{}) {
 		printCH <- shellKV{name, value}
 	}
@@ -80,10 +90,12 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 		printPart(_partStatus, fmt.Sprintf("%#v", *flgQCmdStatus))
 	}
 
-	wg := new(WaitGroupDispatcher)
-	defer wg.Wait()
+	defer func() {
+		tasks.Wait()
+		printerStop()
+	}()
 
-	wg.Dispatch(func() {
+	tasks.Dispatch(func() {
 		homeDir := os.Getenv("HOME")
 
 		if wd, err := os.Getwd(); err == nil {
@@ -103,7 +115,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 		}
 	})
 
-	wg.Dispatch(func() {
+	tasks.Dispatch(func() {
 		pidCurr := os.Getpid()
 		var pidShell ps.Process
 
@@ -132,25 +144,17 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 		printPart(_partPidParentExec, pidShellParent.Executable())
 	})
 
-	//wg.Dispatch(func() {
-	//	out, err := stringExec("git", "config", "--list")
-	//	printPart("debug_o", js(out))
-	//	if err != nil {
-	//		printPart("debug_e", js(err.Error()))
-	//	}
-	//})
-
-	wg.Dispatch(func() {
-		cwg := new(WaitGroupDispatcher)
-		defer cwg.Wait()
+	tasks.Dispatch(func() {
+		subTasks := new(AsyncTaskDispatcher)
+		defer subTasks.Wait()
 
 		if _, err := stringExec("git", "rev-parse", "--show-toplevel"); err == nil {
 			printPart(_partVcs, "git")
 		} else {
 			return
 		}
 
-		cwg.Dispatch(func() {
+		subTasks.Dispatch(func() {
 			if branch, err := stringExec("git", "branch", "--show-current"); err == nil {
 				branch = trim(branch)
 				if len(branch) > 0 {
@@ -168,8 +172,8 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			}
 		})
 
-		cwg.Dispatch(func() {
-			status, err := stringExec("git", "status", "--porcelain");
+		subTasks.Dispatch(func() {
+			status, err := stringExec("git", "status", "--porcelain")
 			if err != nil {
 				return
 			}
@@ -209,7 +213,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			printPart(_partVcsGitIdxExcluded, fOutOfIndex)
 		})
 
-		cwg.Dispatch(func() {
+		subTasks.Dispatch(func() {
 			if status, err := stringExec("git", "rev-list", "--left-right", "--count", "HEAD...@{u}"); err == nil {
 				parts := strings.SplitN(status, "\t", 2)
 				if len(parts) < 2 {
@@ -218,24 +222,25 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 
 				printPart(_partVcsLogAhead, parts[0])
 				printPart(_partVcsLogBehind, parts[1])
-
 			}
 		})
 	})
 
-	wg.Dispatch(func() {
+	tasks.Dispatch(func() {
 		var err error
 
-		cwg := new(WaitGroupDispatcher)
-		defer cwg.Wait()
+		subTasks := new(AsyncTaskDispatcher)
+		defer subTasks.Wait()
 
 		var stgSeriesLen string
 		if stgSeriesLen, err = stringExec("stg", "series", "-c"); err == nil {
 			printPart(_partVcsStg, "1")
 			printPart(_partVcsStgQlen, stgSeriesLen)
+		} else {
+			return
 		}
 
-		cwg.Dispatch(func() {
+		subTasks.Dispatch(func() {
 			if stgSeriesPos, err := stringExec("stg", "series", "-cA"); err == nil {
 				printPart(_partVcsStgQpos, stgSeriesPos)
 			}
@@ -248,7 +253,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			return
 		}
 
-		cwg.Dispatch(func() {
+		subTasks.Dispatch(func() {
 			gitSHA, _ := stringExec("stg", "id")
 			stgSHA, _ := stringExec("stg", "id", stgPatchTop)
 

cmd/goprompt/cmdQuery.go

@@ -205,6 +205,8 @@ func cmdRenderRun(_ *cobra.Command, _ []string) error {
 	promptLines := []string{""}
 	if len(partsTop) > 0 {
 		promptLines = append(promptLines, promptStatusMarker+strings.Join(partsTop, " "))
+	} else {
+		promptLines = append(promptLines, promptStatusMarker+strings.Repeat("-", 30))
 	}
 	if len(partsBottom) > 0 {
 		promptLines = append(promptLines, promptStatusMarker+strings.Join(partsBottom, " "))

cmd/goprompt/cmdRender.go

@@ -3,27 +3,28 @@ package main
 import (
 	"encoding/json"
 	"fmt"
+	"os"
 	"strconv"
 	"strings"
 	"sync"
 	"time"
 
-	"EXP/pkg/shellout"
+	"github.com/NonLogicalDev/shell.async-goprompt/pkg/shellout"
 )
 
-type WaitGroupDispatcher struct {
+type AsyncTaskDispatcher struct {
 	wg sync.WaitGroup
 }
 
-func (d *WaitGroupDispatcher) Dispatch(fn func()) {
+func (d *AsyncTaskDispatcher) Dispatch(fn func()) {
 	d.wg.Add(1)
 	go func() {
 		defer d.wg.Done()
 		fn()
 	}()
 }
 
-func (d *WaitGroupDispatcher) Wait() {
+func (d *AsyncTaskDispatcher) Wait() {
 	d.wg.Wait()
 }
 
@@ -35,7 +36,11 @@ type shellKV struct {
 }
 
 func (kv shellKV) Print() {
-	fmt.Printf("%s\t%v\n", kv.name, kv.value)
+	fmt.Println(kv.String())
+}
+
+func (kv shellKV) String() string {
+	return fmt.Sprintf("%s\t%v", kv.name, kv.value)
 }
 
 func shellKVStaggeredPrinter(
@@ -46,15 +51,14 @@ func shellKVStaggeredPrinter(
 ) {
 	var parts []shellKV
 
-	printParts := func() {
+	printParts := func(parts []shellKV) {
 		for _, p := range parts {
 			p.Print()
 		}
 		if len(parts) > 0 {
 			fmt.Println()
 		}
-
-		parts = nil
+		os.Stdout.Sync()
 	}
 
 	timerFirst := time.NewTimer(dFirst)
@@ -70,15 +74,18 @@ LOOP:
 			parts = append(parts, rx)
 
 		case <-timerFirst.C:
-			printParts()
+			printParts(parts)
+			parts = nil
 
 		case <-timer.C:
-			printParts()
+			printParts(parts)
+			parts = nil
 			timer.Reset(d)
 		}
 	}
 
-	printParts()
+	printParts(parts)
+	parts = nil
 }
 
 //: ----------------------------------------------------------------------------
@@ -130,7 +137,7 @@ func intMin(a, b int) int {
 }
 
 func trim(s string) string {
-	return strings.Trim(s, "\n\t ")
+	return strings.Trim(s, "\n")
 }
 
 func strInt(s string) int {

cmd/goprompt/utils.go

@@ -1,4 +1,4 @@
-module EXP
+module github.com/NonLogicalDev/shell.async-goprompt
 
 go 1.18
 

go.mod

@@ -1,3 +1,38 @@
+#
+# ZSH Mindfuck:
+#
+# * ${(f)EXPR} splits value of expr by Newline
+# * ${(s/ /)EXPR} splits value of expr by space, or any other char instead of space
+# * ${(j/ /)EXPR) joins value of expr by space
+# * ${(kv)EXPR) if EXPR is an associative array, this gives you a compacted sequence of key, value pairs.
+# * ${(p...)EXPR) the p here makes the following magic to recognize Print Escapes ala '\n'
+# * ${(@...)EXPR) in double quotes puts each array result into separate word
+#
+# ZSH Mindfuck Examples:
+#
+# > typeset -A K=(a b c d)
+#
+# > echo ${(j:.:)${(kv)K}}
+# a.b.c.d
+#
+# > echo ${(j:.:)${(k)K}}
+# a.c
+#
+# > echo ${(j:.:)${(v)K}}
+# b.d
+#
+# > echo "${(j:.:)${(v)K}}"
+# b d #
+# > echo "${(@j:.:)${(v)K}}"
+# b d
+#
+# > echo "${(@j:.:)${(@v)K}}"
+# b.d
+#
+# > echo "${(j:.:)${(@v)K}}"
+# b.d
+#
+
 __zsh_buffer_fd_reader() {
   local D=$1
   local FD=$2