1
0
Fork 0

Add support for tab completion (#12411)

* Add support for tab completion

* make flake8 happy

* Add documentation
This commit is contained in:
Zach White 2021-04-14 19:00:22 -07:00 committed by GitHub
parent b33e6793de
commit 588bcdc8ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 168 additions and 85 deletions

View file

@ -9,7 +9,7 @@ from glob import glob
from qmk.c_parse import parse_config_h_file
from qmk.json_schema import json_load
from qmk.makefile import parse_rules_mk_file
from qmk.path import is_keyboard
from qmk.path import is_keyboard, under_qmk_firmware
BOX_DRAWING_CHARACTERS = {
"unicode": {
@ -33,6 +33,24 @@ BOX_DRAWING_CHARACTERS = {
base_path = os.path.join(os.getcwd(), "keyboards") + os.path.sep
def find_keyboard_from_dir():
"""Returns a keyboard name based on the user's current directory.
"""
relative_cwd = under_qmk_firmware()
if relative_cwd and len(relative_cwd.parts) > 1 and relative_cwd.parts[0] == 'keyboards':
# Attempt to extract the keyboard name from the current directory
current_path = Path('/'.join(relative_cwd.parts[1:]))
if 'keymaps' in current_path.parts:
# Strip current_path of anything after `keymaps`
keymap_index = len(current_path.parts) - current_path.parts.index('keymaps') - 1
current_path = current_path.parents[keymap_index]
if is_keyboard(current_path):
return str(current_path)
def keyboard_folder(keyboard):
"""Returns the actual keyboard folder.
@ -61,6 +79,12 @@ def _find_name(path):
return path.replace(base_path, "").replace(os.path.sep + "rules.mk", "")
def keyboard_completer(prefix, action, parser, parsed_args):
"""Returns a list of keyboards for tab completion.
"""
return list_keyboards()
def list_keyboards():
"""Returns a list of all keyboards.
"""