Merge pull request #464 from rsteube/completer-desciptions

added completer descriptions

Author: rsteube

cmd/carapace/cmd/root.go

@@ -8,6 +8,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/rsteube/carapace/pkg/ps"
@@ -52,7 +53,7 @@ var rootCmd = &cobra.Command{
 		case "--version":
 			println(cmd.Version)
 		case "--list":
-			fmt.Println(strings.Join(completers, "\n"))
+			printCompleters()
 		case "_carapace":
 			shell := ps.DetermineShell()
 			if len(args) > 1 {
@@ -87,6 +88,19 @@ var rootCmd = &cobra.Command{
 	DisableFlagParsing: true,
 }
 
+func printCompleters() {
+	maxlen := 0
+	for _, name := range completers {
+		if len := len(name); len > maxlen {
+			maxlen = len
+		}
+	}
+
+	for _, name := range completers {
+		fmt.Printf("%-"+strconv.Itoa(maxlen)+"v %v\n", name, descriptions[name])
+	}
+}
+
 func invokeCompleter(completer string) {
 	old := os.Stdout
 	r, w, _ := os.Pipe()

cmd/generate/gen.go

@@ -4,26 +4,42 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os/exec"
+	"regexp"
+	"strconv"
 	"strings"
 )
 
 func main() {
-	completers := readCompleters()
+	names, descriptions := readCompleters()
 
-	imports := make([]string, len(completers))
-	for index, c := range readCompleters() {
-		imports[index] = fmt.Sprintf(`	%v "github.com/rsteube/carapace-bin/completers/%v_completer/cmd"`, varName(c), c)
+	imports := make([]string, 0, len(names))
+	for _, name := range names {
+		imports = append(imports, fmt.Sprintf(`	%v "github.com/rsteube/carapace-bin/completers/%v_completer/cmd"`, varName(name), name))
 	}
 
-	vars := make([]string, len(completers))
-	for index, c := range readCompleters() {
-		vars[index] = fmt.Sprintf(`	"%v",`, c)
+	formattedNames := make([]string, 0)
+	for _, name := range names {
+		formattedNames = append(formattedNames, fmt.Sprintf("\t\"%v\",", name))
 	}
 
-	cases := make([]string, len(completers)*2)
-	for index, c := range readCompleters() {
-		cases[index*2] = fmt.Sprintf(`	case "%v":`, c)
-		cases[(index*2)+1] = fmt.Sprintf(`		%v.Execute()`, varName(c))
+	maxlen := 0
+	for _, name := range names {
+		if l := len(name); l > maxlen {
+			maxlen = l
+		}
+	}
+
+	formattedDescriptions := make([]string, 0)
+	for _, name := range names {
+		formattedDescriptions = append(formattedDescriptions, fmt.Sprintf(`	%--`+strconv.Itoa(maxlen+4)+`v"%v",`, fmt.Sprintf(`"%v": `, name), descriptions[name]))
+	}
+
+	cases := make([]string, 0)
+	for _, name := range names {
+		cases = append(cases,
+			fmt.Sprintf(`	case "%v":`, name),
+			fmt.Sprintf(`		%v.Execute()`, varName(name)),
+		)
 	}
 
 	content := fmt.Sprintf(`package cmd
@@ -34,13 +50,17 @@ import (
 var completers = []string{
 %v}
 
+var descriptions = map[string]string{
+%v}
+
 func executeCompleter(completer string) {
 	switch completer {
 %v	}
 }
 `,
 		fmt.Sprintln(strings.Join(imports, "\n")),
-		fmt.Sprintln(strings.Join(vars, "\n")),
+		fmt.Sprintln(strings.Join(formattedNames, "\n")),
+		fmt.Sprintln(strings.Join(formattedDescriptions, "\n")),
 		fmt.Sprintln(strings.Join(cases, "\n")),
 	)
 	if root, err := rootDir(); err == nil {
@@ -55,18 +75,34 @@ func varName(name string) string {
 	return strings.Replace(name, "-", "_", -1)
 }
 
-func readCompleters() []string {
-	completers := make([]string, 0)
+func readCompleters() ([]string, map[string]string) {
+	names := make([]string, 0)
+	descriptions := make(map[string]string)
 	if root, err := rootDir(); err == nil {
 		if files, err := ioutil.ReadDir(root + "/completers/"); err == nil {
 			for _, file := range files {
 				if file.IsDir() && strings.HasSuffix(file.Name(), "_completer") {
-					completers = append(completers, strings.TrimSuffix(file.Name(), "_completer"))
+					name := strings.TrimSuffix(file.Name(), "_completer")
+					description := readDescription(root, file.Name())
+					names = append(names, name)
+					descriptions[name] = description
 				}
 			}
 		}
 	}
-	return completers
+	return names, descriptions
+}
+
+func readDescription(root string, completer string) string {
+	if content, err := ioutil.ReadFile(fmt.Sprintf("%v/completers/%v/cmd/root.go", root, completer)); err == nil {
+		re := regexp.MustCompile("^\tShort: \"(?P<description>.*)\",$")
+		for _, line := range strings.Split(string(content), "\n") {
+			if re.MatchString(line) {
+				return re.FindStringSubmatch(line)[1]
+			}
+		}
+	}
+	return ""
 }
 
 func rootDir() (string, error) {

completers/adb_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "adb",
-	Short: "",
+	Short: "Android Debug Bridge",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/alsamixer_completer/cmd/root.go

@@ -8,7 +8,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "alsamixer",
-	Short: "",
+	Short: "soundcard mixer for ALSA soundcard driver, with ncurses interface",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/apropos_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "apropos",
-	Short: "",
+	Short: "search the manual page names and descriptions",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/awk_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "awk",
-	Short: "",
+	Short: "pattern scanning and processing language",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/basename_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "basename",
-	Short: "",
+	Short: "strip directory and suffix from filenames",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/bash_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "bash",
-	Short: "",
+	Short: "GNU Bourne-Again SHell",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/bat_completer/cmd/root.go

@@ -9,7 +9,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "bat",
-	Short: "",
+	Short: "a cat clone with syntax highlighting and Git integration",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 

completers/bats_completer/cmd/root.go

@@ -7,7 +7,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "bats",
-	Short: "",
+	Short: "Bash Automated Testing System",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }