From f04e58dad6f56cdbd5d369c9e00405dcdb47c8ea Mon Sep 17 00:00:00 2001
From: Dan McClain <dan@danmcclain.net>
Date: Mon, 7 Oct 2019 14:32:30 -0400
Subject: [CLI] Add `qmk list_keyboards` (#6927)

`list_keyboards` replicates the `make list-keyboards` by globbing for all paths
that include `rules.mk` and then removing the paths that include `keymaps`.

This basis of this cli command could be reused in the future as a util, but is
not done so here since this would be the only place that would use it currently

Resolves #6911
---
 lib/python/qmk/cli/__init__.py            |  1 +
 lib/python/qmk/cli/list/__init__.py       |  1 +
 lib/python/qmk/cli/list/keyboards.py      | 26 ++++++++++++++++++++++++++
 lib/python/qmk/tests/test_cli_commands.py |  8 ++++++++
 4 files changed, 36 insertions(+)
 create mode 100644 lib/python/qmk/cli/list/__init__.py
 create mode 100644 lib/python/qmk/cli/list/keyboards.py

(limited to 'lib/python')

diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index fb4e0ecb46..e982a75fc8 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -8,6 +8,7 @@ from . import config
 from . import doctor
 from . import hello
 from . import json
+from . import list
 from . import new
 from . import pyformat
 from . import pytest
diff --git a/lib/python/qmk/cli/list/__init__.py b/lib/python/qmk/cli/list/__init__.py
new file mode 100644
index 0000000000..c36ba69548
--- /dev/null
+++ b/lib/python/qmk/cli/list/__init__.py
@@ -0,0 +1 @@
+from . import keyboards
diff --git a/lib/python/qmk/cli/list/keyboards.py b/lib/python/qmk/cli/list/keyboards.py
new file mode 100644
index 0000000000..53a7af75c6
--- /dev/null
+++ b/lib/python/qmk/cli/list/keyboards.py
@@ -0,0 +1,26 @@
+"""List the keyboards currently defined within QMK
+"""
+import os
+import re
+import glob
+
+from milc import cli
+
+@cli.subcommand("List the keyboards currently defined within QMK")
+def list_keyboards(cli):
+    """List the keyboards currently defined within QMK
+    """
+
+    base_path = os.path.join(os.getcwd(), "keyboards") + os.path.sep
+    kb_path_wildcard = os.path.join(base_path, "**", "rules.mk")
+
+    # find everywhere we have rules.mk where keymaps isn't in the path
+    paths = [path for path in glob.iglob(kb_path_wildcard, recursive=True) if 'keymaps' not in path]
+
+    # strip the keyboard directory path prefix and rules.mk suffix and alphabetize
+    find_name = lambda path: path.replace(base_path, "").replace(os.path.sep + "rules.mk", "")
+    names = sorted(map(find_name, paths))
+
+    for name in names:
+        # We echo instead of cli.log.info to allow easier piping of this output
+        cli.echo(name)
diff --git a/lib/python/qmk/tests/test_cli_commands.py b/lib/python/qmk/tests/test_cli_commands.py
index 2fc6e0f723..c9d632517b 100644
--- a/lib/python/qmk/tests/test_cli_commands.py
+++ b/lib/python/qmk/tests/test_cli_commands.py
@@ -37,3 +37,11 @@ def test_pyformat():
     result = check_subcommand('pyformat')
     assert result.returncode == 0
     assert 'Successfully formatted the python code' in result.stderr
+
+
+def test_list_keyboards():
+    result = check_subcommand('list_keyboards')
+    assert result.returncode == 0
+    # check to see if a known keyboard is returned
+    # this will fail if handwired/onekey/pytest is removed
+    assert 'handwired/onekey/pytest' in result.stdout
-- 
cgit v1.2.3