summaryrefslogtreecommitdiff
path: root/lib/python/qmk
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2020-03-10 13:51:19 -0700
committerFlorian Didron <fdidron@users.noreply.github.com>2020-06-12 17:00:27 +0900
commitae57cdc97a094d40737d51f4841e48f96a928d71 (patch)
tree68ac6c83450114245dbd9c8e1bda01cca9db72f7 /lib/python/qmk
parent0471dc3d8871348055e4fae4b74fa3cf47baca17 (diff)
Rename qmk json-keymap to qmk json2c (#8372)
Diffstat (limited to 'lib/python/qmk')
-rw-r--r--lib/python/qmk/cli/__init__.py1
-rwxr-xr-xlib/python/qmk/cli/json/keymap.py46
-rwxr-xr-xlib/python/qmk/cli/json2c.py56
3 files changed, 60 insertions, 43 deletions
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index 03831ca3ac..9346a67cbf 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -9,6 +9,7 @@ from . import doctor
from . import flash
from . import hello
from . import json
+from . import json2c
from . import list
from . import kle2json
from . import new
diff --git a/lib/python/qmk/cli/json/keymap.py b/lib/python/qmk/cli/json/keymap.py
index 26894e743d..8ccb4115f9 100755
--- a/lib/python/qmk/cli/json/keymap.py
+++ b/lib/python/qmk/cli/json/keymap.py
@@ -1,56 +1,16 @@
"""Generate a keymap.c from a configurator export.
"""
-import json
from pathlib import Path
from milc import cli
-import qmk.keymap
-import qmk.path
-
@cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to')
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
@cli.argument('filename', arg_only=True, help='Configurator JSON file')
@cli.subcommand('Create a keymap.c from a QMK Configurator export.')
def json_keymap(cli):
- """Generate a keymap.c from a configurator export.
-
- This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
+ """Renamed to `qmk json2c`.
"""
- cli.args.filename = qmk.path.normpath(cli.args.filename)
-
- # Error checking
- if not cli.args.filename.exists():
- cli.log.error('JSON file does not exist!')
- cli.print_usage()
- exit(1)
-
- if str(cli.args.filename) == '-':
- # TODO(skullydazed/anyone): Read file contents from STDIN
- cli.log.error('Reading from STDIN is not (yet) supported.')
- cli.print_usage()
- exit(1)
-
- # Environment processing
- if cli.args.output == ('-'):
- cli.args.output = None
-
- # Parse the configurator json
- with cli.args.filename.open('r') as fd:
- user_keymap = json.load(fd)
-
- # Generate the keymap
- keymap_c = qmk.keymap.generate(user_keymap['keyboard'], user_keymap['layout'], user_keymap['layers'])
-
- if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.name + '.bak')
- cli.args.output.write_text(keymap_c)
-
- if not cli.args.quiet:
- cli.log.info('Wrote keymap to %s.', cli.args.output)
-
- else:
- print(keymap_c)
+ cli.log.error('This command has been renamed to `qmk json2c`.')
+ exit(1)
diff --git a/lib/python/qmk/cli/json2c.py b/lib/python/qmk/cli/json2c.py
new file mode 100755
index 0000000000..9abf03d8a1
--- /dev/null
+++ b/lib/python/qmk/cli/json2c.py
@@ -0,0 +1,56 @@
+"""Generate a keymap.c from a configurator export.
+"""
+import json
+from pathlib import Path
+
+from milc import cli
+
+import qmk.keymap
+import qmk.path
+
+
+@cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to')
+@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
+@cli.argument('filename', arg_only=True, help='Configurator JSON file')
+@cli.subcommand('Creates a keymap.c from a QMK Configurator export.')
+def json2c(cli):
+ """Generate a keymap.c from a configurator export.
+
+ This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
+ """
+ cli.args.filename = qmk.path.normpath(cli.args.filename)
+
+ # Error checking
+ if not cli.args.filename.exists():
+ cli.log.error('JSON file does not exist!')
+ cli.print_usage()
+ exit(1)
+
+ if str(cli.args.filename) == '-':
+ # TODO(skullydazed/anyone): Read file contents from STDIN
+ cli.log.error('Reading from STDIN is not (yet) supported.')
+ cli.print_usage()
+ exit(1)
+
+ # Environment processing
+ if cli.args.output == ('-'):
+ cli.args.output = None
+
+ # Parse the configurator json
+ with cli.args.filename.open('r') as fd:
+ user_keymap = json.load(fd)
+
+ # Generate the keymap
+ keymap_c = qmk.keymap.generate(user_keymap['keyboard'], user_keymap['layout'], user_keymap['layers'])
+
+ if cli.args.output:
+ cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+ if cli.args.output.exists():
+ cli.args.output.replace(cli.args.output.name + '.bak')
+ cli.args.output.write_text(keymap_c)
+
+ if not cli.args.quiet:
+ cli.log.info('Wrote keymap to %s.', cli.args.output)
+
+ else:
+ print(keymap_c)