diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a896c3b..7065a88 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -143,7 +143,7 @@ repos: - --fix - --python=.venv/ additional_dependencies: - - ty==0.0.38 + - ty==0.0.39 types: - python - repo: https://github.com/asottile/pyupgrade @@ -162,7 +162,7 @@ repos: hooks: - id: actionlint - repo: https://github.com/crate-ci/typos - rev: v1.46.2 + rev: v1.46.3 hooks: - id: typos exclude_types: diff --git a/dev_tools/check_jira_reference_in_todo.py b/dev_tools/check_jira_reference_in_todo.py index d64380a..e97a6b9 100644 --- a/dev_tools/check_jira_reference_in_todo.py +++ b/dev_tools/check_jira_reference_in_todo.py @@ -5,7 +5,7 @@ import re import sys -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, TypedDict from dev_tools.utils.git_hook_utils import parse_arguments @@ -14,6 +14,14 @@ from pathlib import Path +class IncorrectTodo(TypedDict): + """Incorrect Todo.""" + + file_path: Path + line_number: int + line_content: str + + def line_has_incorrect_todo(line: str) -> bool: return ( not re.compile(r"^.*(?=TODO\([A-Z]+\-[0-9]+\)\:).*").search(line) @@ -22,8 +30,8 @@ def line_has_incorrect_todo(line: str) -> bool: ) -def find_files_with_incorrect_jira_reference_in_todo(files: list[Path]) -> list[dict[str, object]]: - incorrect_files = [] +def find_files_with_incorrect_jira_reference_in_todo(files: list[Path]) -> list[IncorrectTodo]: + incorrect_files: list[IncorrectTodo] = [] for file in files: lines = file.read_text(errors="ignore").splitlines() for line_number, line in enumerate(lines, 1):