-
-
Notifications
You must be signed in to change notification settings - Fork 40k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a lot more data to info.json #13366
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
qmk info -h
seems to imply qmk info -f
defaults to friendly
, but this doesn't work in practice:
noroadsleft ~/qmk_firmware/keyboards/clueboard/66/rev4 (pr/13366)
$ qmk info -f
usage: qmk.exe info [-h] [-r] [--ascii] [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
qmk.exe info: error: argument -f/--format: expected one argument
noroadsleft ~/qmk_firmware/keyboards/clueboard/66/rev4 (pr/13366)
$ qmk info -h
usage: qmk.exe info [-h] [-r] [--ascii] [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
optional arguments:
-h, --help show this help message and exit
-r, --rules-mk Render the parsed values of the keyboard's rules.mk file.
--ascii Render layout box drawings in ASCII only.
-f FORMAT, --format FORMAT
Format to display the data in (friendly, text, json) (Default: friendly).
-m, --matrix Render the layouts with matrix information.
-l, --layouts Render the layouts.
-km KEYMAP, --keymap KEYMAP
Show the layers for a JSON keymap too.
-kb KEYBOARD, --keyboard KEYBOARD
Keyboard to show info for.
Specifying friendly
also doesn't seem to do anything:
noroadsleft ~/qmk_firmware/keyboards/clueboard/66/rev4 (pr/13366)
$ qmk info -f friendly
Keyboard Name: Clueboard 66% rev4
Manufacturer: Clueboard
Maintainer: skullydazed
Keyboard Folder: clueboard/66/rev4
Layouts: LAYOUT_66_ansi, LAYOUT_66_iso, LAYOUT_all
Size: 16.5 x 5
Processor: STM32F303
Bootloader: stm32-dfu
Layout aliases: KEYMAP=LAYOUT_all, LAYOUT=LAYOUT_all
Apologies for missing this last week.
You have to supply an argument to
That's working as designed. If you were to override the default output, EG |
6da1573
to
4444661
Compare
7e4b5f0
to
7f18210
Compare
Tests are passing now and it can merge clean. |
22e8b57
to
d940a1e
Compare
I've rebased against develop and fixed a couple new errors that cropped up. |
Adds an argument that instructs qmk generate-info-json to write the output to a file instead of just to the terminal.
Because it was never my intention that one would have to specify a value for the argument that enables writing the file.
Co-authored-by: Nick Brassel <[email protected]>
9c26328
to
0ca7238
Compare
* add some split data to info.json * add tags * add half of config_options.md to info.json * add support for designating master split * sort out split transport and primary * fix bad data in UNUSED_PINS * fixup custom transport * wip * allow for setting split right half keyboard matrix * add SPLIT_USB_DETECT * minor cleanup * fix an erroneous message * rework split.usb_detect * adding missing rgblight vars to info.json * add mouse_key to info.json * add all remaining options from docs/config_options.md * fix audio voices * qmk info: Change text output to use dotted notation * tweak layout output * resolve alias names * break out some functions to make flake8 happy * add a field for bootloader instructions * qmk generate-info-json: add a write-to-file argument Adds an argument that instructs qmk generate-info-json to write the output to a file instead of just to the terminal. * -arg_only, +action Because it was never my intention that one would have to specify a value for the argument that enables writing the file. * Bring qmk generate-info-json inline with other generate commands * pytest fixup * fix esca/getawayvan * fix data driven errors for bpiphany converters * features.force_nkro -> usb.force_nkro * split.primary->split.main * fix esca/getawayvan_f042 * fix the bpiphany converters for real * fix bpiphany/tiger_lily * Apply suggestions from code review Co-authored-by: Nick Brassel <[email protected]> * fix generate-api errors * fix matrix pin extraction for split boards * fix ploopyco/trackball_nano/rev1_001 Co-authored-by: James Young <[email protected]> Co-authored-by: Nick Brassel <[email protected]>
* add some split data to info.json * add tags * add half of config_options.md to info.json * add support for designating master split * sort out split transport and primary * fix bad data in UNUSED_PINS * fixup custom transport * wip * allow for setting split right half keyboard matrix * add SPLIT_USB_DETECT * minor cleanup * fix an erroneous message * rework split.usb_detect * adding missing rgblight vars to info.json * add mouse_key to info.json * add all remaining options from docs/config_options.md * fix audio voices * qmk info: Change text output to use dotted notation * tweak layout output * resolve alias names * break out some functions to make flake8 happy * add a field for bootloader instructions * qmk generate-info-json: add a write-to-file argument Adds an argument that instructs qmk generate-info-json to write the output to a file instead of just to the terminal. * -arg_only, +action Because it was never my intention that one would have to specify a value for the argument that enables writing the file. * Bring qmk generate-info-json inline with other generate commands * pytest fixup * fix esca/getawayvan * fix data driven errors for bpiphany converters * features.force_nkro -> usb.force_nkro * split.primary->split.main * fix esca/getawayvan_f042 * fix the bpiphany converters for real * fix bpiphany/tiger_lily * Apply suggestions from code review Co-authored-by: Nick Brassel <[email protected]> * fix generate-api errors * fix matrix pin extraction for split boards * fix ploopyco/trackball_nano/rev1_001 Co-authored-by: James Young <[email protected]> Co-authored-by: Nick Brassel <[email protected]>
Description
This adds a lot of new information to
info.json
. Besides adding more keyboard metadata we have also added tags! Just add a new top-level key to info.json containing a list of your tags. Example:This also changes the output of
qmk info -f text
to use dot-notation. This will be handy in the future as we add the ability to query based on JSON information.Example qmk info -f text output
Types of Changes
Checklist