[CLI] Add a subcommand for getting information about a keyboard (#8666)

You can now use `qmk info` to get information about keyboards and keymaps.

Co-authored-by: Erovia <Erovia@users.noreply.github.com>

4 files changed, 155 insertions, 15 deletions

diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index 068572d4ef..b797bf31e8 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -12,6 +12,7 @@ from . import config
 from . import doctor
 from . import flash
 from . import hello
+from . import info
 from . import json
 from . import json2c
 from . import list
diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py
index 0cd8b6192a..600161c5c5 100644
--- a/lib/python/qmk/cli/cformat.py
+++ b/lib/python/qmk/cli/cformat.py
@@ -4,7 +4,9 @@ import subprocess
 from shutil import which
 
 from milc import cli
-import qmk.path
+
+from qmk.path import normpath
+from qmk.c_parse import c_source_files
 
 
 def cformat_run(files, all_files):
@@ -45,10 +47,10 @@ def cformat(cli):
     ignores = ['tmk_core/protocol/usb_hid', 'quantum/template']
     # Find the list of files to format
     if cli.args.files:
-        files.extend(qmk.path.normpath(file) for file in cli.args.files)
+        files.extend(normpath(file) for file in cli.args.files)
     # If -a is specified
     elif cli.args.all_files:
-        all_files = qmk.path.c_source_files(core_dirs)
+        all_files = c_source_files(core_dirs)
         # The following statement checks each file to see if the file path is in the ignored directories.
         files.extend(file for file in all_files if not any(i in str(file) for i in ignores))
     # No files specified & no -a flag
@@ -56,7 +58,7 @@ def cformat(cli):
         base_args = ['git', 'diff', '--name-only', cli.args.base_branch]
         out = subprocess.run(base_args + core_dirs, check=True, stdout=subprocess.PIPE)
         changed_files = filter(None, out.stdout.decode('UTF-8').split('\n'))
-        filtered_files = [qmk.path.normpath(file) for file in changed_files if not any(i in file for i in ignores)]
+        filtered_files = [normpath(file) for file in changed_files if not any(i in file for i in ignores)]
         files.extend(file for file in filtered_files if file.exists() and file.suffix in ['.c', '.h', '.cpp'])
 
     # Run clang-format on the files we've found
diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
new file mode 100755
index 0000000000..6977673e29
--- /dev/null
+++ b/lib/python/qmk/cli/info.py
@@ -0,0 +1,141 @@
+"""Keyboard information script.
+
+Compile an info.json for a particular keyboard and pretty-print it.
+"""
+import json
+
+from milc import cli
+
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.keyboard import render_layouts, render_layout
+from qmk.keymap import locate_keymap
+from qmk.info import info_json
+from qmk.path import is_keyboard
+
+ROW_LETTERS = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnop'
+COL_LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijilmnopqrstuvwxyz'
+
+
+def show_keymap(info_json, title_caps=True):
+    """Render the keymap in ascii art.
+    """
+    keymap_path = locate_keymap(cli.config.info.keyboard, cli.config.info.keymap)
+
+    if keymap_path and keymap_path.suffix == '.json':
+        if title_caps:
+            cli.echo('{fg_blue}Keymap "%s"{fg_reset}:', cli.config.info.keymap)
+        else:
+            cli.echo('{fg_blue}keymap_%s{fg_reset}:', cli.config.info.keymap)
+
+        keymap_data = json.load(keymap_path.open())
+        layout_name = keymap_data['layout']
+
+        for layer_num, layer in enumerate(keymap_data['layers']):
+            if title_caps:
+                cli.echo('{fg_cyan}Layer %s{fg_reset}:', layer_num)
+            else:
+                cli.echo('{fg_cyan}layer_%s{fg_reset}:', layer_num)
+
+            print(render_layout(info_json['layouts'][layout_name]['layout'], layer))
+
+
+def show_layouts(kb_info_json, title_caps=True):
+    """Render the layouts with info.json labels.
+    """
+    for layout_name, layout_art in render_layouts(kb_info_json).items():
+        title = layout_name.title() if title_caps else layout_name
+        cli.echo('{fg_cyan}%s{fg_reset}:', title)
+        print(layout_art)  # Avoid passing dirty data to cli.echo()
+
+
+def show_matrix(info_json, title_caps=True):
+    """Render the layout with matrix labels in ascii art.
+    """
+    for layout_name, layout in info_json['layouts'].items():
+        # Build our label list
+        labels = []
+        for key in layout['layout']:
+            if key['matrix']:
+                row = ROW_LETTERS[key['matrix'][0]]
+                col = COL_LETTERS[key['matrix'][1]]
+
+                labels.append(row + col)
+            else:
+                labels.append('')
+
+        # Print the header
+        if title_caps:
+            cli.echo('{fg_blue}Matrix for "%s"{fg_reset}:', layout_name)
+        else:
+            cli.echo('{fg_blue}matrix_%s{fg_reset}:', layout_name)
+
+        print(render_layout(info_json['layouts'][layout_name]['layout'], labels))
+
+
+@cli.argument('-kb', '--keyboard', help='Keyboard to show info for.')
+@cli.argument('-km', '--keymap', help='Show the layers for a JSON keymap too.')
+@cli.argument('-l', '--layouts', action='store_true', help='Render the layouts.')
+@cli.argument('-m', '--matrix', action='store_true', help='Render the layouts with matrix information.')
+@cli.argument('-f', '--format', default='friendly', arg_only=True, help='Format to display the data in (friendly, text, json) (Default: friendly).')
+@cli.subcommand('Keyboard information.')
+@automagic_keyboard
+@automagic_keymap
+def info(cli):
+    """Compile an info.json for a particular keyboard and pretty-print it.
+    """
+    # Determine our keyboard(s)
+    if not is_keyboard(cli.config.info.keyboard):
+        cli.log.error('Invalid keyboard: %s!', cli.config.info.keyboard)
+        exit(1)
+
+    # Build the info.json file
+    kb_info_json = info_json(cli.config.info.keyboard)
+
+    # Output in the requested format
+    if cli.args.format == 'json':
+        print(json.dumps(kb_info_json))
+        exit()
+
+    if cli.args.format == 'text':
+        for key in sorted(kb_info_json):
+            if key == 'layouts':
+                cli.echo('{fg_blue}layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
+            else:
+                cli.echo('{fg_blue}%s{fg_reset}: %s', key, kb_info_json[key])
+
+        if cli.config.info.layouts:
+            show_layouts(kb_info_json, False)
+
+        if cli.config.info.matrix:
+            show_matrix(kb_info_json, False)
+
+        if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
+            show_keymap(kb_info_json, False)
+
+    elif cli.args.format == 'friendly':
+        cli.echo('{fg_blue}Keyboard Name{fg_reset}: %s', kb_info_json.get('keyboard_name', 'Unknown'))
+        cli.echo('{fg_blue}Manufacturer{fg_reset}: %s', kb_info_json.get('manufacturer', 'Unknown'))
+        if 'url' in kb_info_json:
+            cli.echo('{fg_blue}Website{fg_reset}: %s', kb_info_json['url'])
+        if kb_info_json.get('maintainer') == 'qmk':
+            cli.echo('{fg_blue}Maintainer{fg_reset}: QMK Community')
+        else:
+            cli.echo('{fg_blue}Maintainer{fg_reset}: %s', kb_info_json.get('maintainer', 'qmk'))
+        cli.echo('{fg_blue}Keyboard Folder{fg_reset}: %s', kb_info_json.get('keyboard_folder', 'Unknown'))
+        cli.echo('{fg_blue}Layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
+        if 'width' in kb_info_json and 'height' in kb_info_json:
+            cli.echo('{fg_blue}Size{fg_reset}: %s x %s' % (kb_info_json['width'], kb_info_json['height']))
+        cli.echo('{fg_blue}Processor{fg_reset}: %s', kb_info_json.get('processor', 'Unknown'))
+        cli.echo('{fg_blue}Bootloader{fg_reset}: %s', kb_info_json.get('bootloader', 'Unknown'))
+
+        if cli.config.info.layouts:
+            show_layouts(kb_info_json, True)
+
+        if cli.config.info.matrix:
+            show_matrix(kb_info_json, True)
+
+        if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
+            show_keymap(kb_info_json, True)
+
+    else:
+        cli.log.error('Unknown format: %s', cli.args.format)
diff --git a/lib/python/qmk/cli/list/keymaps.py b/lib/python/qmk/cli/list/keymaps.py
index cec9ca0224..b18289eb35 100644
--- a/lib/python/qmk/cli/list/keymaps.py
+++ b/lib/python/qmk/cli/list/keymaps.py
@@ -4,7 +4,7 @@ from milc import cli
 
 import qmk.keymap
 from qmk.decorators import automagic_keyboard
-from qmk.errors import NoSuchKeyboardError
+from qmk.path import is_keyboard
 
 
 @cli.argument("-kb", "--keyboard", help="Specify keyboard name. Example: 1upkeyboards/1up60hse")
@@ -13,13 +13,9 @@ from qmk.errors import NoSuchKeyboardError
 def list_keymaps(cli):
     """List the keymaps for a specific keyboard
     """
-    try:
-        for name in qmk.keymap.list_keymaps(cli.config.list_keymaps.keyboard):
-            # We echo instead of cli.log.info to allow easier piping of this output
-            cli.echo('%s', name)
-    except NoSuchKeyboardError as e:
-        cli.echo("{fg_red}%s: %s", cli.config.list_keymaps.keyboard, e.message)
-    except (FileNotFoundError, PermissionError) as e:
-        cli.echo("{fg_red}%s: %s", cli.config.list_keymaps.keyboard, e)
-    except TypeError:
-        cli.echo("{fg_red}Something went wrong. Did you specify a keyboard?")
+    if not is_keyboard(cli.config.list_keymaps.keyboard):
+        cli.log.error('Keyboard %s does not exist!', cli.config.list_keymaps.keyboard)
+        exit(1)
+
+    for name in qmk.keymap.list_keymaps(cli.config.list_keymaps.keyboard):
+        print(name)