megamanmalte/qmk_firmware
0
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

MILC: Use dashes instead of underscores for subcommands

Browse source 
The subcommand functions' name follows the Python convention of using
snake case, but looks odd on the command line.
Fix it by converting underscores to dashes, eg.: list_keyboards ->
list-keyboards.
This commit is contained in:
Erovia 2019-10-13 20:23:11 +02:00 committed by skullydazed
parent 4da9d2ef6f
commit a5a31a5fc0
3 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/cli.md
View file

@ -125,14 +125,14 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor qmk doctor
``` ```
## `qmk list_keyboards` ## `qmk list-keyboards`
This command lists all the keyboards currently defined in `qmk_firmware` This command lists all the keyboards currently defined in `qmk_firmware`
**Usage**: **Usage**:
``` ```
qmk list_keyboards qmk list-keyboards
``` ```
## `qmk new-keymap` ## `qmk new-keymap`

7
lib/python/milc.py
View file

@ -429,11 +429,12 @@ class MILC(object):
self.arg_only.append(arg_name) self.arg_only.append(arg_name)
del kwargs['arg_only'] del kwargs['arg_only']
name = handler.__name__.replace("_", "-")
if handler is self._entrypoint: if handler is self._entrypoint:
self.add_argument(*args, **kwargs) self.add_argument(*args, **kwargs)
elif handler.__name__ in self.subcommands: elif name in self.subcommands:
self.subcommands[handler.__name__].add_argument(*args, **kwargs) self.subcommands[name].add_argument(*args, **kwargs)
else: else:
raise RuntimeError('Decorated function is not entrypoint or subcommand!') raise RuntimeError('Decorated function is not entrypoint or subcommand!')
@ -599,7 +600,7 @@ class MILC(object):
self.add_subparsers() self.add_subparsers()
if not name: if not name:
name = handler.__name__ name = handler.__name__.replace("_", "-")
self.acquire_lock() self.acquire_lock()
kwargs['help'] = description kwargs['help'] = description

2
lib/python/qmk/tests/test_cli_commands.py
View file

@ -40,7 +40,7 @@ def test_pyformat():
def test_list_keyboards(): def test_list_keyboards():
result = check_subcommand('list_keyboards') result = check_subcommand('list-keyboards')
assert result.returncode == 0 assert result.returncode == 0
# check to see if a known keyboard is returned # check to see if a known keyboard is returned
# this will fail if handwired/onekey/pytest is removed # this will fail if handwired/onekey/pytest is removed