Change board list watcher ouptut formatting

Author: silvanocerza

cli/board/list.go

@@ -63,7 +63,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
 			feedback.Errorf("Error detecting boards: %v", err)
 			os.Exit(errorcodes.ErrGeneric)
 		}
-		watchList(inst)
+		watchList(cmd, inst)
 		os.Exit(0)
 	}
 
@@ -89,45 +89,46 @@ func runListCommand(cmd *cobra.Command, args []string) {
 	feedback.PrintResult(result{ports})
 }
 
-func watchList(inst *rpc.Instance) {
+func watchList(cmd *cobra.Command, inst *rpc.Instance) {
 	pm := commands.GetPackageManager(inst.Id)
 	eventsChan, err := commands.WatchListBoards(pm)
 	if err != nil {
 		feedback.Errorf("Error detecting boards: %v", err)
 		os.Exit(errorcodes.ErrNetwork)
 	}
 
-	boardPorts := map[string]*commands.BoardPort{}
+	// This is done to avoid printing the header each time a new event is received
+	if feedback.GetFormat() == feedback.Text {
+		t := table.New()
+		t.SetHeader("Port", "Type", "Event", "Board Name", "FQBN", "Core")
+		t.SetColumnWidthMode()
+		feedback.Print(t.Render())
+	}
+
 	for event := range eventsChan {
-		switch event.Type {
-		case "add":
-			boardPorts[event.Port.Address] = &commands.BoardPort{
+		boards := []*rpc.BoardListItem{}
+		if event.Type == "add" {
+			boards, err = board.Identify(pm, &commands.BoardPort{
 				Address:             event.Port.Address,
 				Label:               event.Port.AddressLabel,
 				Prefs:               event.Port.Properties,
 				IdentificationPrefs: event.Port.IdentificationProperties,
 				Protocol:            event.Port.Protocol,
 				ProtocolLabel:       event.Port.ProtocolLabel,
-			}
-		case "remove":
-			delete(boardPorts, event.Port.Address)
-		}
-
-		ports := []*rpc.DetectedPort{}
-		for _, p := range boardPorts {
-			boardList, err := board.Identify(pm, p)
+			})
 			if err != nil {
 				feedback.Errorf("Error identifying board: %v", err)
 				os.Exit(errorcodes.ErrNetwork)
 			}
-			ports = append(ports, &rpc.DetectedPort{
-				Address:       p.Address,
-				Protocol:      p.Protocol,
-				ProtocolLabel: p.ProtocolLabel,
-				Boards:        boardList,
-			})
 		}
-		feedback.PrintResult(result{ports})
+
+		feedback.PrintResult(watchEvent{
+			Type:          event.Type,
+			Address:       event.Port.Address,
+			Protocol:      event.Port.Protocol,
+			ProtocolLabel: event.Port.ProtocolLabel,
+			Boards:        boards,
+		})
 	}
 }
 
@@ -191,3 +192,59 @@ func (dr result) String() string {
 	}
 	return t.Render()
 }
+
+type watchEvent struct {
+	Type          string               `json:"type"`
+	Address       string               `json:"address,omitempty"`
+	Protocol      string               `json:"protocol,omitempty"`
+	ProtocolLabel string               `json:"protocol_label,omitempty"`
+	Boards        []*rpc.BoardListItem `json:"boards,omitempty"`
+}
+
+func (dr watchEvent) Data() interface{} {
+	return dr
+}
+
+func (dr watchEvent) String() string {
+	t := table.New()
+
+	event := map[string]string{
+		"add":    "Connected",
+		"remove": "Disconnected",
+	}[dr.Type]
+
+	address := fmt.Sprintf("%s://%s", dr.Protocol, dr.Address)
+	if dr.Protocol == "serial" || dr.Protocol == "" {
+		address = dr.Address
+	}
+	protocol := dr.ProtocolLabel
+	if boards := dr.Boards; len(boards) > 0 {
+		sort.Slice(boards, func(i, j int) bool {
+			x, y := boards[i], boards[j]
+			return x.GetName() < y.GetName() || (x.GetName() == y.GetName() && x.GetFQBN() < y.GetFQBN())
+		})
+		for _, b := range boards {
+			board := b.GetName()
+
+			// to improve the user experience, show on a dedicated column
+			// the name of the core supporting the board detected
+			var coreName = ""
+			fqbn, err := cores.ParseFQBN(b.GetFQBN())
+			if err == nil {
+				coreName = fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch)
+			}
+
+			t.AddRow(address, protocol, event, board, fqbn, coreName)
+
+			// reset address and protocol, we only show them on the first row
+			address = ""
+			protocol = ""
+		}
+	} else {
+		board := ""
+		fqbn := ""
+		coreName := ""
+		t.AddRow(address, protocol, event, board, fqbn, coreName)
+	}
+	return t.Render()
+}

cli/feedback/exported.go

@@ -34,6 +34,11 @@ func SetFormat(f OutputFormat) {
 	fb.SetFormat(f)
 }
 
+// GetFormat returns the currently set output format
+func GetFormat() OutputFormat {
+	return fb.GetFormat()
+}
+
 // OutputWriter returns the underlying io.Writer to be used when the Print*
 // api is not enough
 func OutputWriter() io.Writer {

cli/feedback/feedback.go

@@ -68,6 +68,11 @@ func (fb *Feedback) SetFormat(f OutputFormat) {
 	fb.format = f
 }
 
+// GetFormat returns the output format currently set
+func (fb *Feedback) GetFormat() OutputFormat {
+	return fb.format
+}
+
 // OutputWriter returns the underlying io.Writer to be used when the Print*
 // api is not enough.
 func (fb *Feedback) OutputWriter() io.Writer {