fix: incorporate feedback on structuring of tools

Author: FarhanSajid1

pkg/commands/commands.go

@@ -1,7 +1,6 @@
 package commands
 
 import (
-	"github.com/fastly/cli/pkg/commands/domainv1/tools"
 	"github.com/fastly/kingpin"
 
 	"github.com/fastly/cli/pkg/argparser"
@@ -79,6 +78,8 @@ import (
 	tlscustomprivatekey "github.com/fastly/cli/pkg/commands/tls/custom/privatekey"
 	tlsplatform "github.com/fastly/cli/pkg/commands/tls/platform"
 	tlssubscription "github.com/fastly/cli/pkg/commands/tls/subscription"
+	"github.com/fastly/cli/pkg/commands/tools"
+	domainTools "github.com/fastly/cli/pkg/commands/tools/domain"
 	"github.com/fastly/cli/pkg/commands/update"
 	"github.com/fastly/cli/pkg/commands/user"
 	"github.com/fastly/cli/pkg/commands/vcl"
@@ -204,9 +205,6 @@ func Define( // nolint:revive // function-length
 	domainv1Delete := domainv1.NewDeleteCommand(domainv1CmdRoot.CmdClause, data)
 	domainv1Describe := domainv1.NewDescribeCommand(domainv1CmdRoot.CmdClause, data)
 	domainv1List := domainv1.NewListCommand(domainv1CmdRoot.CmdClause, data)
-	domainv1ToolsCmdRoot := tools.NewRootCommand(domainv1CmdRoot.CmdClause, data)
-	domainv1ToolsStatus := tools.NewDomainStatusCommand(domainv1ToolsCmdRoot.CmdClause, data)
-	domainv1ToolsSuggestions := tools.NewDomainSuggestionsCommand(domainv1ToolsCmdRoot.CmdClause, data)
 	domainv1Update := domainv1.NewUpdateCommand(domainv1CmdRoot.CmdClause, data)
 	healthcheckCmdRoot := healthcheck.NewRootCommand(app, data)
 	healthcheckCreate := healthcheck.NewCreateCommand(healthcheckCmdRoot.CmdClause, data)
@@ -490,6 +488,10 @@ func Define( // nolint:revive // function-length
 	tlsSubscriptionDescribe := tlssubscription.NewDescribeCommand(tlsSubscriptionCmdRoot.CmdClause, data)
 	tlsSubscriptionList := tlssubscription.NewListCommand(tlsSubscriptionCmdRoot.CmdClause, data)
 	tlsSubscriptionUpdate := tlssubscription.NewUpdateCommand(tlsSubscriptionCmdRoot.CmdClause, data)
+	toolsCmdRoot := tools.NewRootCommand(app, data)
+	toolsDomainCmdRoot := domainTools.NewRootCommand(toolsCmdRoot.CmdClause, data)
+	toolsDomainStatus := domainTools.NewDomainStatusCommand(toolsDomainCmdRoot.CmdClause, data)
+	toolsDomainSuggestions := domainTools.NewDomainSuggestionsCommand(toolsDomainCmdRoot.CmdClause, data)
 	updateRoot := update.NewRootCommand(app, data)
 	userCmdRoot := user.NewRootCommand(app, data)
 	userCreate := user.NewCreateCommand(userCmdRoot.CmdClause, data)
@@ -619,10 +621,7 @@ func Define( // nolint:revive // function-length
 		domainv1Delete,
 		domainv1Describe,
 		domainv1List,
-		domainv1ToolsCmdRoot,
 		domainv1Update,
-		domainv1ToolsStatus,
-		domainv1ToolsSuggestions,
 		healthcheckCmdRoot,
 		healthcheckCreate,
 		healthcheckDelete,
@@ -902,6 +901,10 @@ func Define( // nolint:revive // function-length
 		tlsSubscriptionDescribe,
 		tlsSubscriptionList,
 		tlsSubscriptionUpdate,
+		toolsCmdRoot,
+		toolsDomainCmdRoot,
+		toolsDomainStatus,
+		toolsDomainSuggestions,
 		updateRoot,
 		userCmdRoot,
 		userCreate,

pkg/commands/domainv1/tools/doc.go

@@ -0,0 +1,2 @@
+// Package tools contains tools for working with the Fastly platform.
+package tools

pkg/commands/tools/doc.go

@@ -0,0 +1,2 @@
+// Package domain contains Domain Discovery API tools.
+package domain

pkg/commands/tools/domain/doc.go

@@ -0,0 +1,31 @@
+package domain
+
+import (
+	"io"
+
+	"github.com/fastly/cli/pkg/argparser"
+	"github.com/fastly/cli/pkg/global"
+)
+
+// RootCommand is the parent command for all tool subcommands in this package.
+// It should be installed under the primary `tools` root command.
+type RootCommand struct {
+	argparser.Base
+	// no flags
+}
+
+// CommandName is the string to be used to invoke this command.
+const CommandName = "domain"
+
+// NewRootCommand returns a new tools command registered in the parent.
+func NewRootCommand(parent argparser.Registerer, g *global.Data) *RootCommand {
+	var c RootCommand
+	c.Globals = g
+	c.CmdClause = parent.Command(CommandName, "Domain Discovery API tools")
+	return &c
+}
+
+// Exec implements the command interface.
+func (c *RootCommand) Exec(_ io.Reader, _ io.Writer) error {
+	panic("unreachable")
+}

pkg/commands/tools/domain/root.go

@@ -1,4 +1,4 @@
-package tools
+package domain
 
 import (
 	"errors"
@@ -12,7 +12,7 @@ import (
 	"github.com/fastly/go-fastly/v10/fastly/domains/v1/tools/status"
 )
 
-// GetDomainStatusCommand calls the Fastly API to check the availability status of a domain.
+// GetDomainStatusCommand calls the Fastly API to check the availability of a domain name.
 type GetDomainStatusCommand struct {
 	argparser.Base
 	argparser.JSONOutput
@@ -30,12 +30,12 @@ func NewDomainStatusCommand(parent argparser.Registerer, g *global.Data) *GetDom
 		},
 	}
 
-	cmd.CmdClause = parent.Command("status", "Check the registration status of a single domain name.")
+	cmd.CmdClause = parent.Command("status", "Check domain name availability")
 	// Required.
 	cmd.CmdClause.Arg("domain", "Domain name to check").Required().StringVar(&cmd.domain)
 	// Optional.
 	cmd.RegisterFlagBool(cmd.JSONFlag())
-	cmd.CmdClause.Flag("scope", "Scope determines the availability check to perform, specify `estimate` for an estimated check").Action(cmd.scope.Set).StringVar(&cmd.scope.Value)
+	cmd.CmdClause.Flag("scope", "Specify `--scope=estimate` to perform an “estimated” availability check, which checks the DNS and domain aftermarkets, not domain registries").Action(cmd.scope.Set).StringVar(&cmd.scope.Value)
 
 	return &cmd
 }

pkg/commands/domainv1/tools/status.go pkg/commands/tools/domain/status.gopkg/commands/domainv1/tools/status.go renamed to pkg/commands/tools/domain/status.go

@@ -1,13 +1,13 @@
-package tools_test
+package domain_test
 
 import (
 	"bytes"
 	"io"
 	"net/http"
 	"testing"
 
-	root "github.com/fastly/cli/pkg/commands/domainv1"
-	"github.com/fastly/cli/pkg/commands/domainv1/tools"
+	"github.com/fastly/cli/pkg/commands/tools"
+	"github.com/fastly/cli/pkg/commands/tools/domain"
 	"github.com/fastly/cli/pkg/testutil"
 	"github.com/fastly/go-fastly/v10/fastly"
 	"github.com/fastly/go-fastly/v10/fastly/domains/v1/tools/status"
@@ -121,5 +121,5 @@ Offers:
 `,
 		},
 	}
-	testutil.RunCLIScenarios(t, []string{root.CommandName, tools.CommandName, "status"}, scenarios)
+	testutil.RunCLIScenarios(t, []string{tools.CommandName, domain.CommandName, "status"}, scenarios)
 }

…g/commands/domainv1/tools/status_test.go pkg/commands/tools/domain/status_test.gopkg/commands/domainv1/tools/status_test.go renamed to pkg/commands/tools/domain/status_test.go pkg/commands/domainv1/tools/status_test.go renamed to pkg/commands/tools/domain/status_test.go

@@ -1,4 +1,4 @@
-package tools
+package domain
 
 import (
 	"errors"
@@ -14,7 +14,7 @@ import (
 	"github.com/fastly/go-fastly/v10/fastly/domains/v1/tools/suggest"
 )
 
-// GetDomainSuggestionsCommand calls the Fastly API to retrieve domain suggestions from the provided term(s).
+// GetDomainSuggestionsCommand calls the Fastly API and results domain search results for a given query
 type GetDomainSuggestionsCommand struct {
 	argparser.Base
 	argparser.JSONOutput
@@ -35,14 +35,14 @@ func NewDomainSuggestionsCommand(parent argparser.Registerer, g *global.Data) *G
 		},
 	}
 
-	cmd.CmdClause = parent.Command("suggest", "Performs real-time queries against the known zones database")
+	cmd.CmdClause = parent.Command("suggest", "Returns domain search results for a given query")
 	// Required.
-	cmd.CmdClause.Arg("query", "Words to use for domain suggestions").Required().StringsVar(&cmd.query)
+	cmd.CmdClause.Arg("query", "Search query, e.g. “acme coffee shop”").Required().StringsVar(&cmd.query)
 	// Optional.
 	cmd.CmdClause.Flag("defaults", "Comma-separated list of default zones to include in the search results response").Action(cmd.defaults.Set).StringVar(&cmd.defaults.Value)
 	cmd.RegisterFlagBool(cmd.JSONFlag())
-	cmd.CmdClause.Flag("keywords", "Comma-separated list of keywords for seeding the results").Action(cmd.keywords.Set).StringVar(&cmd.keywords.Value)
-	cmd.CmdClause.Flag("location", "Overrides the IP location detection for country-code zones, with a two-character country code").Action(cmd.location.Set).StringVar(&cmd.location.Value)
+	cmd.CmdClause.Flag("keywords", "Comma-separated list of keywords for seeding the search results").Action(cmd.keywords.Set).StringVar(&cmd.keywords.Value)
+	cmd.CmdClause.Flag("location", "Override IP geolocation with a two-character country code, e.g. `--location=in` to include Indian domain zones in the search results").Action(cmd.location.Set).StringVar(&cmd.location.Value)
 	cmd.CmdClause.Flag("vendor", "The domain name of a specific registrar or vendor ").Action(cmd.vendor.Set).StringVar(&cmd.vendor.Value)
 
 	return &cmd

pkg/commands/domainv1/tools/suggest.go pkg/commands/tools/domain/suggest.gopkg/commands/domainv1/tools/suggest.go renamed to pkg/commands/tools/domain/suggest.go

@@ -1,13 +1,13 @@
-package tools_test
+package domain_test
 
 import (
 	"bytes"
 	"io"
 	"net/http"
 	"testing"
 
-	root "github.com/fastly/cli/pkg/commands/domainv1"
-	"github.com/fastly/cli/pkg/commands/domainv1/tools"
+	"github.com/fastly/cli/pkg/commands/tools"
+	"github.com/fastly/cli/pkg/commands/tools/domain"
 	"github.com/fastly/cli/pkg/testutil"
 	"github.com/fastly/go-fastly/v10/fastly"
 	"github.com/fastly/go-fastly/v10/fastly/domains/v1/tools/suggest"
@@ -195,5 +195,5 @@ Path: /g
 `,
 		},
 	}
-	testutil.RunCLIScenarios(t, []string{root.CommandName, tools.CommandName, "suggest"}, scenarios)
+	testutil.RunCLIScenarios(t, []string{tools.CommandName, domain.CommandName, "suggest"}, scenarios)
 }

…/commands/domainv1/tools/suggest_test.go pkg/commands/tools/domain/suggest_test.gopkg/commands/domainv1/tools/suggest_test.go renamed to pkg/commands/tools/domain/suggest_test.go pkg/commands/domainv1/tools/suggest_test.go renamed to pkg/commands/tools/domain/suggest_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 // RootCommand is the parent command for all tool subcommands in this package.
-// It should be installed under the primary `domainv1` root command.
+// It should be installed under the primary root command.
 type RootCommand struct {
 	argparser.Base
 	// no flags
@@ -21,7 +21,7 @@ const CommandName = "tools"
 func NewRootCommand(parent argparser.Registerer, g *global.Data) *RootCommand {
 	var c RootCommand
 	c.Globals = g
-	c.CmdClause = parent.Command(CommandName, "Tools for domain discovery and operations")
+	c.CmdClause = parent.Command(CommandName, "Tools for working with the Fastly platform")
 	return &c
 }