Add first set of profile commands
#2917
Conversation
profile commandprofile commands
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2917 +/- ##
==========================================
+ Coverage 67.83% 67.84% +0.01%
==========================================
Files 238 248 +10
Lines 22442 22854 +412
==========================================
+ Hits 15223 15506 +283
- Misses 6016 6124 +108
- Partials 1203 1224 +21
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
It creates a `sketch.yaml` file at the provided path. A new profile can be added to the file by providing a profile name and FQBN.
ab96ed6 to
8a41c13
Compare
It adds one or multiple libraries to the specified profile.
8a41c13 to
d3d7a59
Compare
It removes a library from the specified profile.
67c9a2c to
f98bf7d
Compare
If the project file contains only one profile, it is automatically set as default, otherwise the `--default` flag can be used. Library operations are automatically executed on the default profile.
Sets the default profile to the provided existing profile.
896841b to
a2c86ef
Compare
It dumps the content of the project file.
|
Hello, this is great 🔥 Maybe you want to consider adding and removing multiple libs (later cores) with a single request. I do not know how it performs, but when a user interface wants to initialize a profile from a set of libraries and cores, one request would be better than multiple ones. Update: I checked the changes only from the point of the proto API as a client. |
There was a problem hiding this comment.
Great job! 🚀
We have a bug in the long standing:
arduino-cli/internal/arduino/sketch/profiles.go
Lines 166 to 167 in 55f86b5
arduino-cli profile init --profile Uno_profile -b arduino:avr:uno /tmp/sk
cat /tmp/sk/sketch.yaml
profiles:
Uno_profile:
fqbn: arduino:avr:uno
platforms:
- platform: arduino:avr (1.8.6)
libraries:
default_profile: cYou can see here that it produces libraries: without [], this is an invalid yaml.
Basically we have to check if the items == 0, then we either skip that property or we set libraries: [].
I'm afraid it could also happen for the platforms so I'd put that check there too.
| } | ||
|
|
||
| newProfile := &sketch.Profile{Name: req.GetProfileName(), FQBN: req.GetFqbn()} | ||
| // TODO: what to do with the PlatformIndexURL? |
There was a problem hiding this comment.
Do we have some kind of internal API that we can use to retrieve platform <-> index URL?
commands/service_profile_init.go
Outdated
| sketchPath := paths.New(req.GetSketchPath()) | ||
| projectFilePath, err := sketchPath.Join("sketch.yaml").Abs() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // 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 | ||
| } |
There was a problem hiding this comment.
| sketchPath := paths.New(req.GetSketchPath()) | |
| projectFilePath, err := sketchPath.Join("sketch.yaml").Abs() | |
| if err != nil { | |
| return nil, err | |
| } | |
| // 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 | |
| } | |
| sketchPath := paths.New(req.GetSketchPath()) | |
| projectFilePath, err := sketchPath.Join("sketch.yaml").Abs() | |
| if err != nil { | |
| return nil, err | |
| } | |
| // 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 | |
| } |
Can you please move this snippet of code under a private function? Something like checkProfilePreconditions.
And call that in all the new function you have created under commands. I've noticed that you do this same check for al of them
There was a problem hiding this comment.
I have refactored it using the already existing function sketch.GetProjectPath()
There was a problem hiding this comment.
I feel that the design of the profile dump command is inappropriate. This command is actually printing the data of the entire sketch project file, not the build profile data alone. Although the primary usage of the sketch project file is currently for defining build profiles, it is not limited to this purpose and there is a good chance that it will be used for additional things unrelated to build profiles as time goes on.
The profile dump command should be a tool for printing the data from a build profile.
If you want a tool for printing the sketch project file, that should go somewhere else, such as under the sketch command (e.g., sketch project dump), not under the profile command.
If the user doesn't specify a profile ID, it should print the default build profile from the sketch project file. An --all flag could be added to cause it to print all build profiles present in the sketch project file.
Co-authored-by: Per Tillisch <accounts@perglass.com>
d92be42 to
5381938
Compare
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Code enhancement
What is the current behavior?
Operations on the
sketch.yamlproject file must be done manually.What is the new behavior?
First set of
profilecommands:profile init [<PATH>] [-m <PROFILE_NAME -b <FQBN>] [--default]creates asketch.yamlfile at the provided path. By default it creates the file in the current directory. A new profile can be added to the file by providing a profile name and FQBN (mandatory). The platform is detected automatically. If there is only one profile, it is automatically set as the default profile, otherwise the flag--defaultmust be used. The command fails in the following cases:profile lib add <LIB_NAME@LIB_VERSION> [-m <PROFILE_NAME] [--dest-dir <PATH>]adds a library to the provided profile or to the default one. By default it checks for thesketch.yamlfile in the current directory.profile lib remove <LIB_NAME> [-m <PROFILE_NAME] [--dest-dir <PATH>]removes a library from the provided profile or from the default one. By default it checks for thesketch.yamlfile in the current directory.profile set-default <PROFILE_NAME> [--dest-dir <PATH>]sets the default profile to an existing profile. By default it checks for thesketch.yamlfile in the current directory.profile dump [<PATH>]dumps the content of thesketch.yamlfile. It supports theyamlandjsonformats.Does this PR introduce a breaking change, and is titled accordingly?
Other information