clean: prepare for a proper user-friendly release

* Improve install procedure
* Cleanup documentation
* Get rid of homebrew Async Task Dispatcher in favor of `conc`

Author: NonLogicalDev

Makefile

@@ -25,34 +25,6 @@ build:
 install: build
 	mkdir -p "$(USR_BIN_DIR)"
 	cp dist/goprompt "$(USR_BIN_DIR)/goprompt"
-	mkdir -p "$(USR_ZSH_DIR)"
-	cp "$(ZSH_PROMPT_SETUP_SCRIPT)" "$(USR_ZSH_DIR)/prompt_asynczle_setup"
-	$(MAKE) setup
-
-.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
 
 .PHONY: clean
 clean:

cmd/goprompt/cmdInstall.go

@@ -2,51 +2,77 @@ package main
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
 
 	goprompt "github.com/NonLogicalDev/shell.async-goprompt"
+	"github.com/kballard/go-shellquote"
 	"github.com/spf13/cobra"
 )
 
-var installDesc = `
-To install run the following:
+var cmdInstallHelpLong = `
+# To install run the following:
 
-	$ goprompt install zsh.zshrc >> .zshrc
+	$ goprompt install zsh >> .zshrc
 
-FILE options:
+# [FILE] options:
 
-	* zsh.zshrc
+	* zsh
 	* zsh.plugin
 `
 
+const defaultContent = `
+# To try for just this session run the following:
+
+	$ eval "$({{goprompt}} install zsh)"
+
+# To install run the following:
+
+	$ {{goprompt}} install zsh >> .zshrc
+`
+
 var (
 	cmdInstall = &cobra.Command{
 		Use:   "install [FILE]",
-		Short: "install the integration",
-		Long: trim(installDesc),
-		Args: cobra.MinimumNArgs(1),
+		Short: "print out the shell script to setup prompt",
+		Long: trim(cmdInstallHelpLong),
 	}
 )
 
-const (
-	_zshRc = "zshrc"
-	_zshPlugin = "zshplugin"
-)
-
 func init() {
 	cmdInstall.RunE = cmdInstallRun
 }
 
-// TODO: bundle in the plugin directory, and provide a way to extract it into users directory of choice.
+func replacePlaceholders(content string) string {
+	goPromptExec := os.Args[0]
+	if strings.Contains(goPromptExec, "/") {
+		if fullPath, err := filepath.Abs(goPromptExec); err == nil {
+			goPromptExec = fullPath
+		}
+	}
+	goPromptExec = shellquote.Join(goPromptExec)
+	content = strings.ReplaceAll(content, "{{goprompt}}", goPromptExec)
+	content = strings.ReplaceAll(content, "${GOPROMPT}", goPromptExec)
+	return content
+}
 
 func cmdInstallRun(command *cobra.Command, args []string) error {
+	argFile := ""
+	if len(args) > 0 {
+		argFile = args[0]
+	}
+
 	var content string
-	switch args[0] {
-	case "zsh.zshrc":
+	switch argFile {
+	case "zsh":
 		f, _ := goprompt.ZSHPluginFiles.ReadFile("plugin/zsh/prompt_install.zsh")
-		content = string(f)
+		content = replacePlaceholders(string(f))
 	case "zsh.plugin":
 		f, _ := goprompt.ZSHPluginFiles.ReadFile("plugin/zsh/prompt_asynczle_setup.zsh")
-		content = string(f)
+		content = replacePlaceholders(string(f))
+	default:
+		content = replacePlaceholders(defaultContent)
 	}
 	fmt.Println(content)
 	return nil

cmd/goprompt/cmdQuery.go

@@ -38,6 +38,10 @@ func init() {
 	cmdQuery.RunE = cmdQueryRun
 }
 
+func mkWgPool() pool.ContextPool {
+	return *pool.New().WithContext(bgctx)
+}
+
 const (
 	_partStatus    = "st"
 	_partTimestamp = "ts"
@@ -64,21 +68,17 @@ const (
 	_partVcsLogAhead  = "vcs_log_ahead"
 	_partVcsLogBehind = "vcs_log_behind"
 
-	_partVcsStg      = "stg"
-	_partVcsStgQlen  = "stg_qlen"
-	_partVcsStgQpos  = "stg_qpos"
-	_partVcsStgTop   = "stg_top"
-	_partVcsStgDirty = "stg_dirty"
+	_partVcsStg      = "vcs_git_stg"
+	_partVcsStgQlen  = "vcs_git_stg_qlen"
+	_partVcsStgQpos  = "vcs_git_stg_qpos"
+	_partVcsStgTop   = "vcs_git_stg_top"
+	_partVcsStgDirty = "vcs_git_stg_dirty"
 
-	_partVcsGitIdxTotal    = "git_idx_total"
-	_partVcsGitIdxIncluded = "git_idx_incl"
-	_partVcsGitIdxExcluded = "git_idx_excl"
+	_partVcsGitIdxTotal    = "vcs_git_idx_total"
+	_partVcsGitIdxIncluded = "vcs_git_idx_incl"
+	_partVcsGitIdxExcluded = "vcs_git_idx_excl"
 )
 
-func timeFMT(ts time.Time) string {
-	return ts.Format("15:04:05 01/02/06")
-}
-
 func handleQUIT() context.CancelFunc {
 	sig := make(chan os.Signal, 1)
 	signal.Notify(sig, os.Interrupt, os.Kill, syscall.SIGTERM)
@@ -134,7 +134,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 		}()
 	}
 
-	tasks := pool.New().WithContext(bgctx)
+	tasks := mkWgPool()
 	defer func() {
 		tasks.Wait()
 		printPart("done", "ok")
@@ -215,7 +215,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 	})
 
 	tasks.Go(func(context.Context) error {
-		subTasks := new(AsyncTaskDispatcher)
+		subTasks := mkWgPool()
 		defer subTasks.Wait()
 
 		if _, err := stringExec("git", "rev-parse", "--show-toplevel"); err == nil {
@@ -224,33 +224,35 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			return nil
 		}
 
-		subTasks.Dispatch(func() {
+		subTasks.Go(func(ctx context.Context) error {
 			if branch, err := stringExec("git", "branch", "--show-current"); err == nil {
 				branch = trim(branch)
 				if len(branch) > 0 {
 					printPart(_partVcsBranch, trim(branch))
-					return
+					return nil
 				}
 			}
 
 			if branch, err := stringExec("git", "name-rev", "--name-only", "HEAD"); err == nil {
 				branch = trim(branch)
 				if len(branch) > 0 {
 					printPart(_partVcsBranch, trim(branch))
-					return
+					return nil
 				}
 			}
+
+			return nil
 		})
 
-		subTasks.Dispatch(func() {
+		subTasks.Go(func(context.Context) error {
 			status, err := stringExec("git", "status", "--porcelain")
 			if err != nil {
-				return
+				return nil
 			}
 
 			if len(status) == 0 {
 				printPart(_partVcsDirty, 0)
-				return
+				return nil
 			}
 
 			printPart(_partVcsDirty, 1)
@@ -281,9 +283,11 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			printPart(_partVcsGitIdxTotal, fTotal)
 			printPart(_partVcsGitIdxIncluded, fInIndex)
 			printPart(_partVcsGitIdxExcluded, fOutOfIndex)
+
+			return nil
 		})
 
-		subTasks.Dispatch(func() {
+		subTasks.Go(func(context.Context) error {
 			if status, err := stringExec("git", "rev-list", "--left-right", "--count", "HEAD...@{u}"); err == nil {
 				parts := strings.SplitN(status, "\t", 2)
 				if len(parts) < 2 {
@@ -293,6 +297,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 				printPart(_partVcsLogAhead, parts[0])
 				printPart(_partVcsLogBehind, parts[1])
 			}
+			return nil
 		})
 
 		return nil
@@ -301,8 +306,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 	tasks.Go(func(context.Context) error {
 		var err error
 
-		subTasks := new(AsyncTaskDispatcher)
-		defer subTasks.Wait()
+		subTasks := mkWgPool()
 
 		var stgSeriesLen string
 		if stgSeriesLen, err = stringExec("stg", "series", "-c"); err == nil {
@@ -312,10 +316,11 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			return nil
 		}
 
-		subTasks.Dispatch(func() {
+		subTasks.Go(func(context.Context) error {
 			if stgSeriesPos, err := stringExec("stg", "series", "-cA"); err == nil {
 				printPart(_partVcsStgQpos, stgSeriesPos)
 			}
+			return nil
 		})
 
 		var stgPatchTop string
@@ -325,7 +330,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			return nil
 		}
 
-		subTasks.Dispatch(func() {
+		subTasks.Go(func(context.Context) error {
 			gitSHA, _ := stringExec("stg", "id")
 			stgSHA, _ := stringExec("stg", "id", stgPatchTop)
 
@@ -334,6 +339,7 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 			} else {
 				printPart(_partVcsStgDirty, 0)
 			}
+			return nil
 		})
 
 		return nil
@@ -342,26 +348,6 @@ func cmdQueryRun(_ *cobra.Command, _ []string) error {
 	return nil
 }
 
-func moduleFindProcessChain() ([]ps.Process, error) {
-	psPTR := os.Getpid()
-	var pidChain []ps.Process
-
-	for {
-		if psPTR == 0 {
-			break
-		}
-		psInfo, err := ps.FindProcess(psPTR)
-		if err != nil {
-			return nil, err
-		}
-		pidChain = append(pidChain, psInfo)
-		psPTR = psInfo.PPid()
-	}
-
-	return pidChain, nil
-}
-
-
 func startPrinter() (func(), func(name string, value interface{})) {
 	debugLog("query-printer: start")
 	defer debugLog("query-printer: stop")