info_rules.hjson (4107B)
1 // This file maps keys between `rules.mk` and `info.json`. It is used by QMK 2 // to correctly and consistently map back and forth between the two systems. 3 { 4 // Format: 5 // <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]} 6 // value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping", "str", "raw" 7 // to_json: Default `true`. Set to `false` to exclude this mapping from info.json 8 // to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk 9 // warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places 10 // deprecated: Default `false`. Set to `true` to turn on warning when a value exists 11 // invalid: Default `false`. Set to `true` to generate errors when a value exists 12 // replace_with: use with a key marked deprecated or invalid to designate a replacement 13 14 "AUDIO_DRIVER": {"info_key": "audio.driver"}, 15 "BACKLIGHT_DRIVER": {"info_key": "backlight.driver"}, 16 "BATTERY_DRIVER": {"info_key": "battery.driver"}, 17 "BLUETOOTH_DRIVER": {"info_key": "bluetooth.driver"}, 18 "BOARD": {"info_key": "board"}, 19 "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false}, 20 "BOOTMAGIC_ENABLE": {"info_key": "bootmagic.enabled", "value_type": "bool"}, 21 "CAPS_WORD_ENABLE": {"info_key": "caps_word.enabled", "value_type": "bool"}, 22 "DIP_SWITCH_ENABLE": {"info_key": "dip_switch.enabled", "value_type": "bool"}, 23 "DEBOUNCE_TYPE": {"info_key": "build.debounce_type"}, 24 "EEPROM_DRIVER": {"info_key": "eeprom.driver"}, 25 "ENCODER_ENABLE": {"info_key": "encoder.enabled", "value_type": "bool"}, 26 "ENCODER_DRIVER": {"info_key": "encoder.driver"}, 27 "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"}, 28 "HAPTIC_DRIVER": {"info_key": "haptic.driver"}, 29 "JOYSTICK_DRIVER": {"info_key": "joystick.driver"}, 30 "JOYSTICK_ENABLE": {"info_key": "joystick.enabled", "value_type": "bool"}, 31 "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"}, 32 "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"}, 33 "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"}, 34 "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"}, 35 "MCU": {"info_key": "processor", "warn_duplicate": false}, 36 "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"}, 37 "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"}, 38 "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"}, 39 "PIN_COMPATIBLE": {"info_key": "pin_compatible"}, 40 "PLATFORM_KEY": {"info_key": "platform_key", "to_json": false}, 41 "PS2_DRIVER": {"info_key": "ps2.driver"}, 42 "PS2_ENABLE": {"info_key": "ps2.enabled", "value_type": "bool"}, 43 "PS2_MOUSE_ENABLE": {"info_key": "ps2.mouse_enabled", "value_type": "bool"}, 44 "RGB_MATRIX_DRIVER": {"info_key": "rgb_matrix.driver"}, 45 "RGBLIGHT_DRIVER": {"info_key": "rgblight.driver"}, 46 "SECURE_ENABLE": {"info_key": "secure.enabled", "value_type": "bool"}, 47 "SERIAL_DRIVER": {"info_key": "split.serial.driver"}, 48 "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"}, 49 "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false}, 50 "STENO_ENABLE": {"info_key": "stenography.enabled", "value_type": "bool"}, 51 "STENO_PROTOCOL": {"info_key": "stenography.protocol"}, 52 "USB_WAIT_FOR_ENUMERATION": {"info_key": "usb.wait_for_enumeration", "value_type": "bool"}, 53 "WEAR_LEVELING_DRIVER": {"info_key": "eeprom.wear_leveling.driver"}, 54 "WS2812_DRIVER": {"info_key": "ws2812.driver"}, 55 56 // Items we want flagged in lint 57 "CTPC": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"}, 58 "CONVERT_TO_PROTON_C": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"}, 59 "DEFAULT_FOLDER": {"info_key": "_invalid.default_folder", "invalid": true}, 60 "VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true} 61 }