diff options
| author | QMK Bot <[email protected]> | 2022-12-08 16:31:37 +0000 | 
|---|---|---|
| committer | QMK Bot <[email protected]> | 2022-12-08 16:31:37 +0000 | 
| commit | 5a2ed77a086386dae7c10eed7bda54253dc8177e (patch) | |
| tree | f231e745f0e27d9e731941340391e497ac0b0699 /lib/python | |
| parent | c2aa0f67ec5363e1b2d6cf287947123a2c7c3aa6 (diff) | |
| parent | 6e6039995beebcaf0126d90db344728f0b8de827 (diff) | |
| download | qmk_firmware-5a2ed77a086386dae7c10eed7bda54253dc8177e.tar.gz qmk_firmware-5a2ed77a086386dae7c10eed7bda54253dc8177e.zip | |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'lib/python')
| -rw-r--r-- | lib/python/qmk/cli/lint.py | 34 | 
1 files changed, 34 insertions, 0 deletions
| diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py index 6b077c250f..c67809a697 100644 --- a/lib/python/qmk/cli/lint.py +++ b/lib/python/qmk/cli/lint.py @@ -10,6 +10,7 @@ from qmk.keyboard import keyboard_completer, list_keyboards  from qmk.keymap import locate_keymap, list_keymaps  from qmk.path import is_keyboard, keyboard  from qmk.git import git_get_ignored_files +from qmk.c_parse import c_source_files  def _list_defaultish_keymaps(kb): @@ -25,6 +26,29 @@ def _list_defaultish_keymaps(kb):      return keymaps +def _get_code_files(kb, km=None): +    """Return potential keyboard/keymap code files +    """ +    search_path = locate_keymap(kb, km).parent if km else keyboard(kb) + +    code_files = [] +    for file in c_source_files([search_path]): +        # Ignore keymaps when only globing keyboard files +        if not km and 'keymaps' in file.parts: +            continue +        code_files.append(file) + +    return code_files + + +def _has_license(file): +    """Check file has a license header +    """ +    # Crude assumption that first line of license header is a comment +    fline = open(file).readline().rstrip() +    return fline.startswith(("/*", "//")) + +  def _handle_json_errors(kb, info):      """Convert any json errors into lint errors      """ @@ -92,6 +116,11 @@ def keymap_check(kb, km):          cli.log.error(f'{kb}/{km}: The file "{file}" should not exist!')          ok = False +    for file in _get_code_files(kb, km): +        if not _has_license(file): +            cli.log.error(f'{kb}/{km}: The file "{file}" does not have a license header!') +            ok = False +      return ok @@ -119,6 +148,11 @@ def keyboard_check(kb):          cli.log.error(f'{kb}: The file "{file}" should not exist!')          ok = False +    for file in _get_code_files(kb): +        if not _has_license(file): +            cli.log.error(f'{kb}: The file "{file}" does not have a license header!') +            ok = False +      return ok | 
