[breaking] remove board details <fqbn> in favour of board details -b <fqbn>

Author: umbynos

cli/board/details.go

@@ -44,14 +44,14 @@ func initDetailsCommand() *cobra.Command {
 		Short:   tr("Print details about a board."),
 		Long:    tr("Show information about a board, in particular if the board has options to be specified in the FQBN."),
 		Example: "  " + os.Args[0] + " board details -b arduino:avr:nano",
-		Args:    cobra.MaximumNArgs(1),
+		Args:    cobra.NoArgs,
 		Run:     runDetailsCommand,
 	}
 
 	fqbn.AddToCommand(detailsCommand)
 	detailsCommand.Flags().BoolVarP(&showFullDetails, "full", "f", false, tr("Show full board details"))
 	detailsCommand.Flags().BoolVarP(&listProgrammers, "list-programmers", "", false, tr("Show list of available programmers"))
-	// detailsCommand.MarkFlagRequired("fqbn") // enable once `board details <fqbn>` is removed
+	detailsCommand.MarkFlagRequired("fqbn")
 
 	return detailsCommand
 }
@@ -61,11 +61,6 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Executing `arduino-cli board details`")
 
-	// remove once `board details <fqbn>` is removed
-	if fqbn.GetFQBN() == "" && len(args) > 0 {
-		fqbn.SetFQBN(args[0])
-	}
-
 	res, err := board.Details(context.Background(), &rpc.BoardDetailsRequest{
 		Instance: inst,
 		Fqbn:     fqbn.GetFQBN(),

i18n/data/en.po

@@ -227,11 +227,11 @@ msgstr "Board Name"
 msgid "Board found: %s"
 msgstr "Board found: %s"
 
-#: cli/board/details.go:124
+#: cli/board/details.go:119
 msgid "Board name:"
 msgstr "Board name:"
 
-#: cli/board/details.go:126
+#: cli/board/details.go:121
 msgid "Board version:"
 msgstr "Board version:"
 
@@ -361,7 +361,7 @@ msgstr "Checking previous results for {0} (result = {1}, dep = {2})"
 msgid "Checksum differs from checksum in package.json"
 msgstr "Checksum differs from checksum in package.json"
 
-#: cli/board/details.go:172
+#: cli/board/details.go:167
 msgid "Checksum:"
 msgstr "Checksum:"
 
@@ -500,7 +500,7 @@ msgstr "Debug interpreter e.g.: %s"
 msgid "Debugging not supported for board %s"
 msgstr "Debugging not supported for board %s"
 
-#: cli/board/details.go:128
+#: cli/board/details.go:123
 msgid "Debugging supported:"
 msgstr "Debugging supported:"
 
@@ -762,7 +762,7 @@ msgstr "Error getting Debug info: %v"
 msgid "Error getting absolute path of sketch archive"
 msgstr "Error getting absolute path of sketch archive"
 
-#: cli/board/details.go:75
+#: cli/board/details.go:70
 msgid "Error getting board details: %v"
 msgstr "Error getting board details: %v"
 
@@ -1014,7 +1014,7 @@ msgstr "Expected compiled sketch in directory %s, but is a file instead"
 msgid "FQBN"
 msgstr "FQBN"
 
-#: cli/board/details.go:125
+#: cli/board/details.go:120
 msgid "FQBN:"
 msgstr "FQBN:"
 
@@ -1062,7 +1062,7 @@ msgstr "Failed to read: {0}"
 msgid "Failed uploading"
 msgstr "Failed uploading"
 
-#: cli/board/details.go:170
+#: cli/board/details.go:165
 msgid "File:"
 msgstr "File:"
 
@@ -1134,12 +1134,12 @@ msgstr "Global variables use {0} bytes of dynamic memory."
 msgid "ID"
 msgstr "ID"
 
-#: cli/board/details.go:97
-#: cli/board/details.go:198
+#: cli/board/details.go:92
+#: cli/board/details.go:193
 msgid "Id"
 msgstr "Id"
 
-#: cli/board/details.go:139
+#: cli/board/details.go:134
 msgid "Identification properties:"
 msgstr "Identification properties:"
 
@@ -1478,7 +1478,7 @@ msgstr "Monitor port settings:"
 msgid "Multiple libraries were found for \"{0}\""
 msgstr "Multiple libraries were found for \"{0}\""
 
-#: cli/board/details.go:198
+#: cli/board/details.go:193
 #: cli/core/list.go:84
 #: cli/core/search.go:114
 #: cli/lib/list.go:125
@@ -1567,11 +1567,11 @@ msgstr "Not found: {0}"
 msgid "Not used: {0}"
 msgstr "Not used: {0}"
 
-#: cli/board/details.go:169
+#: cli/board/details.go:164
 msgid "OS:"
 msgstr "OS:"
 
-#: cli/board/details.go:133
+#: cli/board/details.go:128
 msgid "Official Arduino board:"
 msgstr "Official Arduino board:"
 
@@ -1580,7 +1580,7 @@ msgstr "Official Arduino board:"
 msgid "Open a communication port with a board."
 msgstr "Open a communication port with a board."
 
-#: cli/board/details.go:181
+#: cli/board/details.go:176
 msgid "Option:"
 msgstr "Option:"
 
@@ -1628,23 +1628,23 @@ msgstr "Overwrite existing config file."
 msgid "PACKAGER"
 msgstr "PACKAGER"
 
-#: cli/board/details.go:149
+#: cli/board/details.go:144
 msgid "Package URL:"
 msgstr "Package URL:"
 
-#: cli/board/details.go:148
+#: cli/board/details.go:143
 msgid "Package maintainer:"
 msgstr "Package maintainer:"
 
-#: cli/board/details.go:147
+#: cli/board/details.go:142
 msgid "Package name:"
 msgstr "Package name:"
 
-#: cli/board/details.go:151
+#: cli/board/details.go:146
 msgid "Package online help:"
 msgstr "Package online help:"
 
-#: cli/board/details.go:150
+#: cli/board/details.go:145
 msgid "Package website:"
 msgstr "Package website:"
 
@@ -1688,31 +1688,31 @@ msgstr "Platform '%s' not found"
 msgid "Platform ID"
 msgstr "Platform ID"
 
-#: cli/board/details.go:157
+#: cli/board/details.go:152
 msgid "Platform URL:"
 msgstr "Platform URL:"
 
-#: cli/board/details.go:156
+#: cli/board/details.go:151
 msgid "Platform architecture:"
 msgstr "Platform architecture:"
 
-#: cli/board/details.go:155
+#: cli/board/details.go:150
 msgid "Platform category:"
 msgstr "Platform category:"
 
-#: cli/board/details.go:162
+#: cli/board/details.go:157
 msgid "Platform checksum:"
 msgstr "Platform checksum:"
 
-#: cli/board/details.go:158
+#: cli/board/details.go:153
 msgid "Platform file name:"
 msgstr "Platform file name:"
 
-#: cli/board/details.go:154
+#: cli/board/details.go:149
 msgid "Platform name:"
 msgstr "Platform name:"
 
-#: cli/board/details.go:160
+#: cli/board/details.go:155
 msgid "Platform size (bytes):"
 msgstr "Platform size (bytes):"
 
@@ -1759,11 +1759,11 @@ msgstr "Prints the current configuration."
 msgid "Programmer '%s' not found"
 msgstr "Programmer '%s' not found"
 
-#: cli/board/details.go:97
+#: cli/board/details.go:92
 msgid "Programmer name"
 msgstr "Programmer name"
 
-#: cli/board/details.go:198
+#: cli/board/details.go:193
 msgid "Programmers:"
 msgstr "Programmers:"
 
@@ -1793,7 +1793,7 @@ msgstr "Removes one or more values from a setting."
 msgid "Replacing %[1]s with %[2]s"
 msgstr "Replacing %[1]s with %[2]s"
 
-#: cli/board/details.go:166
+#: cli/board/details.go:161
 msgid "Required tool:"
 msgstr "Required tool:"
 
@@ -1946,7 +1946,7 @@ msgstr "Shows the version number of Arduino CLI which is installed on your syste
 msgid "Shows version number of Arduino CLI."
 msgstr "Shows version number of Arduino CLI."
 
-#: cli/board/details.go:171
+#: cli/board/details.go:166
 msgid "Size (bytes):"
 msgstr "Size (bytes):"
 
@@ -2096,7 +2096,7 @@ msgstr "Type"
 msgid "Types: %s"
 msgstr "Types: %s"
 
-#: cli/board/details.go:173
+#: cli/board/details.go:168
 msgid "URL:"
 msgstr "URL:"
 

test/test_board.py

@@ -502,37 +502,13 @@ def test_board_details(run_command):
     assert result["debugging_supported"] is True
 
 
-# old `arduino-cli board details` did not need -b <fqbn> flag to work
-def test_board_details_old(run_command):
-    run_command(["core", "update-index"])
-    # Download samd core pinned to 1.8.6
-    run_command(["core", "install", "arduino:samd@1.8.6"])
-    result = run_command(["board", "details", "arduino:samd:nano_33_iot", "--format", "json"])
-    assert result.ok
-    # Sort everything before compare
-    result = json.loads(result.stdout)
-    gold_board_details = json.loads(gold_board)
-
-    assert result["fqbn"] == gold_board_details["fqbn"]
-    assert result["name"] == gold_board_details["name"]
-    assert result["version"] == gold_board_details["version"]
-    assert result["properties_id"] == gold_board_details["properties_id"]
-    assert result["official"] == gold_board_details["official"]
-    assert result["package"] == gold_board_details["package"]
-    assert result["platform"] == gold_board_details["platform"]
-    for usb_id in gold_board_details["identification_properties"]:
-        assert usb_id in result["identification_properties"]
-    for programmer in gold_board_details["programmers"]:
-        assert programmer in result["programmers"]
-
-
 def test_board_details_no_flags(run_command):
     run_command(["core", "update-index"])
     # Download samd core pinned to 1.8.6
     run_command(["core", "install", "arduino:samd@1.8.6"])
     result = run_command(["board", "details"])
     assert not result.ok
-    assert "Error getting board details: Invalid FQBN:" in result.stderr
+    assert "Error: required flag(s) \"fqbn\" not set" in result.stderr
     assert result.stdout == ""