Improved the help text of the formatter flag in the run command (#347)

* Improved the help text of the formatter flag in the run command

* Made some more changes to the help text for the run command

* made some small changes to the help text of the run and build cmd

cmd/godog/internal/cmd_build.go

@@ -32,7 +32,8 @@ The test runner can be executed with the same flags as when using godog run.`,
 		Run: buildCmdRunFunc,
 	}
 
-	buildCmd.Flags().StringVarP(&buildOutput, "output", "o", buildOutputDefault, "compiles the test runner to the named file")
+	buildCmd.Flags().StringVarP(&buildOutput, "output", "o", buildOutputDefault, `compiles the test runner to the named file
+`)
 
 	return buildCmd
 }

cmd/godog/internal/cmd_run.go

@@ -28,9 +28,9 @@ buildable go source.`,
   godog run <feature> <feature>
 
   Optional feature(s) to run:
-  - dir (features/)
+    dir (features/)
-  - feature (*.feature)
+    feature (*.feature)
-  - scenario at specific line (*.feature:10)
+    scenario at specific line (*.feature:10)
   If no feature arguments are supplied, godog will use "features/" by default.`,
 		Run: runCmdRunFunc,
 	}

internal/flags/flags.go

@@ -17,26 +17,33 @@ func BindRunCmdFlags(prefix string, flagSet *pflag.FlagSet, opts *Options) {
 	flagSet.BoolVar(&opts.NoColors, prefix+"no-colors", opts.NoColors, "disable ansi colors")
 	flagSet.IntVarP(&opts.Concurrency, prefix+"concurrency", "c", opts.Concurrency, "run the test suite with concurrency")
 	flagSet.StringVarP(&opts.Tags, prefix+"tags", "t", opts.Tags, `filter scenarios by tags, expression can be:
-- "@wip": run all scenarios with wip tag
+  "@wip"           run all scenarios with wip tag
-- "~@wip": exclude all scenarios with wip tag
+  "~@wip"          exclude all scenarios with wip tag
-- "@wip && ~@new": run wip scenarios, but exclude new
+  "@wip && ~@new"  run wip scenarios, but exclude new
-- "@wip,@undone": run wip or undone scenarios`)
+  "@wip,@undone"   run wip or undone scenarios`)
-	flagSet.StringVarP(&opts.Format, prefix+"format", "f", opts.Format, `writes the formatted output to stdout
+	flagSet.StringVarP(&opts.Format, prefix+"format", "f", opts.Format, `will write a report according to the selected formatter
-built-in formatters:
+
-- progress: prints a character per step
+usage:
-- cucumber: produces cucumber JSON format output
+  -f <formatter>
-- events: produces JSON event stream, based on spec: 0.1.0
+  will use the formatter and write the report on stdout
-- junit: prints junit compatible xml to stdout
+  -f <formatter>:<file_path>
-- pretty: prints every feature with runtime statuses
+  will use the formatter and write the report to the file path
-`)
+
+built-in formatters are:
+  progress  prints a character per step
+  cucumber  produces a Cucumber JSON report
+  events    produces JSON event stream, based on spec: 0.1.0
+  junit     produces JUnit compatible XML report
+  pretty    prints every feature with runtime statuses
+ `)
 
 	flagSet.BoolVarP(&opts.ShowStepDefinitions, prefix+"definitions", "d", opts.ShowStepDefinitions, "print all available step definitions")
 	flagSet.BoolVar(&opts.StopOnFailure, prefix+"stop-on-failure", opts.StopOnFailure, "stop processing on first failed scenario")
 	flagSet.BoolVar(&opts.Strict, prefix+"strict", opts.Strict, "fail suite when there are pending or undefined steps")
 
 	flagSet.Int64Var(&opts.Randomize, prefix+"random", opts.Randomize, `randomly shuffle the scenario execution order
---random
+  --random
 specify SEED to reproduce the shuffling from a previous run
---random=5738`)
+  --random=5738`)
 	flagSet.Lookup(prefix + "random").NoOptDefVal = "-1"
 }