Apply review suggestions

Co-authored-by: Per Tillisch <[email protected]>

Author: MatteoPologruto

commands/cmderrors/cmderrors.go

@@ -222,7 +222,7 @@ func (e *DuplicateProfileError) Error() string {
 
 // GRPCStatus converts the error into a *status.Status
 func (e *DuplicateProfileError) GRPCStatus() *status.Status {
-	return status.New(codes.NotFound, e.Error())
+	return status.New(codes.AlreadyExists, e.Error())
 }
 
 // InvalidProfileError is returned when the profile has errors

commands/service_profile_dump.go

@@ -35,7 +35,7 @@ func (s *arduinoCoreServerImpl) ProfileDump(ctx context.Context, req *rpc.Profil
 	switch req.GetDumpFormat() {
 	case "yaml":
 		return &rpc.ProfileDumpResponse{EncodedProfile: sk.Project.AsYaml()}, nil
-	case "json":
+	case "", "json":
 		data, err := json.MarshalIndent(sk.Project, "", "  ")
 		if err != nil {
 			return nil, fmt.Errorf("error marshalling settings: %v", err)

internal/cli/profile/dump.go

@@ -29,8 +29,8 @@ import (
 func initDumpCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	dumpCommand := &cobra.Command{
 		Use:   "dump",
-		Short: i18n.Tr("Dumps the project file."),
-		Long:  i18n.Tr("Dumps the project file."),
+		Short: i18n.Tr("Print the sketch project file."),
+		Long:  i18n.Tr("Print the data from the sketch project file."),
 		Example: "" +
 			"  " + os.Args[0] + " profile dump\n",
 		Args: cobra.MaximumNArgs(1),

internal/cli/profile/init.go

@@ -31,12 +31,12 @@ func initInitCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	var defaultProfile bool
 	initCommand := &cobra.Command{
 		Use:   "init",
-		Short: i18n.Tr("Creates or updates the sketch project file."),
-		Long:  i18n.Tr("Creates or updates the sketch project file."),
+		Short: i18n.Tr("Create or update the sketch project file."),
+		Long:  i18n.Tr("Create or update the sketch project file."),
 		Example: "" +
 			"  # " + i18n.Tr("Creates or updates the sketch project file in the current directory.") + "\n" +
 			"  " + os.Args[0] + " profile init\n" +
-			"  " + os.Args[0] + " config init --profile Uno_profile -b arduino:avr:uno",
+			"  " + os.Args[0] + " profile init --profile uno_profile -b arduino:avr:uno",
 		Args: cobra.MaximumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			runInitCommand(cmd.Context(), args, srv, defaultProfile)

internal/cli/profile/lib.go

@@ -32,8 +32,8 @@ import (
 func initLibCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	libCommand := &cobra.Command{
 		Use:   "lib",
-		Short: i18n.Tr("Profile commands about libraries."),
-		Long:  i18n.Tr("Profile commands about libraries."),
+		Short: i18n.Tr("Commands related to build profile libraries."),
+		Long:  i18n.Tr("Commands related to the library dependencies of build profiles."),
 		Example: "" +
 			"  " + os.Args[0] + " profile lib add AudioZero -m my_profile\n" +
 			"  " + os.Args[0] + " profile lib remove Arduino_JSON --profile my_profile\n",
@@ -64,7 +64,7 @@ func initLibAddCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 		},
 	}
 
-	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
+	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))
 	profileArg.AddToCommand(addCommand, srv)
 
 	return addCommand
@@ -112,7 +112,7 @@ func initLibRemoveCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 		},
 	}
 
-	removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
+	removeCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))
 	profileArg.AddToCommand(removeCommand, srv)
 
 	return removeCommand

internal/cli/profile/profile.go

@@ -32,8 +32,8 @@ var (
 func NewCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	profileCommand := &cobra.Command{
 		Use:     "profile",
-		Short:   i18n.Tr("Arduino profile operations."),
-		Long:    i18n.Tr("Arduino profile operations."),
+		Short:   i18n.Tr("Build profile operations."),
+		Long:    i18n.Tr("Build profile operations."),
 		Example: "  " + os.Args[0] + " profile init",
 	}
 

internal/cli/profile/set_default.go

@@ -30,8 +30,8 @@ func initSetDefaultCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	var destDir string
 	setDefaultCommand := &cobra.Command{
 		Use:   "set-default",
-		Short: i18n.Tr("Sets the default profile."),
-		Long:  i18n.Tr("Sets the default profile."),
+		Short: i18n.Tr("Set the default build profile."),
+		Long:  i18n.Tr("Set the default build profile."),
 		Example: "" +
 			"  " + os.Args[0] + " profile set-default my_profile\n",
 		Args: cobra.ExactArgs(1),
@@ -40,7 +40,7 @@ func initSetDefaultCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 		},
 	}
 
-	setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
+	setDefaultCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the sketch project file."))
 
 	return setDefaultCommand
 }
@@ -53,4 +53,5 @@ func runSetDefaultCommand(ctx context.Context, args []string, srv rpc.ArduinoCor
 	if err != nil {
 		feedback.Fatal(i18n.Tr("Cannot set %s as default profile: %v", profileName, err), feedback.ErrGeneric)
 	}
+	feedback.Print(i18n.Tr("Default profile set to: %s", profileName))
 }

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

@@ -191,19 +191,19 @@ service ArduinoCoreService {
   // Set a single configuration value.
   rpc SettingsSetValue(SettingsSetValueRequest) returns (SettingsSetValueResponse);
 
-  // Create the project file and add a profile to it.
+  // Create the sketch project file and add a build profile to it.
   rpc InitProfile(InitProfileRequest) returns (InitProfileResponse) {}
 
-  // Add a library to the profile.
+  // Add a library to the build profile.
   rpc ProfileLibAdd(ProfileLibAddRequest) returns (ProfileLibAddResponse) {}
 
-  // Remove a library from the profile.
+  // Remove a library from the build profile.
   rpc ProfileLibRemove(ProfileLibRemoveRequest) returns (ProfileLibRemoveResponse) {}
 
-  // Set the default profile.
+  // Set the default build profile.
   rpc ProfileSetDefault(ProfileSetDefaultRequest) returns (ProfileSetDefaultResponse) {}
 
-  // Dump the project file.
+  // Dump the sketch project file.
   rpc ProfileDump(ProfileDumpRequest) returns (ProfileDumpResponse) {}
 }
 
@@ -505,7 +505,7 @@ message ProfileSetDefaultResponse {}
 message ProfileDumpRequest {
   // Absolute path to Sketch folder.
   string sketch_path = 1;
-  // The format of the dump.
+  // The format of the dump (default is "json", allowed values are "json", and "yaml").
   string dump_format = 2;
 }