`qmk info`: add warning when layout is offset (#20070)

This commit is contained in:
Ryan 2023-03-10 07:27:04 +11:00 committed by GitHub
parent 65f380c768
commit 76fb534269
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions

View File

@ -71,6 +71,16 @@ def _validate(keyboard, info_data):
if len(layouts) == 0 or all(not layout.get('json_layout', False) for layout in layouts.values()):
_log_error(info_data, 'No LAYOUTs defined! Need at least one layout defined in info.json.')
# Warn if physical positions are offset (at least one key should be at x=0, and at least one key at y=0)
for layout_name, layout_data in layouts.items():
offset_x = min([k['x'] for k in layout_data['layout']])
if offset_x > 0:
_log_warning(info_data, f'Layout "{layout_name}" is offset on X axis by {offset_x}')
offset_y = min([k['y'] for k in layout_data['layout']])
if offset_y > 0:
_log_warning(info_data, f'Layout "{layout_name}" is offset on Y axis by {offset_y}')
# Providing only LAYOUT_all "because I define my layouts in a 3rd party tool"
if len(layouts) == 1 and 'LAYOUT_all' in layouts:
_log_warning(info_data, '"LAYOUT_all" should be "LAYOUT" unless additional layouts are provided.')