diff options
author | Ryan <fauxpark@gmail.com> | 2020-12-21 01:46:01 +1100 |
---|---|---|
committer | Drashna Jael're <drashna@live.com> | 2021-01-12 22:46:09 -0800 |
commit | 17cf1b1a8a6e971a7a0b809ea427178f51c18a70 (patch) | |
tree | d90bbb30de7d19151011192c0c5f647f90869a3b /lib/python/qmk | |
parent | 1309bca30bb23752ac5aa92ec052f2485f41e5ec (diff) |
Doctor: add check for .git folder (#11208)
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'lib/python/qmk')
-rwxr-xr-x | lib/python/qmk/cli/doctor.py | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/doctor.py b/lib/python/qmk/cli/doctor.py index 25e2e239cb..ea1113c645 100755 --- a/lib/python/qmk/cli/doctor.py +++ b/lib/python/qmk/cli/doctor.py @@ -154,6 +154,17 @@ def check_submodules(): return CheckStatus.OK +def check_git_repo(): + """Checks that the .git directory exists inside QMK_HOME. + + This is a decent enough indicator that the qmk_firmware directory is a + proper Git repository, rather than a .zip download from GitHub. + """ + dot_git_dir = QMK_FIRMWARE / '.git' + + return CheckStatus.OK if dot_git_dir.is_dir() else CheckStatus.WARNING + + def check_udev_rules(): """Make sure the udev rules look good. """ @@ -338,6 +349,13 @@ def doctor(cli): cli.log.info('QMK home: {fg_cyan}%s', QMK_FIRMWARE) + # Make sure our QMK home is a Git repo + git_ok = check_git_repo() + + if git_ok == CheckStatus.WARNING: + cli.log.warning("QMK home does not appear to be a Git repository! (no .git folder)") + status = CheckStatus.WARNING + # Make sure the basic CLI tools we need are available and can be executed. bin_ok = check_binaries() |