be consistent with "route map" over "routemap"

Author: jroyalty

cmd/routemap/main.go

@@ -74,7 +74,7 @@ func main() {
 
 	rootCmd.Use = filepath.Base(os.Args[0])
 	rootCmd.Version = fmt.Sprintf("%s from %s (%s)", version, date, commit)
-	rootCmd.Short = fmt.Sprintf("Manage Pulsar routemaps [%s]", rootCmd.Version)
+	rootCmd.Short = fmt.Sprintf("Manage Pulsar Route Maps [%s]", rootCmd.Version)
 
 	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
 		return multierr.Combine(
@@ -102,6 +102,7 @@ func main() {
 
 	pf.StringVar(&globals.CacheDir, "cachedir", globals.CacheDir,
 		"Where to store cached data.")
+	pf.MarkHidden("cachedir") // Not being used yet.
 
 	pf.StringVar(&globals.NS1APIBaseURL, "api-baseurl", globals.NS1APIBaseURL,
 		"Base URL for NS1 REST API. Normally the default will suffice.")

internal/crud/cmd.go

@@ -53,12 +53,12 @@ func (o *Options) validateMapID() error {
 
 func (o *Options) addFileFlag(flags *pflag.FlagSet) {
 	flags.StringVar(&o.InputFilename, "file", "",
-		"Routemap file to validate. Default is STDIN.")
+		"Route map file to validate. Default is STDIN.")
 }
 
 func (o *Options) addNoValidateFlag(flags *pflag.FlagSet) {
 	flags.BoolVar(&o.SkipValidate, "no-validate", false,
-		"Validate the routemap before uploading.")
+		"Validate the route map before uploading.")
 }
 
 func (o *Options) addMapIDFlag(flags *pflag.FlagSet, desc string) {
@@ -69,7 +69,7 @@ func addCreateCommand(parentCmd *cobra.Command, globals *config.CommandLineGloba
 	opts := &Options{Globals: globals}
 	sub := &cobra.Command{
 		Use:   "create",
-		Short: "Create a new routemap with optional validation",
+		Short: "Create a new route map with optional validation",
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return multierr.Combine(
 				opts.Globals.RequireAPIAccess(),
@@ -97,7 +97,7 @@ func addListCommand(parentCmd *cobra.Command, globals *config.CommandLineGlobals
 	sub := &cobra.Command{
 		Use:     "list",
 		Aliases: []string{"ls"},
-		Short:   "List available routemaps",
+		Short:   "List available route maps",
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.Globals.RequireAPIAccess()
 		},
@@ -117,7 +117,7 @@ func addReplaceCommand(parentCmd *cobra.Command, globals *config.CommandLineGlob
 	opts := &Options{Globals: globals}
 	sub := &cobra.Command{
 		Use:   "replace",
-		Short: "Replace an existing routemap with optional validation",
+		Short: "Replace an existing route map with optional validation",
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return multierr.Combine(
 				opts.Globals.RequireAPIAccess(),
@@ -142,7 +142,7 @@ func addDeleteCommand(parentCmd *cobra.Command, globals *config.CommandLineGloba
 	opts := &Options{Globals: globals}
 	sub := &cobra.Command{
 		Use:   "delete",
-		Short: "Delete a routemap by ID",
+		Short: "Delete a route map by ID",
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return multierr.Combine(
 				opts.Globals.RequireAPIAccess(),

internal/crud/delete.go

@@ -25,7 +25,7 @@ func RunDeleteCommand(opts *Options) error {
 	if err := client.DeleteRoutemap(opts.MapID); err != nil {
 		return err
 	} else {
-		lg.Printf("deleted routemap %d", opts.MapID)
+		lg.Printf("deleted route map %d", opts.MapID)
 	}
 
 	return nil

internal/crud/list.go

@@ -41,7 +41,7 @@ func RunListCommand(opts *Options) error {
 func prettyPrint(body []byte) error {
 	var rmaps []api.RoutemapPayload
 	if err := json.Unmarshal(body, &rmaps); err != nil {
-		return fmt.Errorf("parsing routemap payload: %v", err)
+		return fmt.Errorf("parsing route map payload: %v", err)
 	}
 
 	tw := tabwriter.NewWriter(os.Stdout, 8, 8, 1, ' ', 0)

internal/crud/upload.go

@@ -44,7 +44,7 @@ func RunCreateOrReplaceCommand(opts *Options) error {
 		lg.Infof("map is valid; ready for upload")
 	}
 
-	lg.Infof("uploading routemap: meta version = %d, sha1 = %s, size = %d",
+	lg.Infof("uploading route map: meta version = %d, sha1 = %s, size = %d",
 		root.MetaVersion(),
 		hex.EncodeToString(root.SHA1),
 		root.SizeInBytes)

internal/validate/cmd.go

@@ -29,7 +29,7 @@ func AddCommands(parentCmd *cobra.Command, globals *config.CommandLineGlobals) {
 	opts := &Options{Globals: globals}
 	sub := &cobra.Command{
 		Use:   "validate",
-		Short: "Load and validate a routemap file",
+		Short: "Load and validate a route map file",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return RunValidateCommand(opts)
 		},
@@ -38,7 +38,7 @@ func AddCommands(parentCmd *cobra.Command, globals *config.CommandLineGlobals) {
 	flags := sub.Flags()
 
 	flags.StringVar(&opts.InputFilename, "file", "",
-		"Routemap file to validate. Default is STDIN.")
+		"Route map file to validate. Default is STDIN.")
 
 	parentCmd.AddCommand(sub)
 }

internal/validate/validator.go

@@ -26,7 +26,7 @@ import (
 )
 
 func RunValidateCommand(opts *Options) error {
-	lg.Infof("reading routemap from '%s'", opts.InputFilename)
+	lg.Infof("reading route map from '%s'", opts.InputFilename)
 	root, summary, err := LoadAndValidate(opts.InputFilename)
 	if err != nil {
 		return PrettyPrintErrors(err)
@@ -176,7 +176,7 @@ func startValidate(root *model.RoutemapRoot, summary *model.RoutemapSummary) err
 	}
 
 	if len(root.Routemap) == 0 {
-		lg.Warnf("routemap is empty; skipping all validation")
+		lg.Warnf("route map is empty; skipping all validation")
 		summary.NumNetworks = 0
 		return nil
 	}

pkg/model/rmap.go

@@ -44,7 +44,7 @@ type RoutemapRoot struct {
 	Raw         []byte `json:"-"`
 }
 
-// LoadRoutemapFileOrStdin loads a routemap from the named file (if name is not empty)
+// LoadRoutemapFileOrStdin loads a route map from the named file (if name is not empty)
 // or falls back to STDIN.
 func LoadRoutemapFileOrStdin(optionalFilename string) (*RoutemapRoot, error) {
 	if len(optionalFilename) == 0 {
@@ -54,7 +54,7 @@ func LoadRoutemapFileOrStdin(optionalFilename string) (*RoutemapRoot, error) {
 	}
 }
 
-// LoadRoutemapFilename loads a routemap from a filename.
+// LoadRoutemapFilename loads a route map from a filename.
 func LoadRoutemapFilename(filename string) (*RoutemapRoot, error) {
 	if source, err := os.Open(filename); err == nil {
 		defer source.Close()
@@ -64,7 +64,7 @@ func LoadRoutemapFilename(filename string) (*RoutemapRoot, error) {
 	}
 }
 
-// LoadRoutemapFile loads a routemap from an already-opened file.
+// LoadRoutemapFile loads a route map from an already-opened file.
 func LoadRoutemapFile(source *os.File) (*RoutemapRoot, error) {
 	rmap := &RoutemapRoot{}
 
@@ -83,7 +83,7 @@ func LoadRoutemapFile(source *os.File) (*RoutemapRoot, error) {
 	if decErr := dec.Decode(rmap); decErr != nil {
 		switch decErr.(type) {
 		case *json.SyntaxError:
-			return nil, fmt.Errorf("parsing routemap: %s at byte offset %d", decErr, decErr.(*json.SyntaxError).Offset)
+			return nil, fmt.Errorf("parsing route map: %s at byte offset %d", decErr, decErr.(*json.SyntaxError).Offset)
 		default:
 			return nil, decErr
 		}