User facing commands consistent wih "options" vs 'flags'.

anastasiamac · anastasiamac · commit cac5bc1a89cc · 2018-12-05T20:46:29.000+10:00
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -287,7 +287,7 @@
 
 [[constraint]]
   name = "github.com/juju/cmd"
-  revision = "e74f39857ca013cf63947ba2843806f7afdd380d"
+  revision = "fd568e4a4120f7d5a417252d701daff61a6322b4"
 
 [[constraint]]
   name = "github.com/juju/collections"
diff --git a/cmd/juju/application/deploy_test.go b/cmd/juju/application/deploy_test.go
@@ -797,7 +797,7 @@ func (s *DeploySuite) TestDeployLocalWithTerms(c *gc.C) {
 
 func (s *DeploySuite) TestDeployFlags(c *gc.C) {
 	command := DeployCommand{}
-	flagSet := gnuflag.NewFlagSet(command.Info().Name, gnuflag.ContinueOnError)
+	flagSet := gnuflag.NewFlagSetWithFlagKnownAs(command.Info().Name, gnuflag.ContinueOnError, "option")
 	command.SetFlags(flagSet)
 	c.Assert(command.flagSet, jc.DeepEquals, flagSet)
 	// Add to the slice below if a new flag is introduced which is valid for
diff --git a/cmd/juju/commands/helptool.go b/cmd/juju/commands/helptool.go
@@ -130,7 +130,7 @@ func (c *helpToolCommand) Run(ctx *cmd.Context) error {
 			return err
 		}
 		info := c.Info()
-		f := gnuflag.NewFlagSet(info.Name, gnuflag.ContinueOnError)
+		f := gnuflag.NewFlagSetWithFlagKnownAs(info.Name, gnuflag.ContinueOnError, cmd.FlagAlias(c, "option"))
 		c.SetFlags(f)
 		ctx.Stdout.Write(info.Help(f))
 	}
diff --git a/cmd/juju/commands/main.go b/cmd/juju/commands/main.go
@@ -259,6 +259,7 @@ func NewJujuCommand(ctx *cmd.Context) cmd.Command {
 		Doc:                 jujuDoc,
 		MissingCallback:     RunPlugin,
 		UserAliasesFilename: osenv.JujuXDGDataHomePath("aliases"),
+		FlagKnownAs:         "option",
 	})
 	jcmd.AddHelpTopic("basics", "Basic Help Summary", usageHelp)
 	registerCommands(jcmd, ctx)
diff --git a/cmd/juju/commands/main_test.go b/cmd/juju/commands/main_test.go
@@ -4,7 +4,9 @@
 package commands
 
 import (
+	"bytes"
 	"fmt"
+	"github.com/juju/gnuflag"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -40,15 +42,25 @@ type MainSuite struct {
 
 var _ = gc.Suite(&MainSuite{})
 
+func helpText(command cmd.Command, name string) string {
+	buff := &bytes.Buffer{}
+	info := command.Info()
+	info.Name = name
+	f := gnuflag.NewFlagSetWithFlagKnownAs(info.Name, gnuflag.ContinueOnError, cmd.FlagAlias(command, "option"))
+	command.SetFlags(f)
+	buff.Write(info.Help(f))
+	return buff.String()
+}
+
 func deployHelpText() string {
-	return cmdtesting.HelpText(application.NewDeployCommand(), "juju deploy")
+	return helpText(application.NewDeployCommand(), "juju deploy")
 }
 func configHelpText() string {
-	return cmdtesting.HelpText(application.NewConfigCommand(), "juju config")
+	return helpText(application.NewConfigCommand(), "juju config")
 }
 
 func syncToolsHelpText() string {
-	return cmdtesting.HelpText(newSyncToolsCommand(), "juju sync-agent-binaries")
+	return helpText(newSyncToolsCommand(), "juju sync-agent-binaries")
 }
 
 func (s *MainSuite) TestRunMain(c *gc.C) {
@@ -104,17 +116,17 @@ func (s *MainSuite) TestRunMain(c *gc.C) {
 		summary: "unknown option before command",
 		args:    []string{"--cheese", "bootstrap"},
 		code:    2,
-		out:     "ERROR flag provided but not defined: --cheese\n",
+		out:     "ERROR option provided but not defined: --cheese\n",
 	}, {
 		summary: "unknown option after command",
 		args:    []string{"bootstrap", "--cheese"},
 		code:    2,
-		out:     "ERROR flag provided but not defined: --cheese\n",
+		out:     "ERROR option provided but not defined: --cheese\n",
 	}, {
 		summary: "known option, but specified before command",
 		args:    []string{"--model", "blah", "bootstrap"},
 		code:    2,
-		out:     "ERROR flag provided but not defined: --model\n",
+		out:     "ERROR option provided but not defined: --model\n",
 	}, {
 		summary: "juju sync-agent-binaries registered properly",
 		args:    []string{"sync-agent-binaries", "--help"},
diff --git a/cmd/juju/commands/plugin.go b/cmd/juju/commands/plugin.go
@@ -54,7 +54,7 @@ func RunPlugin(ctx *cmd.Context, subcommand string, args []string) error {
 	// We process common flags supported by Juju commands.
 	// To do this, we extract only those supported flags from the
 	// argument list to avoid confusing flags.Parse().
-	flags := gnuflag.NewFlagSet(cmdName, gnuflag.ContinueOnError)
+	flags := gnuflag.NewFlagSetWithFlagKnownAs(cmdName, gnuflag.ContinueOnError, "option")
 	flags.SetOutput(ioutil.Discard)
 	plugin.SetFlags(flags)
 	jujuArgs := extractJujuArgs(args)
diff --git a/cmd/supercommand.go b/cmd/supercommand.go
@@ -49,6 +49,7 @@ func NewSuperCommand(p cmd.SuperCommandParams) *cmd.SuperCommand {
 	// tests to assert that this string value is correct.
 	p.Version = current.String()
 	p.NotifyRun = runNotifier
+	p.FlagKnownAs = "option"
 	return cmd.NewSuperCommand(p)
 }
 

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ func (c helpToolCommand) Run(ctx cmd.Context) error {`
`130`	`130`	`return err`
`131`	`131`	`}`
`132`	`132`	`info := c.Info()`
`133`		`- f := gnuflag.NewFlagSet(info.Name, gnuflag.ContinueOnError)`
	`133`	`+ f := gnuflag.NewFlagSetWithFlagKnownAs(info.Name, gnuflag.ContinueOnError, cmd.FlagAlias(c, "option"))`
`134`	`134`	`c.SetFlags(f)`
`135`	`135`	`ctx.Stdout.Write(info.Help(f))`
`136`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ func NewSuperCommand(p cmd.SuperCommandParams) *cmd.SuperCommand {`
`49`	`49`	`// tests to assert that this string value is correct.`
`50`	`50`	`p.Version = current.String()`
`51`	`51`	`p.NotifyRun = runNotifier`
	`52`	`+ p.FlagKnownAs = "option"`
`52`	`53`	`return cmd.NewSuperCommand(p)`
`53`	`54`	`}`
`54`	`55`