Expose golang fqbn package for public use

Taskfile.yml

@@ -309,24 +309,24 @@ tasks:
   i18n:update:
     desc: Updates i18n files
     cmds:
-      - go run ./internal/i18n/cmd/main.go catalog generate . > ./internal/i18n/data/en.po
+      - go run ./internal/locales/cmd/main.go catalog generate . > ./internal/locales/data/en.po
 
   i18n:pull:
     desc: Pull i18n files from transifex
     cmds:
-      - go run ./internal/i18n/cmd/main.go transifex pull ./internal/i18n/data
+      - go run ./internal/locales/cmd/main.go transifex pull ./internal/locales/data
 
   i18n:push:
     desc: Push i18n files to transifex
     cmds:
-      - go run ./internal/i18n/cmd/main.go transifex push ./internal/i18n/data
+      - go run ./internal/locales/cmd/main.go transifex push ./internal/locales/data
 
   i18n:check:
     desc: Check if the i18n message catalog was updated
     cmds:
       - task: i18n:pull
-      - git add -N ./internal/i18n/data
-      - git diff --exit-code ./internal/i18n/data
+      - git add -N ./internal/locales/data
+      - git diff --exit-code ./internal/locales/data
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
   website:check:

commands/instances.go

@@ -38,6 +38,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/internal/locales"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
@@ -420,7 +421,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 	// language of the CLI if the locale is different
 	// after started.
 	if locale, ok, _ := s.settings.GetStringOk("locale"); ok {
-		i18n.Init(locale)
+		locales.Init(locale)
 	}
 
 	return nil

commands/service_board_details.go

@@ -20,8 +20,8 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
@@ -34,7 +34,7 @@ func (s *arduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
 	}
 	defer release()
 
-	fqbn, err := cores.ParseFQBN(req.GetFqbn())
+	fqbn, err := fqbn.Parse(req.GetFqbn())
 	if err != nil {
 		return nil, &cmderrors.InvalidFQBNError{Cause: err}
 	}
