Merge branch 'main' of github.com:PrashantDixit0/pr-agent

pr_agent/settings/configuration.toml

@@ -62,6 +62,7 @@ include_generated_by_header=true
 [pr_code_suggestions] # /improve #
 num_code_suggestions=4
 summarize = false
+include_improved_code = true
 extra_instructions = ""
 rank_suggestions = false
 # params for '/improve --extended' mode
@@ -78,6 +79,8 @@ docs_style = "Sphinx Style" # "Google Style with Args, Returns, Attributes...etc
 push_changelog_changes=false
 extra_instructions = ""
 
+[pr_analyze] # /analyze #
+
 [pr_config] # /config #
 
 [github]

pr_agent/settings/pr_code_suggestions_prompts.toml

@@ -32,13 +32,13 @@ __old hunk__
 
 Specific instructions:
 - Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
-- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on best practices, code readability, maintainability, enhancments, performance, and other aspects.
+- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on enhancment, best practice, performance, maintainability, and other aspects.
 - Don't suggest to add docstring, type hints, or comments.
 - Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
 - Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
-- For each suggestion, make sure to take into consideration also the context, meaning the lines before and after the relevant code.
 - Provide the exact line numbers range (inclusive) for each suggestion.
 - Assume there is additional relevant code, that is not included in the diff.
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
 
 {%- if extra_instructions %}
@@ -49,65 +49,41 @@ Extra instructions from the user:
 ======
 {%- endif %}
 
+The output must be a YAML object equivalent to type PRCodeSuggestions, according to the following Pydantic definitions:
+=====
+class CodeSuggestion(BaseModel):
+    relevant_file: str = Field(description="the relevant file full path")
+    suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
+    existing_code: str = Field(description="a code snippet, showing the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
+    relevant_lines_start: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion starts (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
+    relevant_lines_end: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion ends (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
+    improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
+    label: str = Field(description="a single label for the suggestion, to help the user understand the suggestion type. For example: 'security', 'bug', 'performance', 'enhancement', 'possible issue', 'best practice', 'maintainability', etc. Other labels are also allowed")
+
+class PRCodeSuggestions(BaseModel):
+    code_suggestions: List[CodeSuggestion]
+=====
 
-You must use the following YAML schema to format your answer:
-```yaml
-Code suggestions:
-  type: array
-  minItems: 1
-  maxItems: {{ num_code_suggestions }}
-  uniqueItems: true
-  items:
-    relevant file:
-      type: string
-      description: the relevant file full path
-    suggestion content:
-      type: string
-      description: |-
-        a concrete suggestion for meaningfully improving the new PR code.
-    existing code:
-      type: string
-      description: |-
-        a code snippet showing the relevant code lines from a '__new hunk__' section.
-        It must be contiguous, correctly formatted and indented, and without line numbers.
-    relevant lines start:
-      type: integer
-      description: |-
-        The relevant line number from a '__new hunk__' section where the suggestion starts (inclusive).
-        Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
-    relevant lines end:
-      type: integer
-      description: |-
-        The relevant line number from a '__new hunk__' section where the suggestion ends (inclusive).
-        Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
-    improved code:
-      type: string
-      description: |-
-        a new code snippet that can be used to replace the relevant lines in '__new hunk__' code.
-        Replacement suggestions should be complete, correctly formatted and indented, and without line numbers.
-```
 
 Example output:
 ```yaml
-Code suggestions:
-- relevant file: |-
+code_suggestions:
+- relevant_file: |-
     src/file1.py
-  suggestion content: |-
+  suggestion_content: |-
     Add a docstring to func1()
-  existing code: |-
+  existing_code: |-
     def func1():
-  relevant lines start: |-
-    12
-  relevant lines end: |-
-    12
-  improved code: |-
+  relevant_lines_start: 12
+  relevant_lines_end: 12
+  improved_code: |-
+    ...
+  label: |-
     ...
-...
 ```
 
 
 Each YAML output MUST be after a newline, indented, with block scalar indicator ('|-').
-Don't repeat the prompt in the answer, and avoid outputting the 'type' and 'description' fields.
 """
 
 user="""PR Info:

pr_agent/settings/pr_description_prompts.toml

@@ -1,10 +1,15 @@
 [pr_description_prompt]
 system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
-Your task is to provide a full description for the PR content - title, type, description, and main files walkthrough.
+{%- if enable_custom_labels %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, description and labels.
+{%- else %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, and description.
+{%- endif %}
 - Focus on the new PR code (lines starting with '+').
 - Keep in mind that the 'Previous title', 'Previous description' and 'Commit messages' sections may be partial, simplistic, non-informative or out of date. Hence, compare them to the PR diff code, and use them only as a reference.
 - The generated title and description should prioritize the most significant changes.
 - If needed, each YAML output should be in block scalar indicator ('|-')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
 {%- if extra_instructions %}
 
@@ -45,43 +50,24 @@ Class FileDescription(BaseModel):
 {%- endif %}
 
 Class PRDescription(BaseModel):
+    type: List[PRType] = Field(description="one or more types that describe the PR content. Return the label value, not the name.")
+{%- if enable_semantic_files_types %}
+    pr_files[List[FileDescription]] = Field(max_items=15, description="a list of the files in the PR, and their changes summary.")
+{%- endif %}
+    description: str = Field(description="an informative and concise description of the PR. Use bullet points. Display first the most significant changes.")
     title: str = Field(description="an informative title for the PR, describing its main theme")
-    type: List[PRType] = Field(description="one or more types that describe the PR type. Return the label value, not the name.")
-    description: str = Field(description="an informative and concise description of the PR. {%- if use_bullet_points %} Use bullet points.{% endif %}")
 {%- if enable_custom_labels %}
     labels: List[Label] =  Field(min_items=0, description="choose the relevant custom labels that describe the PR content, and return their keys. Use the value field of the Label object to better understand the label meaning.")
 {%- endif %}
-{%- if enable_file_walkthrough %}
-    main_files_walkthrough: List[FileWalkthrough] = Field(max_items=10)
-{%- endif %}
-{%- if enable_semantic_files_types %}
-    pr_files[List[FileDescription]] = Field(max_items=15")
-{%- endif %}
 =====
 
 
 Example output:
 
 ```yaml
-title: |-
-  ...
 type:
 - ...
 - ...
-{%- if enable_custom_labels %}
-labels:
-- |
-  ...
-- |
-  ...
-{%- endif %}
-description: |-
-  ...
-{%- if enable_file_walkthrough %}
-main_files_walkthrough:
-- ...
-- ...
-{%- endif %}
 {%- if enable_semantic_files_types %}
 pr_files:
 - filename: |
@@ -92,6 +78,17 @@ pr_files:
     ...
 ...
 {%- endif %}
+description: |-
+  ...
+title: |-
+  ...
+{%- if enable_custom_labels %}
+labels:
+- |
+  ...
+- |
+  ...
+{%- endif %}
 ```
 
 Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|-')

pr_agent/settings/pr_reviewer_prompts.toml

@@ -32,6 +32,7 @@ Code suggestions guidelines:
 - Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the PR code.
 - Don't suggest to add docstring, type hints, or comments.
 - Suggestions should focus on the new code added in the PR diff (lines starting with '+')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 {%- endif %}
 
 {%- if extra_instructions %}