summaryrefslogtreecommitdiff
path: root/data/mappings
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-08-06 22:37:40 +1000
committerGitHub <noreply@github.com>2022-08-06 22:37:40 +1000
commit37345e2ace56e1ea17e0ab6b4df3af81f437ae79 (patch)
treee9c91c998377b98e6b9dc8d03b50193e58bf7061 /data/mappings
parent0ff8c4f6fd8cce95d9e96060121208f85b4d02cd (diff)
Provide users with replacements for deprecated/invalid functionality where applicable (#17604)
Diffstat (limited to 'data/mappings')
-rw-r--r--data/mappings/info_config.json3
-rw-r--r--data/mappings/info_rules.json5
2 files changed, 5 insertions, 3 deletions
diff --git a/data/mappings/info_config.json b/data/mappings/info_config.json
index 5f0d903bd7..7ff05918e9 100644
--- a/data/mappings/info_config.json
+++ b/data/mappings/info_config.json
@@ -9,6 +9,7 @@
# warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
# deprecated: Default `false`. Set to `true` to turn on warning when a value exists
# invalid: Default `false`. Set to `true` to generate errors when a value exists
+ # replace_with: use with a key marked deprecated or invalid to designate a replacement
"AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
"BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
"BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
@@ -108,6 +109,6 @@
"NO_ACTION_MACRO": {"info_key": "_invalid.no_action_macro", "invalid": true},
"NO_ACTION_FUNCTION": {"info_key": "_invalid.no_action_function", "invalid": true},
"DESCRIPTION": {"info_key": "_invalid.usb_description", "invalid": true},
- "DEBOUNCING_DELAY": {"info_key": "_invalid.debouncing_delay", "invalid": true},
+ "DEBOUNCING_DELAY": {"info_key": "_invalid.debouncing_delay", "invalid": true, replace_with: "DEBOUNCE"},
"PREVENT_STUCK_MODIFIERS": {"info_key": "_invalid.prevent_stuck_mods", "invalid": true},
}
diff --git a/data/mappings/info_rules.json b/data/mappings/info_rules.json
index d4eec37ba0..93de321ab1 100644
--- a/data/mappings/info_rules.json
+++ b/data/mappings/info_rules.json
@@ -9,6 +9,7 @@
# warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
# deprecated: Default `false`. Set to `true` to turn on warning when a value exists
# invalid: Default `false`. Set to `true` to generate errors when a value exists
+ # replace_with: use with a key marked deprecated or invalid to designate a replacement
"BOARD": {"info_key": "board"},
"BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
"BLUETOOTH": {"info_key": "bluetooth.driver"},
@@ -29,7 +30,7 @@
"WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"},
# Items we want flagged in lint
- "CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true},
- "CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true},
+ "CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
+ "CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
"VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true},
}