[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
This commit is contained in:
Dan McClain 2019-10-07 14:32:30 -04:00 committed by noroadsleft
parent d9b056486b
commit f04e58dad6
5 changed files with 46 additions and 0 deletions

View file

@ -115,6 +115,16 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor
```
## `qmk list_keyboards`
This command lists all the keyboards currently defined in `qmk_firmware`
**Usage**:
```
qmk list_keyboards
```
## `qmk new-keymap`
This command creates a new keymap based on a keyboard's existing default keymap.

View file

@ -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

View file

@ -0,0 +1 @@
from . import keyboards

View file

@ -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)

View file

@ -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