qmk-firmware/lib/python/qmk/cli/list/keymaps.py

"""List the keymaps for a specific keyboard
"""
from milc import cli
import qmk.keymap
from qmk.errors import NoSuchKeyboardError


@cli.argument("-kb", "--keyboard", help="Specify keyboard name. Example: 1upkeyboards/1up60hse")
@cli.subcommand("List the keymaps for a specific keyboard")
def list_keymaps(cli):
    """List the keymaps for a specific keyboard
    """
    try:
        for name in qmk.keymap.list_keymaps(cli.config.list_keymaps.keyboard):
            # We echo instead of cli.log.info to allow easier piping of this output
            cli.echo('%s', name)
    except NoSuchKeyboardError as e:
        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)
    except TypeError:
        cli.echo("{fg_red}Something went wrong. Did you specify a keyboard?")
CLI: add support for list_keymaps List all the available keymaps for a given keyboard 2019-10-08 21:50:21 +02:00			`"""List the keymaps for a specific keyboard`
			`"""`
			`from milc import cli`
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 19:07:22 +02:00			`import qmk.keymap`
			`from qmk.errors import NoSuchKeyboardError`
Major update to work better with revisions Find the community keymaps supported by each revision. 2019-10-09 10:14:53 +02: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 21:54:21 +01: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 20:53:18 +02: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 21:50:21 +02:00			`@cli.subcommand("List the keymaps for a specific keyboard")`
			`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 19:07:22 +02:00			`try:`
Drop bs4 dependency, update docs, minor improvements 2019-10-24 20:33:58 +02: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 19:07:22 +02: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 12:36:41 +01: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 19:07:22 +02:00			`except NoSuchKeyboardError as e:`
Drop bs4 dependency, update docs, minor improvements 2019-10-24 20:33:58 +02: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 12:36:41 +01:00			`except TypeError:`
			`cli.echo("{fg_red}Something went wrong. Did you specify a keyboard?")`