Add fuzzy search to board listall and more information in its json output (#1205)

* Add board's platform to board listall json output

* Add fuzzy search to board listall command

Author: silvanocerza

commands/board/listall.go

@@ -22,47 +22,86 @@ import (
 
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	"github.com/lithammer/fuzzysearch/fuzzy"
 )
 
+// maximumSearchDistance is the maximum Levenshtein distance accepted when using fuzzy search.
+// This value is completely arbitrary and picked randomly.
+const maximumSearchDistance = 20
+
 // ListAll FIXMEDOC
 func ListAll(ctx context.Context, req *rpc.BoardListAllReq) (*rpc.BoardListAllResp, error) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
 		return nil, errors.New("invalid instance")
 	}
 
-	args := req.GetSearchArgs()
-	match := func(name string) bool {
-		if len(args) == 0 {
+	searchArgs := strings.Join(req.SearchArgs, " ")
+
+	match := func(toTest []string) bool {
+		if len(searchArgs) == 0 {
 			return true
 		}
-		name = strings.ToLower(name)
-		for _, term := range args {
-			if !strings.Contains(name, strings.ToLower(term)) {
-				return false
+		for _, rank := range fuzzy.RankFindNormalizedFold(searchArgs, toTest) {
+			if rank.Distance < maximumSearchDistance {
+				return true
 			}
 		}
-		return true
+		return false
 	}
 
 	list := &rpc.BoardListAllResp{Boards: []*rpc.BoardListItem{}}
 	for _, targetPackage := range pm.Packages {
 		for _, platform := range targetPackage.Platforms {
-			platformRelease := pm.GetInstalledPlatformRelease(platform)
-			if platformRelease == nil {
+			installedPlatformRelease := pm.GetInstalledPlatformRelease(platform)
+			// We only want to list boards for installed platforms
+			if installedPlatformRelease == nil {
 				continue
 			}
-			for _, board := range platformRelease.Boards {
-				if !match(board.Name()) {
+
+			installedVersion := installedPlatformRelease.Version.String()
+
+			latestVersion := ""
+			if latestPlatformRelease := platform.GetLatestRelease(); latestPlatformRelease != nil {
+				latestVersion = latestPlatformRelease.Version.String()
+			}
+
+			rpcPlatform := &rpc.Platform{
+				ID:                platform.String(),
+				Installed:         installedVersion,
+				Latest:            latestVersion,
+				Name:              platform.Name,
+				Maintainer:        platform.Package.Maintainer,
+				Website:           platform.Package.WebsiteURL,
+				Email:             platform.Package.Email,
+				ManuallyInstalled: platform.ManuallyInstalled,
+			}
+
+			toTest := []string{
+				platform.String(),
+				platform.Name,
+				platform.Architecture,
+				targetPackage.Name,
+				targetPackage.Maintainer,
+			}
+
+			for _, board := range installedPlatformRelease.Boards {
+				if !req.GetIncludeHiddenBoards() && board.IsHidden() {
 					continue
 				}
-				if !req.GetIncludeHiddenBoards() && board.IsHidden() {
+
+				toTest := toTest
+				toTest = append(toTest, strings.Split(board.Name(), " ")...)
+				toTest = append(toTest, board.FQBN())
+				if !match(toTest) {
 					continue
 				}
+
 				list.Boards = append(list.Boards, &rpc.BoardListItem{
 					Name:     board.Name(),
 					FQBN:     board.FQBN(),
 					IsHidden: board.IsHidden(),
+					Platform: rpcPlatform,
 				})
 			}
 		}

rpc/commands/board.pb.go

@@ -235,4 +235,6 @@ message BoardListItem {
     string VID = 4;
     // Product ID
     string PID = 5;
+    // Platform this board belongs to
+    Platform platform = 6;
 }