Skip to content

Minor improvements in lint hotkeys #1482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Minor improvements in lint hotkeys #1482

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aef8a7f
lint-hotkeys: Add missing '--fix' flag in usage prompt.
Niloth-p Apr 14, 2024
fb09630
lint-hotkeys: Add a docstring.
Niloth-p Apr 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion tools/lint-hotkeys
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ def lint_hotkeys_file() -> None:
else:
print("No hotkeys linting errors")
if not output_file_matches_string(hotkeys_file_string):
print(f"Run './tools/{SCRIPT_NAME}' to update {OUTPUT_FILE_NAME} file")
print(
f"Run './tools/{SCRIPT_NAME} --fix' to update {OUTPUT_FILE_NAME} file"
)
error_flag = 1
sys.exit(error_flag)

Expand Down Expand Up @@ -118,6 +120,10 @@ def get_hotkeys_file_string() -> str:


def output_file_matches_string(hotkeys_file_string: str) -> bool:
"""
Read the content of the existing OUTPUT_FILE as a string
and check if it matches the newly generated hotkeys_file_string
"""
with open(OUTPUT_FILE) as output_file:
content_is_identical = hotkeys_file_string == output_file.read()
if content_is_identical:
Expand Down