From 771583d4896511036b3d17812e77d9ada37a7bf3 Mon Sep 17 00:00:00 2001
From: Martino Facchin <m.facchin@arduino.cc>
Date: Mon, 26 Jul 2021 16:58:15 +0200
Subject: [PATCH] Implement suggestions on fqbn
---
.../cores/packagemanager/package_manager.go | 21 ++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/arduino/cores/packagemanager/package_manager.go b/arduino/cores/packagemanager/package_manager.go
index cdbe2110c67..8ad1be034de 100644
--- a/arduino/cores/packagemanager/package_manager.go
+++ b/arduino/cores/packagemanager/package_manager.go
@@ -26,6 +26,7 @@ import (
"github.com/arduino/arduino-cli/arduino/cores/packageindex"
paths "github.com/arduino/go-paths-helper"
properties "github.com/arduino/go-properties-orderedmap"
+ "github.com/schollz/closestmatch"
"github.com/sirupsen/logrus"
semver "go.bug.st/relaxed-semver"
)
@@ -129,6 +130,22 @@ func (pm *PackageManager) FindBoardWithFQBN(fqbnIn string) (*cores.Board, error)
return board, err
}
+func (pm *PackageManager) findClosestMatchFqbn(fqbn *cores.FQBN) string {
+ // Create closestmatch DB
+ wordsToTest := []string{}
+ name := fqbn.StringWithoutConfig()
+ for _, board := range pm.InstalledBoards() {
+ wordsToTest = append(wordsToTest, board.FQBN())
+ }
+ // Choose a set of bag sizes, more is more accurate but slower
+ bagSizes := []int{2}
+
+ // Create a closestmatch object and find the best matching name
+ cm := closestmatch.New(wordsToTest, bagSizes)
+ closestName := cm.Closest(name)
+ return closestName
+}
+
// ResolveFQBN returns, in order:
//
// - the Package pointed by the fqbn
@@ -174,8 +191,10 @@ func (pm *PackageManager) ResolveFQBN(fqbn *cores.FQBN) (
// Find board
board := platformRelease.Boards[fqbn.BoardID]
if board == nil {
+ // Try looking for the closest match; if found, suggest it
+ suggestion := pm.findClosestMatchFqbn(fqbn)
return targetPackage, platformRelease, nil, nil, nil,
- fmt.Errorf("board %s:%s not found", platformRelease, fqbn.BoardID)
+ fmt.Errorf("board %s not found, did you mean %s ?", fqbn.StringWithoutConfig(), suggestion)
}
buildProperties, err := board.GetBuildProperties(fqbn.Configs)