@@ -48,7 +48,7 @@ func (s *arduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
 	details.Name = board.Name()
 	details.Fqbn = board.FQBN()
 	details.PropertiesId = board.BoardID
-	details.Official = fqbn.Package == "arduino"
+	details.Official = fqbn.Packager == "arduino"
 	details.Version = board.PlatformRelease.Version.String()
 	details.IdentificationProperties = []*rpc.BoardIdentificationProperties{}
 	for _, p := range board.GetIdentificationProperties() {

commands/service_board_list.go

@@ -30,11 +30,11 @@ import (
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/internal/cli/configuration"
 	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/arduino-cli/internal/inventory"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-properties-orderedmap"
 	discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2"
@@ -148,7 +148,7 @@ func identify(pme *packagemanager.Explorer, port *discovery.Port, settings *conf
 	// first query installed cores through the Package Manager
 	logrus.Debug("Querying installed cores for board identification...")
 	for _, board := range pme.IdentifyBoard(port.Properties) {
-		fqbn, err := cores.ParseFQBN(board.FQBN())
+		fqbn, err := fqbn.Parse(board.FQBN())
 		if err != nil {
 			return nil, &cmderrors.InvalidFQBNError{Cause: err}
 		}
@@ -210,10 +210,10 @@ func (s *arduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardLis
 	}
 	defer release()
 
-	var fqbnFilter *cores.FQBN
+	var fqbnFilter *fqbn.FQBN
 	if f := req.GetFqbn(); f != "" {
 		var err error
-		fqbnFilter, err = cores.ParseFQBN(f)
+		fqbnFilter, err = fqbn.Parse(f)
 		if err != nil {
 			return nil, &cmderrors.InvalidFQBNError{Cause: err}
 		}
@@ -247,9 +247,9 @@ func (s *arduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardLis
 	}, nil
 }
 
-func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *cores.FQBN) bool {
+func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *fqbn.FQBN) bool {
 	for _, detectedBoard := range b.GetMatchingBoards() {
-		detectedFqbn, err := cores.ParseFQBN(detectedBoard.GetFqbn())
+		detectedFqbn, err := fqbn.Parse(detectedBoard.GetFqbn())
 		if err != nil {
 			continue
 		}

commands/service_compile.go

@@ -28,13 +28,13 @@ import (
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
 	"github.com/arduino/arduino-cli/internal/arduino/builder"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
 	"github.com/arduino/arduino-cli/internal/buildcache"
 	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/arduino-cli/internal/inventory"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
@@ -116,15 +116,15 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		return &cmderrors.MissingFQBNError{}
 	}
 
-	fqbn, err := cores.ParseFQBN(fqbnIn)
+	fqbn, err := fqbn.Parse(fqbnIn)
 	if err != nil {
 		return &cmderrors.InvalidFQBNError{Cause: err}
 	}
 	_, targetPlatform, targetBoard, boardBuildProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
 	if err != nil {
 		if targetPlatform == nil {
 			return &cmderrors.PlatformNotFoundError{
-				Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
+				Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
 				Cause:    errors.New(i18n.Tr("platform not installed")),
 			}
 		}

commands/service_debug_config.go

@@ -27,10 +27,10 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
@@ -76,7 +76,7 @@ func (s *arduinoCoreServerImpl) IsDebugSupported(ctx context.Context, req *rpc.I
 
 	// Compute the minimum FQBN required to get the same debug configuration.
 	// (i.e. the FQBN cleaned up of the options that do not affect the debugger configuration)
-	minimumFQBN := cores.MustParseFQBN(req.GetFqbn())
+	minimumFQBN := fqbn.MustParse(req.GetFqbn())
 	for _, config := range minimumFQBN.Configs.Keys() {
 		checkFQBN := minimumFQBN.Clone()
 		checkFQBN.Configs.Remove(config)
@@ -127,7 +127,7 @@ func (s *arduinoCoreServerImpl) getDebugProperties(req *rpc.GetDebugConfigReques
 	if fqbnIn == "" {
 		return nil, &cmderrors.MissingFQBNError{}
 	}
-	fqbn, err := cores.ParseFQBN(fqbnIn)
+	fqbn, err := fqbn.Parse(fqbnIn)
 	if err != nil {
 		return nil, &cmderrors.InvalidFQBNError{Cause: err}
 	}

commands/service_library_list.go

@@ -21,12 +21,12 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesresolver"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
@@ -59,7 +59,7 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 	var allLibs []*installedLib
 	if fqbnString := req.GetFqbn(); fqbnString != "" {
 		allLibs = listLibraries(lme, li, req.GetUpdatable(), true)
-		fqbn, err := cores.ParseFQBN(req.GetFqbn())
+		fqbn, err := fqbn.Parse(req.GetFqbn())
 		if err != nil {
 			return nil, &cmderrors.InvalidFQBNError{Cause: err}
 		}
@@ -77,8 +77,8 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 				}
 			}
 			if latest, has := filteredRes[lib.Library.Name]; has {
-				latestPriority := librariesresolver.ComputePriority(latest.Library, "", fqbn.PlatformArch)
-				libPriority := librariesresolver.ComputePriority(lib.Library, "", fqbn.PlatformArch)
+				latestPriority := librariesresolver.ComputePriority(latest.Library, "", fqbn.Architecture)
+				libPriority := librariesresolver.ComputePriority(lib.Library, "", fqbn.Architecture)
 				if latestPriority >= libPriority {
 					// Pick library with the best priority
 					continue
@@ -87,7 +87,7 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 
 			// Check if library is compatible with board specified by FBQN
 			lib.Library.CompatibleWith = map[string]bool{
-				fqbnString: lib.Library.IsCompatibleWith(fqbn.PlatformArch),
+				fqbnString: lib.Library.IsCompatibleWith(fqbn.Architecture),
 			}
 
 			filteredRes[lib.Library.Name] = lib

commands/service_monitor.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	pluggableMonitor "github.com/arduino/arduino-cli/internal/arduino/monitor"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/djherbis/buffer"
@@ -237,7 +238,7 @@ func (s *arduinoCoreServerImpl) Monitor(stream rpc.ArduinoCoreService_MonitorSer
 	return nil
 }
 
-func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, protocol, fqbn string) (*pluggableMonitor.PluggableMonitor, *properties.Map, error) {
+func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, protocol, fqbnIn string) (*pluggableMonitor.PluggableMonitor, *properties.Map, error) {
 	if protocol == "" {
 		return nil, nil, &cmderrors.MissingPortProtocolError{}
 	}
@@ -246,8 +247,8 @@ func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, pro
 	boardSettings := properties.NewMap()
 
 	// If a board is specified search the monitor in the board package first
-	if fqbn != "" {
-		fqbn, err := cores.ParseFQBN(fqbn)
+	if fqbnIn != "" {
+		fqbn, err := fqbn.Parse(fqbnIn)
 		if err != nil {
 			return nil, nil, &cmderrors.InvalidFQBNError{Cause: err}
 		}

commands/service_upload.go

@@ -32,6 +32,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/globals"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
@@ -53,15 +54,15 @@ func (s *arduinoCoreServerImpl) SupportedUserFields(ctx context.Context, req *rp
 	}
 	defer release()
 
-	fqbn, err := cores.ParseFQBN(req.GetFqbn())
+	fqbn, err := fqbn.Parse(req.GetFqbn())
 	if err != nil {
 		return nil, &cmderrors.InvalidFQBNError{Cause: err}
 	}
 
 	_, platformRelease, _, boardProperties, _, err := pme.ResolveFQBN(fqbn)
 	if platformRelease == nil {
 		return nil, &cmderrors.PlatformNotFoundError{
-			Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
+			Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
 			Cause:    err,
 		}
 	} else if err != nil {
@@ -282,7 +283,7 @@ func (s *arduinoCoreServerImpl) runProgramAction(ctx context.Context, pme *packa
 		return nil, &cmderrors.MissingProgrammerError{}
 	}
 
-	fqbn, err := cores.ParseFQBN(fqbnIn)
+	fqbn, err := fqbn.Parse(fqbnIn)
 	if err != nil {
 		return nil, &cmderrors.InvalidFQBNError{Cause: err}
 	}
@@ -292,7 +293,7 @@ func (s *arduinoCoreServerImpl) runProgramAction(ctx context.Context, pme *packa
 	_, boardPlatform, board, boardProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
 	if boardPlatform == nil {
 		return nil, &cmderrors.PlatformNotFoundError{
-			Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
+			Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
 			Cause:    err,
 		}
 	} else if err != nil {

commands/service_upload_list_programmers.go

@@ -21,6 +21,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
@@ -36,7 +37,7 @@ func (s *arduinoCoreServerImpl) ListProgrammersAvailableForUpload(ctx context.Co
 	if fqbnIn == "" {
 		return nil, &cmderrors.MissingFQBNError{}
 	}
-	fqbn, err := cores.ParseFQBN(fqbnIn)
+	fqbn, err := fqbn.Parse(fqbnIn)
 	if err != nil {
 		return nil, &cmderrors.InvalidFQBNError{Cause: err}
 	}

commands/service_upload_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
@@ -60,15 +61,15 @@ func TestDetermineBuildPathAndSketchName(t *testing.T) {
 		importFile    string
 		importDir     string
 		sketch        *sketch.Sketch
-		fqbn          *cores.FQBN
+		fqbn          *fqbn.FQBN
 		resBuildPath  string
 		resSketchName string
 	}
 
 	blonk, err := sketch.New(paths.New("testdata/upload/Blonk"))
 	require.NoError(t, err)
 
-	fqbn, err := cores.ParseFQBN("arduino:samd:mkr1000")
+	fqbn, err := fqbn.Parse("arduino:samd:mkr1000")
 	require.NoError(t, err)
 
 	srv := NewArduinoCoreServer().(*arduinoCoreServerImpl)

docs/CONTRIBUTING.md

@@ -303,7 +303,7 @@ package main
 
 import (
   "fmt"
-  "github.com/arduino/arduino-cli/i18n"
+  "github.com/arduino/arduino-cli/internal/i18n"
 )
 
 func main() {

internal/arduino/builder/build_options_manager.go

@@ -22,9 +22,9 @@ import (
 	"strings"
 
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/utils"
-	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	"github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 )
@@ -51,7 +51,7 @@ func newBuildOptions(
 	builtInLibrariesDirs, buildPath *paths.Path,
 	sketch *sketch.Sketch,
 	customBuildProperties []string,
-	fqbn *cores.FQBN,
+	fqbn *fqbn.FQBN,
 	clean bool,
 	compilerOptimizationFlags string,
 	runtimePlatformPath, buildCorePath *paths.Path,

internal/arduino/builder/builder.go

@@ -35,6 +35,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/i18n"
+	"github.com/arduino/arduino-cli/pkg/fqbn"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
@@ -127,7 +128,7 @@ func NewBuilder(
 	requestBuildProperties []string,
 	hardwareDirs, otherLibrariesDirs paths.PathList,
 	builtInLibrariesDirs *paths.Path,
-	fqbn *cores.FQBN,
+	fqbn *fqbn.FQBN,
 	clean bool,
 	sourceOverrides map[string]string,
 	onlyUpdateCompilationDatabase bool,