diff options
| -rw-r--r-- | build_json.mk | 2 | ||||
| -rw-r--r-- | docs/cli.md | 4 | ||||
| -rw-r--r-- | docs/ja/cli.md | 4 | ||||
| -rw-r--r-- | lib/python/qmk/cli/__init__.py | 1 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/json/keymap.py | 46 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/json2c.py | 56 |
6 files changed, 65 insertions, 48 deletions
diff --git a/build_json.mk b/build_json.mk index e04786144..087944cc4 100644 --- a/build_json.mk +++ b/build_json.mk | |||
| @@ -23,4 +23,4 @@ endif | |||
| 23 | 23 | ||
| 24 | # Generate the keymap.c | 24 | # Generate the keymap.c |
| 25 | $(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON) | 25 | $(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON) |
| 26 | bin/qmk json-keymap --quiet --output $(KEYMAP_C) $(KEYMAP_JSON) | 26 | bin/qmk json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON) |
diff --git a/docs/cli.md b/docs/cli.md index eda365d87..61f838536 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
| @@ -231,14 +231,14 @@ Check your environment and report problems only: | |||
| 231 | 231 | ||
| 232 | qmk doctor -n | 232 | qmk doctor -n |
| 233 | 233 | ||
| 234 | ## `qmk json-keymap` | 234 | ## `qmk json2c` |
| 235 | 235 | ||
| 236 | Creates a keymap.c from a QMK Configurator export. | 236 | Creates a keymap.c from a QMK Configurator export. |
| 237 | 237 | ||
| 238 | **Usage**: | 238 | **Usage**: |
| 239 | 239 | ||
| 240 | ``` | 240 | ``` |
| 241 | qmk json-keymap [-o OUTPUT] filename | 241 | qmk json2c [-o OUTPUT] filename |
| 242 | ``` | 242 | ``` |
| 243 | 243 | ||
| 244 | ## `qmk kle2json` | 244 | ## `qmk kle2json` |
diff --git a/docs/ja/cli.md b/docs/ja/cli.md index 4b1f5da36..e0bee35a6 100644 --- a/docs/ja/cli.md +++ b/docs/ja/cli.md | |||
| @@ -215,14 +215,14 @@ qmk doctor [-y] [-n] | |||
| 215 | 215 | ||
| 216 | qmk doctor -n | 216 | qmk doctor -n |
| 217 | 217 | ||
| 218 | ## `qmk json-keymap` | 218 | ## `qmk json2c` |
| 219 | 219 | ||
| 220 | QMK Configurator からエクスポートしたものから keymap.c を生成します。 | 220 | QMK Configurator からエクスポートしたものから keymap.c を生成します。 |
| 221 | 221 | ||
| 222 | **使用法**: | 222 | **使用法**: |
| 223 | 223 | ||
| 224 | ``` | 224 | ``` |
| 225 | qmk json-keymap [-o OUTPUT] filename | 225 | qmk json2c [-o OUTPUT] filename |
| 226 | ``` | 226 | ``` |
| 227 | 227 | ||
| 228 | ## `qmk kle2json` | 228 | ## `qmk kle2json` |
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py index 72ee38f56..5149a6215 100644 --- a/lib/python/qmk/cli/__init__.py +++ b/lib/python/qmk/cli/__init__.py | |||
| @@ -10,6 +10,7 @@ from . import doctor | |||
| 10 | from . import flash | 10 | from . import flash |
| 11 | from . import hello | 11 | from . import hello |
| 12 | from . import json | 12 | from . import json |
| 13 | from . import json2c | ||
| 13 | from . import list | 14 | from . import list |
| 14 | from . import kle2json | 15 | from . import kle2json |
| 15 | from . import new | 16 | from . import new |
diff --git a/lib/python/qmk/cli/json/keymap.py b/lib/python/qmk/cli/json/keymap.py index c2b7dde7a..6e25b7862 100755 --- a/lib/python/qmk/cli/json/keymap.py +++ b/lib/python/qmk/cli/json/keymap.py | |||
| @@ -1,56 +1,16 @@ | |||
| 1 | """Generate a keymap.c from a configurator export. | 1 | """Generate a keymap.c from a configurator export. |
| 2 | """ | 2 | """ |
| 3 | import json | ||
| 4 | from pathlib import Path | 3 | from pathlib import Path |
| 5 | 4 | ||
| 6 | from milc import cli | 5 | from milc import cli |
| 7 | 6 | ||
| 8 | import qmk.keymap | ||
| 9 | import qmk.path | ||
| 10 | |||
| 11 | 7 | ||
| 12 | @cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to') | 8 | @cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to') |
| 13 | @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages") | 9 | @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages") |
| 14 | @cli.argument('filename', arg_only=True, help='Configurator JSON file') | 10 | @cli.argument('filename', arg_only=True, help='Configurator JSON file') |
| 15 | @cli.subcommand('Creates a keymap.c from a QMK Configurator export.') | 11 | @cli.subcommand('Creates a keymap.c from a QMK Configurator export.') |
| 16 | def json_keymap(cli): | 12 | def json_keymap(cli): |
| 17 | """Generate a keymap.c from a configurator export. | 13 | """Renamed to `qmk json2c`. |
| 18 | |||
| 19 | 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. | ||
| 20 | """ | 14 | """ |
| 21 | cli.args.filename = qmk.path.normpath(cli.args.filename) | 15 | cli.log.error('This command has been renamed to `qmk json2c`.') |
| 22 | 16 | exit(1) | |
| 23 | # Error checking | ||
| 24 | if not cli.args.filename.exists(): | ||
| 25 | cli.log.error('JSON file does not exist!') | ||
| 26 | cli.print_usage() | ||
| 27 | exit(1) | ||
| 28 | |||
| 29 | if str(cli.args.filename) == '-': | ||
| 30 | # TODO(skullydazed/anyone): Read file contents from STDIN | ||
| 31 | cli.log.error('Reading from STDIN is not (yet) supported.') | ||
| 32 | cli.print_usage() | ||
| 33 | exit(1) | ||
| 34 | |||
| 35 | # Environment processing | ||
| 36 | if cli.args.output == ('-'): | ||
| 37 | cli.args.output = None | ||
| 38 | |||
| 39 | # Parse the configurator json | ||
| 40 | with cli.args.filename.open('r') as fd: | ||
| 41 | user_keymap = json.load(fd) | ||
| 42 | |||
| 43 | # Generate the keymap | ||
| 44 | keymap_c = qmk.keymap.generate(user_keymap['keyboard'], user_keymap['layout'], user_keymap['layers']) | ||
| 45 | |||
| 46 | if cli.args.output: | ||
| 47 | cli.args.output.parent.mkdir(parents=True, exist_ok=True) | ||
| 48 | if cli.args.output.exists(): | ||
| 49 | cli.args.output.replace(cli.args.output.name + '.bak') | ||
| 50 | cli.args.output.write_text(keymap_c) | ||
| 51 | |||
| 52 | if not cli.args.quiet: | ||
| 53 | cli.log.info('Wrote keymap to %s.', cli.args.output) | ||
| 54 | |||
| 55 | else: | ||
| 56 | print(keymap_c) | ||
diff --git a/lib/python/qmk/cli/json2c.py b/lib/python/qmk/cli/json2c.py new file mode 100755 index 000000000..9abf03d8a --- /dev/null +++ b/lib/python/qmk/cli/json2c.py | |||
| @@ -0,0 +1,56 @@ | |||
| 1 | """Generate a keymap.c from a configurator export. | ||
| 2 | """ | ||
| 3 | import json | ||
| 4 | from pathlib import Path | ||
| 5 | |||
| 6 | from milc import cli | ||
| 7 | |||
| 8 | import qmk.keymap | ||
| 9 | import qmk.path | ||
| 10 | |||
| 11 | |||
| 12 | @cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to') | ||
| 13 | @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages") | ||
| 14 | @cli.argument('filename', arg_only=True, help='Configurator JSON file') | ||
| 15 | @cli.subcommand('Creates a keymap.c from a QMK Configurator export.') | ||
| 16 | def json2c(cli): | ||
| 17 | """Generate a keymap.c from a configurator export. | ||
| 18 | |||
| 19 | 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. | ||
| 20 | """ | ||
| 21 | cli.args.filename = qmk.path.normpath(cli.args.filename) | ||
| 22 | |||
| 23 | # Error checking | ||
| 24 | if not cli.args.filename.exists(): | ||
| 25 | cli.log.error('JSON file does not exist!') | ||
| 26 | cli.print_usage() | ||
| 27 | exit(1) | ||
| 28 | |||
| 29 | if str(cli.args.filename) == '-': | ||
| 30 | # TODO(skullydazed/anyone): Read file contents from STDIN | ||
| 31 | cli.log.error('Reading from STDIN is not (yet) supported.') | ||
| 32 | cli.print_usage() | ||
| 33 | exit(1) | ||
| 34 | |||
| 35 | # Environment processing | ||
| 36 | if cli.args.output == ('-'): | ||
| 37 | cli.args.output = None | ||
| 38 | |||
| 39 | # Parse the configurator json | ||
| 40 | with cli.args.filename.open('r') as fd: | ||
| 41 | user_keymap = json.load(fd) | ||
| 42 | |||
| 43 | # Generate the keymap | ||
| 44 | keymap_c = qmk.keymap.generate(user_keymap['keyboard'], user_keymap['layout'], user_keymap['layers']) | ||
| 45 | |||
| 46 | if cli.args.output: | ||
| 47 | cli.args.output.parent.mkdir(parents=True, exist_ok=True) | ||
| 48 | if cli.args.output.exists(): | ||
| 49 | cli.args.output.replace(cli.args.output.name + '.bak') | ||
| 50 | cli.args.output.write_text(keymap_c) | ||
| 51 | |||
| 52 | if not cli.args.quiet: | ||
| 53 | cli.log.info('Wrote keymap to %s.', cli.args.output) | ||
| 54 | |||
| 55 | else: | ||
| 56 | print(keymap_c) | ||
