stellarskylark/skylark-qmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
skylark-qmk/lib/python/qmk/cli/list/keymaps.py

26 lines
983 B
Python
Raw Normal View History

CLI: add support for list_keymaps List all the available keymaps for a given keyboard
2019-10-08 19:50:21 +00:00
"""List the keymaps for a specific keyboard
"""
from milc import cli
Add decorators for determining keyboard and keymap based on current directory (#8191) * Use pathlib everywhere we can * Improvements based on @erovia's feedback * rework qmk compile and qmk flash to use pathlib * style * Remove the subcommand_name argument from find_keyboard_keymap() * add experimental decorators * Create decorators for finding keyboard and keymap based on current directory. Decorators were inspired by @Erovia's brilliant work on the proof of concept.
2020-03-13 22:47:04 +00:00
Another major refactoring, add documentation Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2019-10-13 17:07:22 +00:00
import qmk.keymap
Add decorators for determining keyboard and keymap based on current directory (#8191) * Use pathlib everywhere we can * Improvements based on @erovia's feedback * rework qmk compile and qmk flash to use pathlib * style * Remove the subcommand_name argument from find_keyboard_keymap() * add experimental decorators * Create decorators for finding keyboard and keymap based on current directory. Decorators were inspired by @Erovia's brilliant work on the proof of concept.
2020-03-13 22:47:04 +00:00
from qmk.decorators import automagic_keyboard
Another major refactoring, add documentation Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2019-10-13 17:07:22 +00:00
from qmk.errors import NoSuchKeyboardError
Major update to work better with revisions Find the community keymaps supported by each revision.
2019-10-09 08:14:53 +00:00
Fix commandline parsing and flake8 findings, rebase Fixed commandline and config parsing. Thx @xplusplus. Rebased on master and fixed merge conflicts.
2020-01-07 20:54:21 +00:00
Get all buildable keymaps for each revision The command now return all keymaps that's buildable for a keyboard/revision. If the base directory of a keyboard does not contain a 'rules.mk' file, nothing is returned. If the base directory contains a 'keymaps' directory, those keycaps will be returned for every revision.
2019-10-09 18:53:18 +00:00
@cli.argument("-kb", "--keyboard", help="Specify keyboard name. Example: 1upkeyboards/1up60hse")
CLI: add support for list_keymaps List all the available keymaps for a given keyboard
2019-10-08 19:50:21 +00:00
@cli.subcommand("List the keymaps for a specific keyboard")
Add decorators for determining keyboard and keymap based on current directory (#8191) * Use pathlib everywhere we can * Improvements based on @erovia's feedback * rework qmk compile and qmk flash to use pathlib * style * Remove the subcommand_name argument from find_keyboard_keymap() * add experimental decorators * Create decorators for finding keyboard and keymap based on current directory. Decorators were inspired by @Erovia's brilliant work on the proof of concept.
2020-03-13 22:47:04 +00:00
@automagic_keyboard
CLI: add support for list_keymaps List all the available keymaps for a given keyboard
2019-10-08 19:50:21 +00:00
def list_keymaps(cli):
"""List the keymaps for a specific keyboard
"""
Another major refactoring, add documentation Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2019-10-13 17:07:22 +00:00
try:
Drop bs4 dependency, update docs, minor improvements
2019-10-24 18:33:58 +00:00
for name in qmk.keymap.list_keymaps(cli.config.list_keymaps.keyboard):
Another major refactoring, add documentation Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2019-10-13 17:07:22 +00:00
# We echo instead of cli.log.info to allow easier piping of this output
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
cli.echo('%s', name)
Another major refactoring, add documentation Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2019-10-13 17:07:22 +00:00
except NoSuchKeyboardError as e:
Drop bs4 dependency, update docs, minor improvements
2019-10-24 18:33:58 +00:00
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)
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
except TypeError:
cli.echo("{fg_red}Something went wrong. Did you specify a keyboard?")
Reference in a new issue Copy permalink