Add --library flag to compile command

Author: silvanocerza

arduino/libraries/librariesmanager/librariesmanager.go

@@ -204,6 +204,29 @@ func (sc *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) err
 	return nil
 }
 
+// LoadLibraryFromDir loads one single library from the libRootDir.
+// libRootDir must point to the root of a valid library.
+// An error is returned if the path doesn't exist or loading of the library fails.
+func (lm *LibrariesManager) LoadLibraryFromDir(libRootDir *paths.Path, location libraries.LibraryLocation) error {
+	if libRootDir.NotExist() {
+		return fmt.Errorf("library path does not exist: %s", libRootDir)
+	}
+
+	library, err := libraries.Load(libRootDir, location)
+	if err != nil {
+		return fmt.Errorf("loading library from %s: %s", libRootDir, err)
+	}
+
+	alternatives, ok := lm.Libraries[library.Name]
+	if !ok {
+		alternatives = &LibraryAlternatives{}
+		lm.Libraries[library.Name] = alternatives
+	}
+	alternatives.Add(library)
+
+	return nil
+}
+
 // FindByReference return the installed library matching the Reference
 // name and version or, if the version is nil, the library installed
 // in the User folder.

cli/compile/compile.go

@@ -51,12 +51,16 @@ var (
 	port                    string   // Upload port, e.g.: COM10 or /dev/ttyACM0.
 	verify                  bool     // Upload, verify uploaded binary after the upload.
 	exportDir               string   // The compiled binary is written to this file
-	libraries               []string // List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.
 	optimizeForDebug        bool     // Optimize compile output for debug, not for release
 	programmer              string   // Use the specified programmer to upload
 	clean                   bool     // Cleanup the build folder and do not use any cached build
 	compilationDatabaseOnly bool     // Only create compilation database without actually compiling
 	sourceOverrides         string   // Path to a .json file that contains a set of replacements of the sketch source code.
+	// library and libraries sound similar but they're actually different.
+	// library expects a path to the root folder of one single library.
+	// libraries expects a path to a directory containing multiple libraries, similarly to the <directories.user>/libraries path.
+	library   []string // List of paths to libraries root folders. Can be used multiple times for different libraries
+	libraries []string // List of custom libraries dir paths separated by commas. Or can be used multiple times for multiple libraries paths.
 )
 
 // NewCommand created a new `compile` command
@@ -93,8 +97,10 @@ func NewCommand() *cobra.Command {
 	command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
 	command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
 	command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if board supports them.")
+	command.Flags().StringSliceVar(&library, "library", []string{},
+		"List of paths to libraries root folders. Can be used multiple times for different libraries.")
 	command.Flags().StringSliceVar(&libraries, "libraries", []string{},
-		"List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.")
+		"List of custom libraries dir paths separated by commas. Or can be used multiple times for multiple libraries dir paths.")
 	command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debugging, rather than for release.")
 	command.Flags().StringVarP(&programmer, "programmer", "P", "", "Optional, use the specified programmer to upload.")
 	command.Flags().BoolVar(&compilationDatabaseOnly, "only-compilation-database", false, "Just produce the compilation database, without actually compiling.")
@@ -171,6 +177,7 @@ func run(cmd *cobra.Command, args []string) {
 		Clean:                         clean,
 		CreateCompilationDatabaseOnly: compilationDatabaseOnly,
 		SourceOverride:                overrides,
+		Library:                       library,
 	}
 	compileOut := new(bytes.Buffer)
 	compileErr := new(bytes.Buffer)

commands/compile/compile.go

@@ -137,6 +137,8 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	builderCtx.OtherLibrariesDirs = paths.NewPathList(req.GetLibraries()...)
 	builderCtx.OtherLibrariesDirs.Add(configuration.LibrariesDir(configuration.Settings))
 
+	builderCtx.LibrariesDirs = paths.NewPathList(req.Library...)
+
 	if req.GetBuildPath() == "" {
 		builderCtx.BuildPath = bldr.GenBuildPath(sketch.FullPath)
 	} else {

legacy/builder/libraries_loader.go

@@ -61,6 +61,12 @@ func (s *LibrariesLoader) Run(ctx *types.Context) error {
 		return errors.WithStack(err)
 	}
 
+	for _, dir := range ctx.LibrariesDirs {
+		if err := lm.LoadLibraryFromDir(dir, libraries.User); err != nil {
+			return err
+		}
+	}
+
 	if debugLevel > 0 {
 		for _, lib := range lm.Libraries {
 			for _, libAlt := range lib.Alternatives {

legacy/builder/types/context.go

@@ -67,6 +67,7 @@ type Context struct {
 	BuiltInToolsDirs     paths.PathList
 	BuiltInLibrariesDirs paths.PathList
 	OtherLibrariesDirs   paths.PathList
+	LibrariesDirs        paths.PathList // List of paths pointing to individual libraries root folders
 	SketchLocation       *paths.Path
 	WatchedLocations     paths.PathList
 	ArduinoAPIVersion    string

rpc/cc/arduino/cli/commands/v1/board.pb.go

@@ -57,7 +57,7 @@ message CompileRequest {
   // If jobs is set to 0, it will use the number of available CPUs as the
   // maximum.
   int32 jobs = 14;
-  // List of custom libraries paths separated by commas.
+  // List of custom libraries dir paths.
   repeated string libraries = 15;
   // Optimize compile output for debug, not for release.
   bool optimize_for_debug = 16;
@@ -78,6 +78,8 @@ message CompileRequest {
   // When set to `true` the compiled binary will be copied to the export
   // directory.
   google.protobuf.BoolValue export_binaries = 23;
+  // List of paths to libraries root folders
+  repeated string library = 24;
 }
 
 message CompileResponse {