Inline File Walkthrough 💎
\n\n"
+ output += """\
+For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page.
+This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
+
+To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are:
+- `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
+- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
+- `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
+"""
# extra instructions
output += " Utilizing extra instructions
\n\n"
output += '''\
diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml
index 9e7fed43..66cd48bc 100644
--- a/pr_agent/settings/configuration.toml
+++ b/pr_agent/settings/configuration.toml
@@ -56,7 +56,7 @@ enable_help_text=true
## changes walkthrough section
enable_semantic_files_types=true
collapsible_file_list='adaptive' # true, false, 'adaptive'
-inline_file_summary=true # Pro feature
+inline_file_summary=false # false, true, 'table'
# markers
use_description_markers=false
include_generated_by_header=true
diff --git a/pr_agent/settings/pr_description_prompts.toml b/pr_agent/settings/pr_description_prompts.toml
index 09d1c6e4..b9c5ce39 100644
--- a/pr_agent/settings/pr_description_prompts.toml
+++ b/pr_agent/settings/pr_description_prompts.toml
@@ -39,7 +39,8 @@ class PRType(str, Enum):
Class FileDescription(BaseModel):
filename: str = Field(description="the relevant file full path")
- changes_summary: str = Field(description="minimal and concise summary of the changes in the relevant file")
+ changes_summary: str = Field(description="concise summary of the changes in the relevant file, in bullet points (1-4 bullet points).")
+ changes_title: str = Field(description="an informative title for the changes in the files, describing its main theme (5-10 words).")
label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formatting', 'miscellaneous', ...")
{%- endif %}
@@ -68,6 +69,8 @@ pr_files:
...
changes_summary: |
...
+ changes_title: |
+ ...
label: |
...
...
diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py
index e3ec92ff..0cc32b7f 100644
--- a/pr_agent/tools/pr_description.py
+++ b/pr_agent/tools/pr_description.py
@@ -333,10 +333,11 @@ class PRDescription:
try:
filename = file['filename'].replace("'", "`").replace('"', '`')
changes_summary = file['changes_summary']
+ changes_title = file['changes_title'].strip()
label = file.get('label')
if label not in self.file_label_dict:
self.file_label_dict[label] = []
- self.file_label_dict[label].append((filename, changes_summary))
+ self.file_label_dict[label].append((filename, changes_title, changes_summary))
except Exception as e:
get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
pass
@@ -357,9 +358,9 @@ class PRDescription:
try:
pr_body += ""
header = f"Relevant files"
- delta = 65
- header += " " * delta
- pr_body += f""" | {header} |
|---|
"""
+ delta = 77
+ # header += " " * delta
+ pr_body += f""" | {header} |
|---|
"""
pr_body += """"""
for semantic_label in value.keys():
s_label = semantic_label.strip("'").strip('"')
@@ -370,19 +371,24 @@ class PRDescription:
pr_body += f"""{len(list_tuples)} files"""
else:
pr_body += f""""""
- for filename, file_change_description in list_tuples:
+ for filename, file_changes_title, file_change_description in list_tuples:
filename = filename.replace("'", "`")
filename_publish = filename.split("/")[-1]
- filename_publish = f"{filename_publish}"
- if len(filename_publish) < (delta - 5):
- filename_publish += " " * ((delta - 5) - len(filename_publish))
+ file_changes_title_br = insert_br_after_x_chars(file_changes_title, x=(delta - 5),
+ new_line_char="\n\n")
+ file_changes_title_extended = file_changes_title_br.strip() + ""
+ if len(file_changes_title_extended) < (delta - 5):
+ file_changes_title_extended += " " * ((delta - 5) - len(file_changes_title_extended))
+ filename_publish = f"{filename_publish}{file_changes_title_extended}"
diff_plus_minus = ""
+ delta_nbsp = ""
diff_files = self.git_provider.diff_files
for f in diff_files:
if f.filename.lower() == filename.lower():
num_plus_lines = f.num_plus_lines
num_minus_lines = f.num_minus_lines
diff_plus_minus += f"+{num_plus_lines}/-{num_minus_lines}"
+ delta_nbsp = " " * max(0, (8 - len(diff_plus_minus)))
break
# try to add line numbers link to code suggestions
@@ -391,21 +397,19 @@ class PRDescription:
filename = filename.strip()
link = self.git_provider.get_line_link(filename, relevant_line_start=-1)
- file_change_description = insert_br_after_x_chars(file_change_description, x=(delta - 5))
+ file_change_description_br = insert_br_after_x_chars(file_change_description, x=(delta - 5))
pr_body += f"""
- {filename_publish}
-
- {filename}
+ {filename_publish}
+
-**{file_change_description}**
-
+{filename}
+{file_change_description_br}
|
- {diff_plus_minus} |
-
+ {diff_plus_minus}{delta_nbsp} |
"""
if use_collapsible_file_list:
@@ -419,25 +423,48 @@ class PRDescription:
pass
return pr_body
-def insert_br_after_x_chars(text, x=70):
+def insert_br_after_x_chars(text, x=70, new_line_char="
"):
"""
Insert
into a string after a word that increases its length above x characters.
"""
if len(text) < x:
return text
- words = text.split(' ')
+ lines = text.splitlines()
+ words = []
+ for i,line in enumerate(lines):
+ words += line.split(' ')
+ if i x:
- new_text += "
" # Insert line break
- current_length = 0 # Reset counter
+ if not is_inside_code:
+ new_text += f"{new_line_char} " # Insert line break
+ current_length = 0 # Reset counter
+ else:
+ new_text += f"`{new_line_char} `"
+ # check if inside tag
+ if word.startswith("`") and not is_inside_code and not word.endswith("`"):
+ is_inside_code = True
+ if word.endswith("`"):
+ is_inside_code = False
# Add the word to the new text
- new_text += word + " "
+ if word.endswith("\n"):
+ new_text += word
+ else:
+ new_text += word + " "
current_length += len(word) + 1 # Add 1 for the space
+
+ if word.endswith("\n"):
+ current_length = 0
return new_text.strip() # Remove trailing space
| | | |
+
+___
+
+___
+
+## Configuration options
+
+`prompt`: the prompt for the tool. It should be a multi-line string.
+
+`num_code_suggestions`: number of code suggestions provided by the 'custom_suggestions' tool. Default is 4.
+
+`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md
index f6c7041f..00526a87 100644
--- a/docs/DESCRIBE.md
+++ b/docs/DESCRIBE.md
@@ -20,7 +20,7 @@ For example:
___
___
-
+
___
### Configuration options
@@ -50,12 +50,15 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related
- `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
### Inline file summary 💎
-To enable inline file summary, set `pr_description.inline_file_summary=true` in the configuration file.
+> This feature is available only in PR-Agent Pro
-When the feature is enabled, PR-Agent Pro will add a collapsable summary of each file change in the "Files changed" tab.
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view).
-
+To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are:
+- `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
+
+- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
+- `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
*Note that this feature is currently available only for GitHub.
diff --git a/pr_agent/servers/help.py b/pr_agent/servers/help.py
index d1759c53..505016c2 100644
--- a/pr_agent/servers/help.py
+++ b/pr_agent/servers/help.py
@@ -175,6 +175,17 @@ Make sure to provide proper title, and a detailed and well-phrased description f
"""
output += "\n\n\n\n"
+ # Inline File Walkthrough
+ output += "