Command -> Cmd

coder · ammario · Mar 7, 2023 · Feb 25, 2023 · Feb 25, 2023 · Feb 25, 2023
commit fc8e6cafd3102e422e96bd57223612fa7a442fa3
diff --git a/cli/clibase/bigcli.go → cli/clibase/clibase.go b/cli/clibase/bigcli.go → cli/clibase/clibase.go
diff --git a/cli/clibase/command.go → cli/clibase/cmd.go b/cli/clibase/command.go → cli/clibase/cmd.go
@@ -2,12 +2,12 @@ package clibase
 
 import "strings"
 
-// Command describes an executable command.
-type Command struct {
+// Cmd describes an executable command.
+type Cmd struct {
 	// Parent is the direct parent of the command.
-	Parent *Command
+	Parent *Cmd
 	// Children is a list of direct descendants.
-	Children []*Command
+	Children []*Cmd
 	// Use is provided in form "command [flags] [args...]".
 	Use string
 	// Short is a one-line description of the command.
@@ -20,13 +20,13 @@ type Command struct {
 }
 
 // Name returns the first word in the Use string.
-func (c *Command) Name() string {
+func (c *Cmd) Name() string {
 	return strings.Split(c.Use, " ")[0]
 }
 
 // FullName returns the full invocation name of the command,
 // as seen on the command line.
-func (c *Command) FullName() string {
+func (c *Cmd) FullName() string {
 	var names []string
 
 	if c.Parent != nil {
@@ -38,7 +38,7 @@ func (c *Command) FullName() string {
 
 // FullName returns usage of the command, preceded
 // by the usage of its parents.
-func (c *Command) FullUsage() string {
+func (c *Cmd) FullUsage() string {
 	var uses []string
 	if c.Parent != nil {
 		uses = append(uses, c.Parent.FullUsage())

diff --git a/cli/server.go b/cli/server.go
@@ -191,11 +191,11 @@ func Server(newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Close
 			flagSet := cliOpts.FlagSet()
 			// These parents and children will be moved once we convert the
 			// rest of the `cli` package to clibase.
-			flagSet.Usage = usageFn(cmd.ErrOrStderr(), &clibase.Command{
-				Parent: &clibase.Command{
+			flagSet.Usage = usageFn(cmd.ErrOrStderr(), &clibase.Cmd{
+				Parent: &clibase.Cmd{
 					Use: "coder",
 				},
-				Children: []*clibase.Command{
+				Children: []*clibase.Cmd{
 					{
 						Use:   "postgres-builtin-url",
 						Short: "Output the connection URL for the built-in PostgreSQL deployment.",

diff --git a/cli/usage.go b/cli/usage.go
@@ -68,7 +68,7 @@ var usageTemplate = template.Must(
 				s = wordwrap.WrapString(s, 60)
 				return s
 			},
-			"optionGroups": func(cmd *clibase.Command) []optionGroup {
+			"optionGroups": func(cmd *clibase.Cmd) []optionGroup {
 				groups := []optionGroup{{
 					// Default group.
 					Name:        "",
@@ -130,7 +130,7 @@ var usageTemplate = template.Must(
 
 // usageFn returns a function that generates usage (help)
 // output for a given command.
-func usageFn(output io.Writer, cmd *clibase.Command) func() {
+func usageFn(output io.Writer, cmd *clibase.Cmd) func() {
 	return func() {
 		err := usageTemplate.Execute(output, cmd)
 		if err != nil {

diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -321,8 +321,8 @@ var (
 		Parent: &DeploymentGroupNetworking,
 		Name:   "TLS",
 		Description: `Configure TLS / HTTPS for your Coder deployment. If you're running
-Coder behind a TLS-terminating reverse proxy or are accessing Coder over a
-secure link, you can safely ignore these settings.`,
+ Coder behind a TLS-terminating reverse proxy or are accessing Coder over a
+ secure link, you can safely ignore these settings.`,
 	}
 	DeploymentGroupNetworkingHTTP = clibase.Group{
 		Parent: &DeploymentGroupNetworking,
@@ -332,9 +332,9 @@ secure link, you can safely ignore these settings.`,
 		Parent: &DeploymentGroupNetworking,
 		Name:   "DERP",
 		Description: `Most Coder deployments never have to think about DERP because all connections
-between workspaces and users are peer-to-peer. However, when Coder cannot establish
-a peer to peer connection, Coder uses a distributed relay network backed by
-Tailscale and WireGuard.`,
+ between workspaces and users are peer-to-peer. However, when Coder cannot establish
+ a peer to peer connection, Coder uses a distributed relay network backed by
+ Tailscale and WireGuard.`,
 	}
 	DeploymentGroupIntrospection = clibase.Group{
 		Name:        "Introspection",
@@ -1272,6 +1272,7 @@ Write out the current server configuration to the path specified by --config.`,
 			Description: "Git Authentication providers",
 			YAML:        "gitAuthProviders",
 			Value:       &c.GitAuthProviders,
+			Hidden:      true,
 		},
 	}
 }