BUGFIX: make cobra ignore flags for tasks

Author: Florian Heinze

cmd/root.go

@@ -25,6 +25,13 @@ and other nifty feature ;)
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute(version, commit string) {
+	// The following lines remove -h and --help flags form the usages
+	//   RootCmd.InitDefaultHelpFlag()
+	//   RootCmd.Flags().MarkHidden("help")
+	// 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"))

cmd/task.go

@@ -7,6 +7,7 @@ import (
 	"main/utils"
 	"os"
 	"path/filepath"
+	"strings"
 	"syscall"
 )
 
@@ -17,8 +18,23 @@ func buildTaskCommand(task utils.DevScriptTask, devScriptPath string) *cobra.Com
 		Short: color.Gray.Text(task.Short),
 		Long:  task.Long,
 		Args:  cobra.ArbitraryArgs,
+		// 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
+		// As we currently do not parse comments with a specific syntax to provide
+		// useful information. The only flags we support are -h and --help they
+		// are always part of the usage template.
+		DisableFlagsInUseLine: true,
 		Run: func(cmd *cobra.Command, args []string) {
-			execDevScriptWithArguments(devScriptPath, append([]string{task.Usage}, args...))
+			// We DisableFlagParsing but we still want to use the -h and --help flag.
+			// This is why we evaluate the args manually and show the help of the
+			// command if needed.
+			argsAsString := strings.Join(args, " ")
+			if argsAsString == "--help" || argsAsString == "-h" {
+				cmd.Help()
+			} else {
+				execDevScriptWithArguments(devScriptPath, append([]string{task.Usage}, args...))
+			}
 		},
 	}
 	return cmd

dev.sh

@@ -11,12 +11,7 @@ set -e
 
 ######### TASKS #########
 
-# runs foo
-function foo() {
-  echo "test"
-}
-
-# use main aus binary
+# exposes ./main binary globally
 function switch-dev-binary() {
     echo "-----------> creating build"
     build
@@ -40,11 +35,12 @@ function restore-dev-binary() {
       echo "no /usr/local/bin/dev_back found. Nothing to restore!"
   fi
 }
-
+# build
 function build() {
   go build main
 }
 
+# install dev dependencies
 function setup() {
   # As the setup typically is more complex we recommend using a separate
   # file `dev_setup.sh`