Add first set of profile commands
#2917
Add
profile lib remove command
It removes a library from the specified profile.
- Loading branch information
commit f98bf7dd930e02440a943847c71ef89415bbde7e
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // This file is part of arduino-cli. | ||
| // | ||
| // Copyright 2025 ARDUINO SA (http://www.arduino.cc/) | ||
| // | ||
| // This software is released under the GNU General Public License version 3, | ||
| // which covers the main part of arduino-cli. | ||
| // The terms of this license can be found at: | ||
| // https://www.gnu.org/licenses/gpl-3.0.en.html | ||
| // | ||
| // You can be released from the requirements of the above licenses by purchasing | ||
| // a commercial license. Buying such a license is mandatory if you want to | ||
| // modify or otherwise use the software for commercial activities involving the | ||
| // Arduino software without disclosing the source code of your own applications. | ||
| // To purchase a commercial license, send an email to license@arduino.cc. | ||
|
|
||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/arduino/arduino-cli/commands/cmderrors" | ||
| "github.com/arduino/arduino-cli/internal/arduino/sketch" | ||
| rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" | ||
| paths "github.com/arduino/go-paths-helper" | ||
| ) | ||
|
|
||
| func (s *arduinoCoreServerImpl) ProfileLibRemove(ctx context.Context, req *rpc.ProfileLibRemoveRequest) (*rpc.ProfileLibRemoveResponse, error) { | ||
| sketchPath := paths.New(req.GetSketchPath()) | ||
| projectFilePath, err := sketchPath.Join("sketch.yaml").Abs() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if req.GetProfileName() == "" { | ||
| return nil, &cmderrors.MissingProfileError{} | ||
| } | ||
|
|
||
| // Returns an error if the main file is missing from the sketch so there is no need to check if the path exists | ||
| sk, err := sketch.New(sketchPath) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| profile, err := sk.GetProfile(req.ProfileName) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| lib, err := profile.GetLibrary(req.LibName, true) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| err = projectFilePath.WriteFile([]byte(sk.Project.AsYaml())) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &rpc.ProfileLibRemoveResponse{LibName: lib.Library, LibVersion: lib.Version.String()}, nil | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it will improve usability if this operation also adds all the dependencies of that library; otherwise, the user will need to enumerate all of them one by one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The concern I have with this proposal is that the dependencies specified in the library metadata are not necessarily required to compile a specific sketch.
Dependencies of a library may be required only for specific use cases that are not applicable to a given sketch project.
The library author may declare dependencies because they are a dependency of one of the library's example sketches, even though they are not a dependency of the library itself.
In this case, the unnecessary dependencies would pollute the environment generated by the build profile, which could result in problems caused by library discovery results other than what was intended by the user.
So I would recommend adding a flag that allows the user to control this behavior, similar to what was done for
lib install:https://arduino.github.io/arduino-cli/dev/commands/arduino-cli_lib_install/#options