general improvements for consistency between commands

umbynos · umbynos · commit 8ff498b65d7c · 2021-11-19T12:32:49.000+01:00
diff --git a/cli/burnbootloader/burnbootloader.go b/cli/burnbootloader/burnbootloader.go
@@ -47,7 +47,7 @@ func NewCommand() *cobra.Command {
 		Long:    tr("Upload the bootloader on the board using an external programmer."),
 		Example: "  " + os.Args[0] + " burn-bootloader -b arduino:avr:uno -P atmel_ice",
 		Args:    cobra.MaximumNArgs(1),
-		Run:     run,
+		Run:     runBootloaderCommand,
 	}
 
 	fqbn.AddToCommand(burnBootloaderCommand)
@@ -61,7 +61,7 @@ func NewCommand() *cobra.Command {
 	return burnBootloaderCommand
 }
 
-func run(command *cobra.Command, args []string) {
+func runBootloaderCommand(command *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
 
 	// We don't need a Sketch to upload a board's bootloader
diff --git a/cli/compile/compile.go b/cli/compile/compile.go
@@ -76,7 +76,7 @@ func NewCommand() *cobra.Command {
 			"  " + os.Args[0] + ` compile -b arduino:avr:uno --build-property "build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n" +
 			"  " + os.Args[0] + ` compile -b arduino:avr:uno --build-property build.extra_flags=-DPIN=2 --build-property "compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n",
 		Args: cobra.MaximumNArgs(1),
-		Run:  run,
+		Run:  runCompileCommand,
 	}
 
 	fqbn.AddToCommand(compileCommand)
@@ -120,7 +120,7 @@ func NewCommand() *cobra.Command {
 	return compileCommand
 }
 
-func run(cmd *cobra.Command, args []string) {
+func runCompileCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
 	path := ""
diff --git a/cli/completion/completion.go b/cli/completion/completion.go
@@ -31,22 +31,22 @@ var (
 
 // NewCommand created a new `completion` command
 func NewCommand() *cobra.Command {
-	command := &cobra.Command{
+	completionCommand := &cobra.Command{
 		Use:       "completion [bash|zsh|fish|powershell] [--no-descriptions]",
 		ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
 		Args:      cobra.ExactArgs(1),
 		Short:     tr("Generates completion scripts"),
 		Long:      tr("Generates completion scripts for various shells"),
 		Example: "  " + os.Args[0] + " completion bash > completion.sh\n" +
 			"  " + "source completion.sh",
-		Run: run,
+		Run: runCompletionCommand,
 	}
-	command.Flags().BoolVar(&completionNoDesc, "no-descriptions", false, tr("Disable completion description for shells that support it"))
+	completionCommand.Flags().BoolVar(&completionNoDesc, "no-descriptions", false, tr("Disable completion description for shells that support it"))
 
-	return command
+	return completionCommand
 }
 
-func run(cmd *cobra.Command, args []string) {
+func runCompletionCommand(cmd *cobra.Command, args []string) {
 	if completionNoDesc && (args[0] == "powershell") {
 		feedback.Errorf(tr("Error: command description is not supported by %v"), args[0])
 		os.Exit(errorcodes.ErrGeneric)
diff --git a/cli/config/config.go b/cli/config/config.go
@@ -36,7 +36,7 @@ func NewCommand() *cobra.Command {
 
 	configCommand.AddCommand(initAddCommand())
 	configCommand.AddCommand(initDeleteCommand())
-	configCommand.AddCommand(initDumpCmd())
+	configCommand.AddCommand(initDumpCommand())
 	configCommand.AddCommand(initInitCommand())
 	configCommand.AddCommand(initRemoveCommand())
 	configCommand.AddCommand(initSetCommand())
diff --git a/cli/config/delete.go b/cli/config/delete.go
@@ -27,7 +27,7 @@ import (
 )
 
 func initDeleteCommand() *cobra.Command {
-	addCommand := &cobra.Command{
+	deleteCommand := &cobra.Command{
 		Use:   "delete",
 		Short: tr("Deletes a settings key and all its sub keys."),
 		Long:  tr("Deletes a settings key and all its sub keys."),
@@ -40,7 +40,7 @@ func initDeleteCommand() *cobra.Command {
 			return configuration.Settings.AllKeys(), cobra.ShellCompDirectiveDefault
 		},
 	}
-	return addCommand
+	return deleteCommand
 }
 
 func runDeleteCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/config/dump.go b/cli/config/dump.go
@@ -25,16 +25,21 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
-func initDumpCmd() *cobra.Command {
-	var dumpCmd = &cobra.Command{
+func initDumpCommand() *cobra.Command {
+	var dumpCommand = &cobra.Command{
 		Use:     "dump",
 		Short:   tr("Prints the current configuration"),
 		Long:    tr("Prints the current configuration."),
 		Example: "  " + os.Args[0] + " config dump",
 		Args:    cobra.NoArgs,
 		Run:     runDumpCommand,
 	}
-	return dumpCmd
+	return dumpCommand
+}
+
+func runDumpCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino config dump`")
+	feedback.PrintResult(dumpResult{configuration.Settings.AllSettings()})
 }
 
 // output from this command requires special formatting, let's create a dedicated
@@ -56,8 +61,3 @@ func (dr dumpResult) String() string {
 
 	return string(bs)
 }
-
-func runDumpCommand(cmd *cobra.Command, args []string) {
-	logrus.Info("Executing `arduino config dump`")
-	feedback.PrintResult(dumpResult{configuration.Settings.AllSettings()})
-}
diff --git a/cli/config/remove.go b/cli/config/remove.go
@@ -26,7 +26,7 @@ import (
 )
 
 func initRemoveCommand() *cobra.Command {
-	addCommand := &cobra.Command{
+	removeCommand := &cobra.Command{
 		Use:   "remove",
 		Short: tr("Removes one or more values from a setting."),
 		Long:  tr("Removes one or more values from a setting."),
@@ -39,7 +39,7 @@ func initRemoveCommand() *cobra.Command {
 			return GetConfigurationKeys(), cobra.ShellCompDirectiveDefault
 		},
 	}
-	return addCommand
+	return removeCommand
 }
 
 func runRemoveCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/config/set.go b/cli/config/set.go
@@ -27,7 +27,7 @@ import (
 )
 
 func initSetCommand() *cobra.Command {
-	addCommand := &cobra.Command{
+	setCommand := &cobra.Command{
 		Use:   "set",
 		Short: tr("Sets a setting value."),
 		Long:  tr("Sets a setting value."),
@@ -42,7 +42,7 @@ func initSetCommand() *cobra.Command {
 			return configuration.Settings.AllKeys(), cobra.ShellCompDirectiveDefault
 		},
 	}
-	return addCommand
+	return setCommand
 }
 
 func runSetCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/core/uninstall.go b/cli/core/uninstall.go
@@ -32,7 +32,7 @@ import (
 )
 
 func initUninstallCommand() *cobra.Command {
-	return &cobra.Command{
+	uninstallCommand := &cobra.Command{
 		Use:     fmt.Sprintf("uninstall %s:%s ...", tr("PACKAGER"), tr("ARCH")),
 		Short:   tr("Uninstalls one or more cores and corresponding tool dependencies if no longer used."),
 		Long:    tr("Uninstalls one or more cores and corresponding tool dependencies if no longer used."),
@@ -43,6 +43,7 @@ func initUninstallCommand() *cobra.Command {
 			return arguments.GetUninstallableCores(), cobra.ShellCompDirectiveDefault
 		},
 	}
+	return uninstallCommand
 }
 
 func runUninstallCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/daemon/daemon.go b/cli/daemon/daemon.go
@@ -50,20 +50,20 @@ var (
 
 // NewCommand created a new `daemon` command
 func NewCommand() *cobra.Command {
-	cmd := &cobra.Command{
+	daemonCommand := &cobra.Command{
 		Use:     "daemon",
 		Short:   tr("Run as a daemon on port: %s", configuration.Settings.GetString("daemon.port")),
 		Long:    tr("Running as a daemon the initialization of cores and libraries is done only once."),
 		Example: "  " + os.Args[0] + " daemon",
 		Args:    cobra.NoArgs,
 		Run:     runDaemonCommand,
 	}
-	cmd.PersistentFlags().String("port", "", tr("The TCP port the daemon will listen to"))
-	configuration.Settings.BindPFlag("daemon.port", cmd.PersistentFlags().Lookup("port"))
-	cmd.Flags().BoolVar(&daemonize, "daemonize", false, tr("Do not terminate daemon process if the parent process dies"))
-	cmd.Flags().BoolVar(&debug, "debug", false, tr("Enable debug logging of gRPC calls"))
-	cmd.Flags().StringSliceVar(&debugFilters, "debug-filter", []string{}, tr("Display only the provided gRPC calls"))
-	return cmd
+	daemonCommand.PersistentFlags().String("port", "", tr("The TCP port the daemon will listen to"))
+	configuration.Settings.BindPFlag("daemon.port", daemonCommand.PersistentFlags().Lookup("port"))
+	daemonCommand.Flags().BoolVar(&daemonize, "daemonize", false, tr("Do not terminate daemon process if the parent process dies"))
+	daemonCommand.Flags().BoolVar(&debug, "debug", false, tr("Enable debug logging of gRPC calls"))
+	daemonCommand.Flags().StringSliceVar(&debugFilters, "debug-filter", []string{}, tr("Display only the provided gRPC calls"))
+	return daemonCommand
 }
 
 func runDaemonCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/generatedocs/generatedocs.go b/cli/generatedocs/generatedocs.go
@@ -31,30 +31,30 @@ var (
 	tr        = i18n.Tr
 )
 
-// NewCommand created a new `generatedocs` command
+// NewCommand created a new `generate-docs` command
 func NewCommand() *cobra.Command {
-	command := &cobra.Command{
+	generateDocsCommand := &cobra.Command{
 		Use:     "generate-docs",
 		Short:   tr("Generates bash completion and command manpages."),
 		Long:    tr("Generates bash completion and command manpages."),
 		Example: "  " + os.Args[0] + " generate-docs bash-completions",
 		Hidden:  true,
 	}
 
-	command.PersistentFlags().StringVarP(&outputDir, "output-dir", "o", "",
+	generateDocsCommand.PersistentFlags().StringVarP(&outputDir, "output-dir", "o", "",
 		tr("Directory where to save generated files. Default is './docs', the directory must exist."))
-	command.AddCommand(&cobra.Command{
+	generateDocsCommand.AddCommand(&cobra.Command{
 		Use:  "manpage",
 		Args: cobra.NoArgs,
 		Run:  generateManPages,
 	})
-	command.AddCommand(&cobra.Command{
+	generateDocsCommand.AddCommand(&cobra.Command{
 		Use:  "bash-completions",
 		Args: cobra.NoArgs,
 		Run:  generateBashCompletions,
 	})
 
-	return command
+	return generateDocsCommand
 }
 
 func generateBashCompletions(cmd *cobra.Command, args []string) {
diff --git a/cli/sketch/archive.go b/cli/sketch/archive.go
@@ -34,7 +34,7 @@ var includeBuildDir bool
 
 // initArchiveCommand creates a new `archive` command
 func initArchiveCommand() *cobra.Command {
-	command := &cobra.Command{
+	archiveCommand := &cobra.Command{
 		Use:   fmt.Sprintf("archive <%s> <%s>", tr("sketchPath"), tr("archivePath")),
 		Short: tr("Creates a zip file containing all sketch files."),
 		Long:  tr("Creates a zip file containing all sketch files."),
@@ -48,9 +48,9 @@ func initArchiveCommand() *cobra.Command {
 		Run:  runArchiveCommand,
 	}
 
-	command.Flags().BoolVar(&includeBuildDir, "include-build-dir", false, tr("Includes %s directory in the archive.", "build"))
+	archiveCommand.Flags().BoolVar(&includeBuildDir, "include-build-dir", false, tr("Includes %s directory in the archive.", "build"))
 
-	return command
+	return archiveCommand
 }
 
 func runArchiveCommand(cmd *cobra.Command, args []string) {
diff --git a/cli/sketch/sketch.go b/cli/sketch/sketch.go
@@ -26,15 +26,15 @@ var tr = i18n.Tr
 
 // NewCommand created a new `sketch` command
 func NewCommand() *cobra.Command {
-	cmd := &cobra.Command{
+	sketchCommand := &cobra.Command{
 		Use:     "sketch",
 		Short:   tr("Arduino CLI sketch commands."),
 		Long:    tr("Arduino CLI sketch commands."),
 		Example: "  " + os.Args[0] + " sketch new MySketch",
 	}
 
-	cmd.AddCommand(initNewCommand())
-	cmd.AddCommand(initArchiveCommand())
+	sketchCommand.AddCommand(initNewCommand())
+	sketchCommand.AddCommand(initArchiveCommand())
 
-	return cmd
+	return sketchCommand
 }
diff --git a/cli/version/version.go b/cli/version/version.go
@@ -32,17 +32,18 @@ var tr = i18n.Tr
 
 // NewCommand created a new `version` command
 func NewCommand() *cobra.Command {
-	return &cobra.Command{
+	versionCommand := &cobra.Command{
 		Use:     "version",
 		Short:   tr("Shows version number of Arduino CLI."),
 		Long:    tr("Shows the version number of Arduino CLI which is installed on your system."),
 		Example: "  " + os.Args[0] + " version",
 		Args:    cobra.NoArgs,
-		Run:     run,
+		Run:     runVersionCommand,
 	}
+	return versionCommand
 }
 
-func run(cmd *cobra.Command, args []string) {
+func runVersionCommand(cmd *cobra.Command, args []string) {
 	if strings.Contains(globals.VersionInfo.VersionString, "git-snapshot") || strings.Contains(globals.VersionInfo.VersionString, "nightly") {
 		// We're using a development version, no need to check if there's a
 		// new release available

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func NewCommand() *cobra.Command {`
`47`	`47`	`Long: tr("Upload the bootloader on the board using an external programmer."),`
`48`	`48`	`Example: " " + os.Args[0] + " burn-bootloader -b arduino:avr:uno -P atmel_ice",`
`49`	`49`	`Args: cobra.MaximumNArgs(1),`
`50`		`- Run: run,`
	`50`	`+ Run: runBootloaderCommand,`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`fqbn.AddToCommand(burnBootloaderCommand)`
`@@ -61,7 +61,7 @@ func NewCommand() *cobra.Command {`
`61`	`61`	`return burnBootloaderCommand`
`62`	`62`	`}`
`63`	`63`
`64`		`-func run(command *cobra.Command, args []string) {`
	`64`	`+func runBootloaderCommand(command *cobra.Command, args []string) {`
`65`	`65`	`instance := instance.CreateAndInit()`
`66`	`66`
`67`	`67`	`// We don't need a Sketch to upload a board's bootloader`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func NewCommand() *cobra.Command {`
`76`	`76`	" " + os.Args[0] + ` compile -b arduino:avr:uno --build-property "build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n" +
`77`	`77`	" " + os.Args[0] + ` compile -b arduino:avr:uno --build-property build.extra_flags=-DPIN=2 --build-property "compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n",
`78`	`78`	`Args: cobra.MaximumNArgs(1),`
`79`		`- Run: run,`
	`79`	`+ Run: runCompileCommand,`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`fqbn.AddToCommand(compileCommand)`
`@@ -120,7 +120,7 @@ func NewCommand() *cobra.Command {`
`120`	`120`	`return compileCommand`
`121`	`121`	`}`
`122`	`122`
`123`		`-func run(cmd *cobra.Command, args []string) {`
	`123`	`+func runCompileCommand(cmd *cobra.Command, args []string) {`
`124`	`124`	`inst := instance.CreateAndInit()`
`125`	`125`
`126`	`126`	`path := ""`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ import (`
`27`	`27`	`)`
`28`	`28`
`29`	`29`	`func initDeleteCommand() *cobra.Command {`
`30`		`- addCommand := &cobra.Command{`
	`30`	`+ deleteCommand := &cobra.Command{`
`31`	`31`	`Use: "delete",`
`32`	`32`	`Short: tr("Deletes a settings key and all its sub keys."),`
`33`	`33`	`Long: tr("Deletes a settings key and all its sub keys."),`
`@@ -40,7 +40,7 @@ func initDeleteCommand() *cobra.Command {`
`40`	`40`	`return configuration.Settings.AllKeys(), cobra.ShellCompDirectiveDefault`
`41`	`41`	`},`
`42`	`42`	`}`
`43`		`- return addCommand`
	`43`	`+ return deleteCommand`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`func runDeleteCommand(cmd *cobra.Command, args []string) {`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`func initRemoveCommand() *cobra.Command {`
`29`		`- addCommand := &cobra.Command{`
	`29`	`+ removeCommand := &cobra.Command{`
`30`	`30`	`Use: "remove",`
`31`	`31`	`Short: tr("Removes one or more values from a setting."),`
`32`	`32`	`Long: tr("Removes one or more values from a setting."),`
`@@ -39,7 +39,7 @@ func initRemoveCommand() *cobra.Command {`
`39`	`39`	`return GetConfigurationKeys(), cobra.ShellCompDirectiveDefault`
`40`	`40`	`},`
`41`	`41`	`}`
`42`		`- return addCommand`
	`42`	`+ return removeCommand`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`func runRemoveCommand(cmd *cobra.Command, args []string) {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ import (`
`32`	`32`	`)`
`33`	`33`
`34`	`34`	`func initUninstallCommand() *cobra.Command {`
`35`		`- return &cobra.Command{`
	`35`	`+ uninstallCommand := &cobra.Command{`
`36`	`36`	`Use: fmt.Sprintf("uninstall %s:%s ...", tr("PACKAGER"), tr("ARCH")),`
`37`	`37`	`Short: tr("Uninstalls one or more cores and corresponding tool dependencies if no longer used."),`
`38`	`38`	`Long: tr("Uninstalls one or more cores and corresponding tool dependencies if no longer used."),`
`@@ -43,6 +43,7 @@ func initUninstallCommand() *cobra.Command {`
`43`	`43`	`return arguments.GetUninstallableCores(), cobra.ShellCompDirectiveDefault`
`44`	`44`	`},`
`45`	`45`	`}`
	`46`	`+ return uninstallCommand`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`func runUninstallCommand(cmd *cobra.Command, args []string) {`