FEATURE: enabled autocompletion

Author: Florian Heinze

README.md

@@ -42,6 +42,8 @@ run `brew install sandstorm/tap/dev-script-runner` to install
 
 run `brew upgrade sandstorm/tap/dev-script-runner` to upgrade
 
+run `dev completion zsh > $(brew --prefix)/share/zsh/site-functions/_dev` to enable autocompletion
+
 Go to your project root and run `dev DSR_INIT` to create a `dev.sh` and a `dev_setup.sh` with examples for different types of tasks.
 The `$@` at the end of your `dev.sh` dispatches the script arguments to a function (so `dev sometask` calls `sometask`).
 

cmd/completion.go

@@ -10,12 +10,13 @@ import (
 )
 
 func buildInitCommand() *cobra.Command {
-	return &cobra.Command{
+	var cmd = &cobra.Command{
 		// IMPORTANT: never color Use! You will not be able to run the command otherwise.
-		Use:   "DSR_INIT",
-		Short: color.Gray.Text("creates dev.sh and dev_setup.sh in current folder"),
-		Long:  color.Sprintf(`This creates an example create a dev.sh and dev_setup.sh in your current directory.`),
-		Args:  cobra.NoArgs,
+		Use:     "DSR_INIT",
+		Short:   "creates dev.sh and dev_setup.sh in current folder",
+		Long:    "This creates an example create a dev.sh and dev_setup.sh in your current directory.",
+		Args:    cobra.NoArgs,
+		GroupID: utils.GROUP_ID_UTILS,
 
 		Run: func(cmd *cobra.Command, args []string) {
 			currentDirectory, err := os.Getwd()
@@ -42,4 +43,5 @@ func buildInitCommand() *cobra.Command {
 			os.Exit(0)
 		},
 	}
+	return cmd
 }

cmd/init.go

@@ -31,16 +31,19 @@ func Execute(version, commit string) {
 	// This was initially needed because we DisableFlagParsing for the tasks.
 	// Now we still DisableFlagParsing but also evaluate the args. If -h or --help
 	// is the only arg we show the help of the command
-
 	// IMPORTANT: the order of tasks should resemble the order in the dev.sh
 	cobra.EnableCommandSorting = false
-	RootCmd.AddCommand(buildSectionCommand("your tasks"))
+	RootCmd.AddGroup(&cobra.Group{
+		ID:    utils.GROUP_ID_TASKS,
+		Title: "Your Tasks",
+	})
+	RootCmd.AddGroup(&cobra.Group{
+		ID:    utils.GROUP_ID_UTILS,
+		Title: "Utils",
+	})
 	addDevScriptTasksAsCommands(RootCmd)
-	RootCmd.AddCommand(buildSectionCommand("utils"))
 	RootCmd.AddCommand(buildInitCommand())
 	// TODO: fix autocompletion
-	// RootCmd.AddCommand(buildCompletionCommand())
-	RootCmd.AddCommand(buildSectionCommand("other"))
 	if err := RootCmd.Execute(); err != nil {
 		fmt.Println(err)
 		os.Exit(1)

cmd/root.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"github.com/gookit/color"
 	"github.com/spf13/cobra"
 	"log"
 	"main/utils"
@@ -14,10 +13,11 @@ import (
 func buildTaskCommand(task utils.DevScriptTask, devScriptPath string) *cobra.Command {
 	var cmd = &cobra.Command{
 		// IMPORTANT: never color Use! You will not be able to run the command otherwise.
-		Use:   task.Usage,
-		Short: color.Gray.Text(task.Short),
-		Long:  task.Long,
-		Args:  cobra.ArbitraryArgs,
+		Use:     task.Usage,
+		Short:   task.Short,
+		Long:    task.Long,
+		Args:    cobra.ArbitraryArgs,
+		GroupID: utils.GROUP_ID_TASKS,
 		// If this is true all flags will be passed to the command as arguments.
 		DisableFlagParsing: true,
 		// Will disable the addition of [flags] to the usage

cmd/task.go

@@ -3,12 +3,13 @@ module main
 go 1.19
 
 require (
-	github.com/gookit/color v1.3.5
-	github.com/spf13/cobra v1.1.1
+	github.com/gookit/color v1.5.2
+	github.com/spf13/cobra v1.6.1
 )
 
 require (
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/testify v1.4.0 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
+	golang.org/x/sys v0.4.0 // indirect
 )