removing Verbose flag and adding --names flag to lib command

Author: saniales

cmd/arduino.go

@@ -167,14 +167,16 @@ func InitFlags() {
 	arduinoSketchSyncCmd.ResetFlags()
 	arduinoLoginCmd.ResetFlags()
 
-	ArduinoCmd.PersistentFlags().CountVarP(&GlobalFlags.Verbose, "verbose", "v", "enables verbose output (use more times for a higher level)")
+	ArduinoCmd.PersistentFlags().BoolVar(&GlobalFlags.Debug, "debug", false, "enables debug output")
 	ArduinoCmd.PersistentFlags().StringVar(&GlobalFlags.Format, "format", "invalid", "the output format, can be [text|json]")
 
 	ArduinoCmd.PersistentFlags().StringVar(&configs.FileLocation, "config-file", configs.FileLocation, "the custom config file (if not specified ./.cli-config.yml will be used)")
 
 	ArduinoCmd.Flags().BoolVar(&rootCmdFlags.GenerateDocs, "generate-docs", false, "generates the docs for the CLI and puts it in docs folder")
 
-	arduinoLibCmd.Flags().Bool("update-index", false, "Updates the libraries index")
+	arduinoLibCmd.Flags().BoolVar(&arduinoLibFlags.updateIndex, "update-index", false, "Updates the libraries index")
+
+	arduinoLibSearchCmd.Flags().BoolVar(&arduinoLibSearchFlags.Names, "names", false, "Show library names only")
 
 	arduinoCoreCmd.Flags().BoolVar(&arduinoCoreFlags.updateIndex, "update-index", false, "Updates the index of cores to the latest version")
 
@@ -294,21 +296,6 @@ func versionsToPrint(cmd *cobra.Command, isRoot bool) []string {
 		verToPrint = append(verToPrint, cmd.Parent().Name())
 	}
 
-	if GlobalFlags.Verbose > 0 {
-		siblings := findSiblings(cmd)
-		//search version command in siblings children.
-		for _, sibling := range siblings {
-			for _, sibChild := range sibling.Commands() {
-				//fmt.Println(sibling.Name(), " >", sibChild.Name())
-				if sibChild.Name() == "version" {
-					verToPrint = append(verToPrint, sibling.Name())
-				} else {
-					verToPrint = append(verToPrint, versionsToPrint(sibChild, false)...)
-				}
-			}
-		}
-	}
-
 	return verToPrint
 }
 

cmd/arduino_core.go

@@ -99,7 +99,7 @@ func init() {
 
 func executeCoreCommand(cmd *cobra.Command, args []string) {
 	if arduinoCoreFlags.updateIndex {
-		common.ExecUpdateIndex(prettyPrints.DownloadCoreFileIndex(), GlobalFlags.Verbose)
+		common.ExecUpdateIndex(prettyPrints.DownloadCoreFileIndex())
 	} else {
 		cmd.Help()
 		os.Exit(errBadCall)
@@ -154,7 +154,7 @@ func executeCoreDownloadCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errBadCall)
 	}
 
-	status, err := getPackagesStatusContext(GlobalFlags.Verbose)
+	status, err := getPackagesStatusContext()
 	if err != nil {
 		os.Exit(errGeneric)
 	}
@@ -171,12 +171,12 @@ func executeCoreDownloadCommand(cmd *cobra.Command, args []string) {
 		downloads[i] = toolsToDownload[i].DownloadItem
 	}
 
-	releases.ParallelDownload(downloads, true, "Downloaded", GlobalFlags.Verbose, &outputResults.Tools, "tool")
+	releases.ParallelDownload(downloads, true, "Downloaded", &outputResults.Tools, "tool")
 	downloads = make([]releases.DownloadItem, len(coresToDownload))
 	for i := range coresToDownload {
 		downloads[i] = coresToDownload[i].DownloadItem
 	}
-	releases.ParallelDownload(downloads, true, "Downloaded", GlobalFlags.Verbose, &outputResults.Cores, "core")
+	releases.ParallelDownload(downloads, true, "Downloaded", &outputResults.Cores, "core")
 
 	formatter.Print(outputResults)
 }
@@ -187,7 +187,7 @@ func executeCoreInstallCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errBadCall)
 	}
 
