Skip to content

Commit

Permalink
lint-hotkeys: Lint the validity of help categories.
Browse files Browse the repository at this point in the history
To check for typos.
  • Loading branch information
Niloth-p committed Jun 15, 2024
1 parent e5e9010 commit 4afff89
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion tools/lint-hotkeys
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ def lint_hotkeys_file() -> None:
existing OUTPUT_FILE
"""
hotkeys_file_string = get_hotkeys_file_string()
error_flag = 0 if is_every_key_category_valid() else 1
# To lint keys description
error_flag = 0
categories = read_help_categories()
for action in HELP_CATEGORIES:
check_duplicate_keys_list: List[str] = []
Expand Down Expand Up @@ -91,6 +91,24 @@ def generate_hotkeys_file() -> None:
print(f"Hot Keys list saved in {OUTPUT_FILE}")


def is_every_key_category_valid() -> bool:
"""
Check for typos in key categories in KEYS_FILE
"""
error_flag = False
for key, binding in KEY_BINDINGS.items():
key_category = binding.get("key_category")
if key_category not in HELP_CATEGORIES:
print(
f"Invalid key_category '{key_category}' for key '{key}'."
f" Choose a category from:\n{', '.join(HELP_CATEGORIES.keys())}\n"
)
error_flag = True
if not error_flag:
print("All key bindings have valid categories.")
return not error_flag


def get_hotkeys_file_string() -> str:
"""
Construct string in form for output to OUTPUT_FILE based on help text
Expand Down

0 comments on commit 4afff89

Please sign in to comment.