xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-15 10:10:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: extract TODO formatting functions and simplify data structure

Browse Source
This commit is contained in:
mrT23
2025-06-21 09:20:43 +03:00
parent 37ef4bad8f
commit 7c02678ba5
3 changed files with 54 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
pr_agent/settings/pr_reviewer_prompts.toml
View File

@ -74,9 +74,9 @@ class KeyIssuesComponentLink(BaseModel):
{%- if require_todo_scan %}
class TodoSection(BaseModel):
relevant_file: str = Field(description="The file containing the TODO comment")
line_range: Tuple[int, int] = Field(description="Start and end line numbers of the TODO comment (inclusive). Must be a tuple of two integers, e.g., (7, 7) for a single line or (7, 10) for a range. Do not use list format [7, 7].")
content: str = Field(description="The content of the TODO comment. Only include actual TODO comments within code comments (e.g., lines starting with '#', '//', '/*', '<!--'). Remove leading 'TODO' prefixes. Include lines like '# TODO', even if empty after prefix removal. Exclude TODOs outside comments or without appropriate prefixes. Use | block style only when the line range covers multiple lines (e.g., (7, 10)).")
relevant_file: str = Field(description="The full path of the file containing the TODO comment")
line_number: int = Field(description="The line number where the TODO comment starts")
content: str = Field(description="The content of the TODO comment. Only include actual TODO comments within code comments (e.g., comments starting with '#', '//', '/*', '<!--', ...). Remove leading 'TODO' prefixes. If more than 10 words, summarize the TODO comment to a single short sentence up to 10 words.")
{%- endif %}
{%- if related_tickets %}
@ -110,8 +110,7 @@ class Review(BaseModel):
security_concerns: str = Field(description="Does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? Answer 'No' (without explaining why) if there are no possible issues. If there are security concerns or issues, start your answer with a short header, such as: 'Sensitive information exposure: ...', 'SQL injection: ...', etc. Explain your answer. Be specific and give examples if possible")
{%- endif %}
{%- if require_todo_scan %}
todo_sections: Union[List[TodoSection], str] = Field(description="A list of TODO comments found in the PR code. Return 'No' (as a string) if there are no TODO comments in the PR"
todo_summary: str = Field(description="Up to 6 words summarizing the functional areas of the TODO comments found in the code.")
todo_sections: Union[List[TodoSection]] = Field(description="A list of TODO comments found in the PR code. Return 'No' (as a string) if there are no TODO comments in the PR")
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split: List[SubPR] = Field(min_items=0, max_items=3, description="Can this PR, which contains {{ num_pr_files }} changed files in total, be divided into smaller sub-PRs with distinct tasks that can be reviewed and merged independently, regardless of the order ? Make sure that the sub-PRs are indeed independent, with no code dependencies between them, and that each sub-PR represent a meaningful independent task. Output an empty list if the PR code does not need to be split.")
@ -162,8 +161,6 @@ review:
{%- if require_todo_scan %}
todo_sections: |
No
todo_summary: |
...
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split:
@ -286,8 +283,6 @@ review:
{%- if require_todo_scan %}
todo_sections: |
No
todo_summary: |
...
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split: