west build: display sorted list of boards on error

This commit modifies the `west build` command to display a sorted list
of available boards when an invalid board is specified, making it easier
for users to find the correct board name.

Signed-off-by: Luca Burelli <l.burelli@arduino.cc>

Author: pillo79

cmake/modules/boards.cmake

@@ -221,7 +221,7 @@ else()
   message("No board named '${BOARD}' found.\n\n"
           "Please choose one of the following boards:\n"
   )
-  execute_process(${list_boards_commands})
+  execute_process(${list_boards_commands} --sort-by-name)
   unset(CACHED_BOARD CACHE)
   message(FATAL_ERROR "Invalid BOARD; see above.")
 endif()

scripts/list_boards.py

@@ -378,6 +378,8 @@ def add_args(parser):
 def add_args_formatting(parser):
     parser.add_argument("--cmakeformat", default=None,
                         help='''CMake Format string to use to list each board''')
+    parser.add_argument("--sort-by-name", default=False, action='store_true',
+                        help='''Sort board groups by name''')
 
 
 def variant_v2_qualifiers(variant, qualifiers = None):
@@ -413,9 +415,11 @@ def board_v2_qualifiers_csv(board):
 
 
 def dump_v2_boards(args):
-    boards = find_v2_boards(args)
+    boards = find_v2_boards(args).values()
+    if args.sort_by_name:
+        boards = sorted(boards, key=lambda b: b.name)
 
-    for b in boards.values():
+    for b in boards:
         qualifiers_list = board_v2_qualifiers(b)
         if args.cmakeformat is not None:
             notfound = lambda x: x or 'NOTFOUND'
@@ -439,10 +443,14 @@ def dump_v2_boards(args):
 
 
 def dump_boards(args):
-    arch2boards = find_arch2boards(args)
-    for arch, boards in arch2boards.items():
+    arch2boards = find_arch2boards(args).items()
+    if args.sort_by_name:
+        arch2boards = sorted(arch2boards, key=lambda x: x[0])
+    for arch, boards in arch2boards:
         if args.cmakeformat is None:
             print(f'{arch}:')
+        if args.sort_by_name:
+            boards = sorted(boards, key=lambda b: b.name)
         for board in boards:
             if args.cmakeformat is not None:
                 info = args.cmakeformat.format(