Deprecate --build-properties flag in favor of --build-property

Author: silvanocerza

Diff for: cli/compile/compile.go

@@ -57,12 +57,16 @@ var (
 // NewCommand created a new `compile` command
 func NewCommand() *cobra.Command {
 	command := &cobra.Command{
-		Use:     "compile",
-		Short:   "Compiles Arduino sketches.",
-		Long:    "Compiles Arduino sketches.",
-		Example: "  " + os.Args[0] + " compile -b arduino:avr:uno /home/user/Arduino/MySketch",
-		Args:    cobra.MaximumNArgs(1),
-		Run:     run,
+		Use:   "compile",
+		Short: "Compiles Arduino sketches.",
+		Long:  "Compiles Arduino sketches.",
+		Example: "" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property='build.extra_flags=\"-DMY_DEFINE=\"hello world\"\"' /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property='build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"' /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property=build.extra_flags=-DPIN=2 --build-property='compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"'-DMY_DEFINE=\"hello world\"' /home/user/Arduino/MySketch\n",
+		Args: cobra.MaximumNArgs(1),
+		Run:  run,
 	}
 
 	command.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
@@ -72,8 +76,10 @@ func NewCommand() *cobra.Command {
 	command.Flags().StringVarP(&exportDir, "output-dir", "", "", "Save build artifacts in this directory.")
 	command.Flags().StringVar(&buildPath, "build-path", "",
 		"Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS.")
-	command.Flags().StringArrayVar(&buildProperties, "build-properties", []string{},
-		"List of custom build properties separated by spaces. Or can be used multiple times for multiple properties.")
+	command.Flags().StringSliceVar(&buildProperties, "build-properties", []string{},
+		"List of custom build properties separated by commas. Or can be used multiple times for multiple properties.")
+	command.Flags().StringArrayVar(&buildProperties, "build-property", []string{},
+		"Override a build property with a custom value. Can be used multiple times for multiple properties.")
 	command.Flags().StringVar(&warnings, "warnings", "none",
 		`Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`)
 	command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
@@ -95,6 +101,8 @@ func NewCommand() *cobra.Command {
 
 	configuration.Settings.BindPFlag("sketch.always_export_binaries", command.Flags().Lookup("export-binaries"))
 
+	command.Flags().MarkDeprecated("build-properties", "please use --build-property instead.")
+
 	return command
 }
 

Diff for: test/testdata/sketch_with_multiple_defines/sketch_with_multiple_defines.ino

@@ -3,6 +3,9 @@ const int DEFAULT_PIN = PIN;
 const String DEFAULT_SSID = SSID;
 
 void setup() {
+    Serial.begin(9600);
+    Serial.println(DEFAULT_PIN);
+    Serial.println(DEFAULT_SSID);
 }
 
 void loop() {

Diff for: test/testdata/sketch_with_multiple_int_defines/sketch_with_multiple_int_defines.ino

@@ -0,0 +1,12 @@
+
+const int MY_FIRST_PIN = FIRST_PIN;
+const int MY_SECOND_PIN = SECOND_PIN;
+
+void setup() {
+    Serial.begin(9600);
+    Serial.println(MY_FIRST_PIN);
+    Serial.println(MY_SECOND_PIN);
+}
+
+void loop() {
+}

Diff for: test/testdata/sketch_with_single_int_define/sketch_with_single_int_define.ino

@@ -0,0 +1,10 @@
+
+const int FOO = MY_DEFINE;
+
+void setup() {
+    Serial.begin(9600);
+    Serial.println(FOO);
+}
+
+void loop() {
+}

Diff for: test/testdata/sketch_with_single_define/sketch_with_single_define.ino renamed to test/testdata/sketch_with_single_string_define/sketch_with_single_string_define.ino

@@ -2,6 +2,8 @@
 const String FOO = MY_DEFINE;
 
 void setup() {
+    Serial.begin(9600);
+    Serial.println(FOO);
 }
 
 void loop() {