diff options
Diffstat (limited to 'lib/python')
| -rw-r--r-- | lib/python/qmk/cli/__init__.py | 1 | ||||
| -rw-r--r-- | lib/python/qmk/cli/list/__init__.py | 1 | ||||
| -rw-r--r-- | lib/python/qmk/cli/list/keyboards.py | 26 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_cli_commands.py | 8 | 
4 files changed, 36 insertions, 0 deletions
| 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 + [email protected]("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 | 
