From 8c0198334c5a76b93530d6edd9b11ea99ea40018 Mon Sep 17 00:00:00 2001
From: Erovia <Erovia@users.noreply.github.com>
Date: Sun, 27 Mar 2022 21:28:36 +0100
Subject: CLI: Lint non-data driven macros in info.json (#16739)

* CLI: Lint non-data driven macros in info.json

Macros in info.json should either have the "matrix" key with the matrix
data or should should be also present in <keyboard>.h

* Add verification of matrix data

* Use generic '<keyboard>.h' in output

* Add keyboard name to output

* Make C layout macro finding more robust

The old code missed C macros if they had whitespace between '#' and
'define' or had whitespace before '#'.
---
 lib/python/qmk/c_parse.py  | 3 ++-
 lib/python/qmk/cli/lint.py | 7 +++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

(limited to 'lib/python/qmk')

diff --git a/lib/python/qmk/c_parse.py b/lib/python/qmk/c_parse.py
index e7d44a514f..72be690019 100644
--- a/lib/python/qmk/c_parse.py
+++ b/lib/python/qmk/c_parse.py
@@ -10,6 +10,7 @@ from qmk.comment_remover import comment_remover
 default_key_entry = {'x': -1, 'y': 0, 'w': 1}
 single_comment_regex = re.compile(r'\s+/[/*].*$')
 multi_comment_regex = re.compile(r'/\*(.|\n)*?\*/', re.MULTILINE)
+layout_macro_define_regex = re.compile(r'^#\s*define')
 
 
 def strip_line_comment(string):
@@ -51,7 +52,7 @@ def find_layouts(file):
     file_contents = file_contents.replace('\\\n', '')
 
     for line in file_contents.split('\n'):
-        if line.startswith('#define') and '(' in line and 'LAYOUT' in line:
+        if layout_macro_define_regex.match(line.lstrip()) and '(' in line and 'LAYOUT' in line:
             # We've found a LAYOUT macro
             macro_name, layout, matrix = _parse_layout_macro(line.strip())
 
diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py
index 96593ed69b..af057b4110 100644
--- a/lib/python/qmk/cli/lint.py
+++ b/lib/python/qmk/cli/lint.py
@@ -116,6 +116,13 @@ def lint(cli):
             if not keymap_check(kb, cli.config.lint.keymap):
                 ok = False
 
+        # Check if all non-data driven macros exist in <keyboard.h>
+        for layout, data in keyboard_info['layouts'].items():
+            # Matrix data should be a list with exactly two integers: [0, 1]
+            if not data['c_macro'] and not all('matrix' in key_data.keys() or len(key_data) == 2 or all(isinstance(n, int) for n in key_data) for key_data in data['layout']):
+                cli.log.error(f'{kb}: "{layout}" has no "matrix" definition in either "info.json" or "<keyboard>.h"!')
+                ok = False
+
         # Report status
         if not ok:
             failed.append(kb)
-- 
cgit v1.2.3