-	status, err := getPackagesStatusContext(GlobalFlags.Verbose)
+	status, err := getPackagesStatusContext()
 	if err != nil {
 		formatter.PrintError(err)
 		os.Exit(errCoreConfig)
@@ -204,13 +204,13 @@ func executeCoreInstallCommand(cmd *cobra.Command, args []string) {
 	for i := range toolsToDownload {
 		downloads[i] = toolsToDownload[i].DownloadItem
 	}
-	releases.ParallelDownload(downloads, false, "Installed", GlobalFlags.Verbose, &outputResults.Tools, "tool")
+	releases.ParallelDownload(downloads, false, "Installed", &outputResults.Tools, "tool")
 
 	downloads = make([]releases.DownloadItem, len(coresToDownload))
 	for i := range coresToDownload {
 		downloads[i] = coresToDownload[i].DownloadItem
 	}
-	releases.ParallelDownload(downloads, false, "Installed", GlobalFlags.Verbose, &outputResults.Cores, "core")
+	releases.ParallelDownload(downloads, false, "Installed", &outputResults.Cores, "core")
 
 	for i, item := range toolsToDownload {
 		err = cores.InstallTool(item.Package, item.Name, item.Release)
@@ -296,11 +296,11 @@ func getInstalledStuff(packageName string, stuff *[]output.InstalledStuff, start
 	}
 }
 
-func getPackagesStatusContext(verbosity int) (*cores.StatusContext, error) {
+func getPackagesStatusContext() (*cores.StatusContext, error) {
 	var index cores.Index
 	err := cores.LoadIndex(&index)
 	if err != nil {
-		status, err := prettyPrints.CorruptedCoreIndexFix(index, verbosity)
+		status, err := prettyPrints.CorruptedCoreIndexFix(index)
 		if err != nil {
 			return nil, err
 		}

cmd/arduino_lib.go

@@ -128,7 +128,7 @@ func init() {
 
 func executeLibCommand(cmd *cobra.Command, args []string) {
 	if arduinoLibFlags.updateIndex {
-		common.ExecUpdateIndex(prettyPrints.DownloadLibFileIndex(), GlobalFlags.Verbose)
+		common.ExecUpdateIndex(prettyPrints.DownloadLibFileIndex())
 	} else {
 		cmd.Help()
 		os.Exit(errBadCall)
@@ -141,7 +141,7 @@ func executeDownloadCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errBadCall)
 	}
 
-	status, err := getLibStatusContext(GlobalFlags.Verbose)
+	status, err := getLibStatusContext()
 	if err != nil {
 		os.Exit(errGeneric)
 	}
@@ -157,7 +157,7 @@ func executeDownloadCommand(cmd *cobra.Command, args []string) {
 		libs[i] = releases.DownloadItem(libsToDownload[i])
 	}
 
-	releases.ParallelDownload(libs, false, "Downloaded", GlobalFlags.Verbose, &outputResults.Libraries, "library")
+	releases.ParallelDownload(libs, false, "Downloaded", &outputResults.Libraries, "library")
 
 	formatter.Print(outputResults)
 }
@@ -168,7 +168,7 @@ func executeInstallCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errBadCall)
 	}
 
-	status, err := getLibStatusContext(GlobalFlags.Verbose)
+	status, err := getLibStatusContext()
 	if err != nil {
 		os.Exit(errGeneric)
 	}
@@ -184,7 +184,7 @@ func executeInstallCommand(cmd *cobra.Command, args []string) {
 		libs[i] = releases.DownloadItem(libsToDownload[i])
 	}
 
-	releases.ParallelDownload(libs, false, "Installed", GlobalFlags.Verbose, &outputResults.Libraries, "library")
+	releases.ParallelDownload(libs, false, "Installed", &outputResults.Libraries, "library")
 
 	folder, err := common.GetDefaultLibFolder()
 	if err != nil {
@@ -323,7 +323,7 @@ func executeUninstallCommand(cmd *cobra.Command, args []string) {
 func executeSearchCommand(cmd *cobra.Command, args []string) {
 	query := strings.ToLower(strings.Join(args, " "))
 
-	status, err := getLibStatusContext(GlobalFlags.Verbose)
+	status, err := getLibStatusContext()
 	if err != nil {
 		os.Exit(errCoreConfig)
 	}
@@ -340,17 +340,13 @@ func executeSearchCommand(cmd *cobra.Command, args []string) {
 	for _, name := range names {
 		if strings.Contains(strings.ToLower(name), query) {
 			found = true
-			item := items[name]
-			if GlobalFlags.Verbose > 0 {
-				message.Libraries = append(message.Libraries, item)
-				if GlobalFlags.Verbose < 2 {
-					item.Releases = nil
-				}
-			} else {
+			if arduinoLibSearchFlags.Names {
 				if formatter.IsCurrentFormat("text") {
 					name = fmt.Sprintf("\"%s\"", name)
 				}
 				message.Libraries = append(message.Libraries, name)
+			} else {
+				message.Libraries = append(message.Libraries, items[name])
 			}
 		}
 	}
@@ -449,11 +445,11 @@ func resultFromFileName(file os.FileInfo, libs *output.LibProcessResults) {
 	})
 }
 
-func getLibStatusContext(verbosity int) (*libraries.StatusContext, error) {
+func getLibStatusContext() (*libraries.StatusContext, error) {
 	var index libraries.Index
 	err := libraries.LoadIndex(&index)
 	if err != nil {
-		status, err := prettyPrints.CorruptedLibIndexFix(index, verbosity)
+		status, err := prettyPrints.CorruptedLibIndexFix(index)
 		if err != nil {
 			return nil, err
 		}

cmd/arduino_sketch.go

@@ -135,13 +135,9 @@ func executeSketchSyncCommand(cmd *cobra.Command, args []string) {
 
 	username, bearerToken, err := login()
 	if err != nil {
-		if GlobalFlags.Verbose == 0 {
-			formatter.PrintErrorMessage("Cannot login automatically: try arduino login the run again this command")
-		} else {
-			stopSpinner()
-			formatter.PrintError(err)
-			os.Exit(errNetwork)
-		}
+		stopSpinner()
+		formatter.PrintError(err)
+		os.Exit(errNetwork)
 	}
 
 	sketchMap := sketches.Find(sketchbook, "libraries") //exclude libraries folder
@@ -266,14 +262,7 @@ func executeSketchSyncCommand(cmd *cobra.Command, args []string) {
 	}
 
 	stopSpinner()
-
-	// for text mode, show full info (aka String()) only if verbose > 0.
-	// for other formats always print full info.
-	if GlobalFlags.Verbose > 0 || !formatter.IsCurrentFormat("text") {
-		formatter.Print(result)
-	} else {
-		formatter.PrintResult("Sync Completed")
-	}
+	formatter.Print(result)
 }
 
 func pushSketch(sketch sketches.Sketch, sketchbook string, bearerToken string) error {
@@ -454,10 +443,10 @@ func login() (string, string, error) {
 	content, err := NetRC.MarshalText()
 	if err == nil { //serialize new info
 		err := ioutil.WriteFile(netRCFile, content, 0666)
-		if err != nil && GlobalFlags.Verbose > 0 {
+		if err != nil {
 			formatter.Print(err.Error())
 		}
-	} else if GlobalFlags.Verbose > 0 {
+	} else {
 		formatter.Print(err.Error())
 	}
 	return arduinoMachine.Login, token, nil

cmd/cmd_test.go

@@ -92,7 +92,7 @@ func TestLibSearch(t *testing.T) {
 	//executeWithArgs(t, "lib", "search", "you") //test not working on drone, but working locally
 	// arduino lib search youtu --format json
 	// arduino lib search youtu --format=json
-	executeWithArgs(t, "lib", "search", "youtu", "--format", "json")
+	executeWithArgs(t, "lib", "search", "youtu", "--format", "json", "--names")
 
 	checkOutput(t, want, tempFile)
 }

cmd/flags.go

@@ -34,7 +34,7 @@ import "regexp"
 
 // GlobalFlags represents flags available in all the program.
 var GlobalFlags struct {
-	Verbose         int    // More time verbose flag is written, the more the Verbose count increases. Represents verbosity level.
+	Debug           bool   // If true, dump debug output to stderr.
 	Format          string // The Output format (e.g. text, json).
 	configs.Configs        // The Configurations for the CLI.
 }
@@ -49,6 +49,10 @@ var arduinoLibFlags struct {
 	updateIndex bool // if true, updates libraries index.
 }
 
+var arduinoLibSearchFlags struct {
+	Names bool // if true outputs lib names only.
+}
+
 // arduinoCoreFlags represents `arduino core` flags.
 var arduinoCoreFlags struct {
 	updateIndex bool // If true, update packages index.

cmd/pretty_print/common.go

@@ -62,16 +62,9 @@ func actionOnItems(itemPluralName string, actionPastParticiple string, itemOK []
 // uses DownloadFunc to download the file.
 func DownloadFileIndex(downloadFunc func() error) task.Wrapper {
 	return task.Wrapper{
-		BeforeMessage: []string{
-			"",
-			"Downloading from download.arduino.cc",
-		},
-		AfterMessage: []string{
-			"Index File downloaded",
-		},
-		ErrorMessage: []string{
-			"Can't download index file, check your network connection.",
-		},
+		BeforeMessage: "Downloading from download.arduino.cc",
+		AfterMessage:  "Index File downloaded",
+		ErrorMessage:  "Can't download index file, check your network connection.",
 		Task: task.Task(func() task.Result {
 			return task.Result{
 				Result: nil,
@@ -82,34 +75,27 @@ func DownloadFileIndex(downloadFunc func() error) task.Wrapper {
 }
 
 //corruptedIndexFixResults executes a generic index fix procedure, made by a download and parse task.
-func corruptedIndexFixResults(downloadTask, parseTask task.Wrapper, verbosity int) []task.Result {
+func corruptedIndexFixResults(downloadTask, parseTask task.Wrapper) []task.Result {
 	subTasks := []task.Wrapper{downloadTask, parseTask}
 	wrapper := indexFixWrapperSkeleton()
-	wrapper.Task = task.CreateSequence(subTasks, []bool{false, false}, verbosity).Task()
-	return wrapper.Execute(verbosity).Result.([]task.Result)
+	wrapper.Task = task.CreateSequence(subTasks, []bool{false, false}).Task()
+	return wrapper.Execute().Result.([]task.Result)
 }
 
 // indexParseWrapperSkeleton provides an empty skeleton for a task wrapper regarding index (core index, lib index) error fixing tasks,
 // which will be assigned later.
 func indexFixWrapperSkeleton() task.Wrapper {
 	return task.Wrapper{
-		BeforeMessage: []string{
-			"Cannot parse index file, it may be corrupted.",
-		},
+		BeforeMessage: "Cannot parse index file, it may be corrupted.",
 	}
 }
 
 // indexParseWrapperSkeleton provides an empty skeleton for a task wrapper regarding index (core index, lib index) parsing tasks,
 // which will be assigned later.
 func indexParseWrapperSkeleton() task.Wrapper {
 	return task.Wrapper{
-		BeforeMessage: []string{
-			"",
-			"Parsing downloaded index file",
-		},
-		ErrorMessage: []string{
-			"Cannot parse index file",
-		},
-		Task: nil,
+		BeforeMessage: "Parsing downloaded index file",
+		ErrorMessage:  "Cannot parse index file",
+		Task:          nil,
 	}
 }

cmd/pretty_print/pretty_print_core.go

@@ -40,17 +40,17 @@ func DownloadCoreFileIndex() task.Wrapper {
 }
 
 // CorruptedCoreIndexFix pretty prints messages regarding corrupted index fixes of cores.
-func CorruptedCoreIndexFix(index cores.Index, verbosity int) (cores.StatusContext, error) {
+func CorruptedCoreIndexFix(index cores.Index) (cores.StatusContext, error) {
 	downloadTask := DownloadCoreFileIndex()
-	parseTask := coreIndexParse(index, verbosity)
+	parseTask := coreIndexParse(index)
 
-	result := corruptedIndexFixResults(downloadTask, parseTask, verbosity)
+	result := corruptedIndexFixResults(downloadTask, parseTask)
 
 	return result[1].Result.(cores.StatusContext), result[1].Error
 }
 
 // coreIndexParse pretty prints info about parsing an index file of libraries.
-func coreIndexParse(index cores.Index, verbosity int) task.Wrapper {
+func coreIndexParse(index cores.Index) task.Wrapper {
 	ret := indexParseWrapperSkeleton()
 	ret.Task = task.Task(func() task.Result {
 		err := cores.LoadIndex(&index) // I try again

cmd/pretty_print/pretty_print_lib.go

@@ -40,18 +40,18 @@ func DownloadLibFileIndex() task.Wrapper {
 }
 
 // CorruptedLibIndexFix pretty prints messages regarding corrupted index fixes of libraries.
-func CorruptedLibIndexFix(index libraries.Index, verbosity int) (libraries.StatusContext, error) {
+func CorruptedLibIndexFix(index libraries.Index) (libraries.StatusContext, error) {
 	downloadTask := DownloadLibFileIndex()
-	parseTask := libIndexParse(index, verbosity)
+	parseTask := libIndexParse(index)
 
-	result := corruptedIndexFixResults(downloadTask, parseTask, verbosity)
+	result := corruptedIndexFixResults(downloadTask, parseTask)
 	ret, _ := result[1].Result.(libraries.StatusContext)
 	err := result[1].Error
 	return ret, err
 }
 
 // libIndexParse pretty prints info about parsing an index file of libraries.
-func libIndexParse(index libraries.Index, verbosity int) task.Wrapper {
+func libIndexParse(index libraries.Index) task.Wrapper {
 	ret := indexParseWrapperSkeleton()
 	ret.Task = func() task.Result {
 		err := libraries.LoadIndex(&index)

common/paths.go

@@ -140,8 +140,8 @@ func GetDownloadCacheFolder(item string) (string, error) {
 }
 
 // ExecUpdateIndex is a generic procedure to update an index file.
-func ExecUpdateIndex(updateTask task.Wrapper, verbosity int) {
-	updateTask.Execute(verbosity)
+func ExecUpdateIndex(updateTask task.Wrapper) {
+	updateTask.Execute()
 }
 
 // IndexPath returns the path of the specified index file.