diff options
Diffstat (limited to 'lib/python/qmk/cli')
| -rw-r--r-- | lib/python/qmk/cli/lint.py | 31 | 
1 files changed, 31 insertions, 0 deletions
| diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py index e2c76e4465..484ddb5bd9 100644 --- a/lib/python/qmk/cli/lint.py +++ b/lib/python/qmk/cli/lint.py @@ -1,5 +1,6 @@  """Command to look over a keyboard/keymap and check for common mistakes.  """ +from dotty_dict import dotty  from pathlib import Path  from milc import cli @@ -11,6 +12,7 @@ from qmk.keymap import locate_keymap, list_keymaps  from qmk.path import keyboard  from qmk.git import git_get_ignored_files  from qmk.c_parse import c_source_files, preprocess_c_file +from qmk.json_schema import json_load  CHIBIOS_CONF_CHECKS = ['chconf.h', 'halconf.h', 'mcuconf.h', 'board.h']  INVALID_KB_FEATURES = set(['encoder_map', 'dip_switch_map', 'combo', 'tap_dance', 'via']) @@ -214,6 +216,32 @@ def _rules_mk_assignment_only(rules_mk):      return errors +def _handle_duplicating_code_defaults(kb, info): +    def _collect_dotted_output(kb_info_json, prefix=''): +        """Print the info.json in a plain text format with dot-joined keys. +        """ +        for key in sorted(kb_info_json): +            new_prefix = f'{prefix}.{key}' if prefix else key + +            if isinstance(kb_info_json[key], dict): +                yield from _collect_dotted_output(kb_info_json[key], new_prefix) +            elif isinstance(kb_info_json[key], list): +                # TODO: handle non primitives? +                yield (new_prefix, kb_info_json[key]) +            else: +                yield (new_prefix, kb_info_json[key]) + +    defaults_map = json_load(Path('data/mappings/info_defaults.hjson')) +    dotty_info = dotty(info) + +    for key, v_default in _collect_dotted_output(defaults_map): +        v_info = dotty_info.get(key) +        if v_default == v_info: +            cli.log.warning(f'{kb}: Option "{key}" duplicates default value of "{v_default}"') + +    return True + +  def keymap_check(kb, km):      """Perform the keymap level checks.      """ @@ -266,6 +294,9 @@ def keyboard_check(kb):  # noqa C901      if not _handle_invalid_config(kb, kb_info):          ok = False +    if not _handle_duplicating_code_defaults(kb, kb_info): +        ok = False +      invalid_files = git_get_ignored_files(f'keyboards/{kb}/')      for file in invalid_files:          if 'keymap' in file: | 
