Skip to content

Commit 262c792

Browse files
WirasmWirasm
authored
Merge pull request #18 from Wirasm/add-review-report-json
Fixed some issues in the CLI and updated readme
2 parents 7a223b3 + 2079a37 commit 262c792

File tree

4 files changed

+73
-60
lines changed

4 files changed

+73
-60
lines changed

‎review_report.json‎

Lines changed: 70 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2,91 +2,104 @@
22
"report_metadata": {
33
"report_file_name": "review_report.json",
44
"report_relative_path": "./review_report.json",
5-
"branch_name": "main",
5+
"branch_name": "add-review-report-json",
66
"changed_files": [
7-
"CHANGELOG.md",
8-
"README.md",
9-
"pyproject.toml",
10-
"src/__init__.py",
11-
"src/cli.py",
12-
"src/utility_library/cc_review/README.md",
13-
"src/utility_library/cc_review/__init__.py",
147
"src/utility_library/cc_review/cc_review_cli.py",
15-
"src/utility_library/cc_review/cc_review_runner.py",
16-
"src/utility_library/cc_review/cc_review_utils.py",
17-
"src/utility_library/cc_standup/standup_typer.py",
18-
"uv.lock"
8+
"src/utility_library/cc_review/cc_review_runner.py"
199
],
2010
"date_range": "2025-05-16",
21-
"number_of_commits": 1,
22-
"number_of_files_changed": 12,
23-
"number_of_lines_added": 273,
24-
"number_of_lines_removed": 2
11+
"number_of_commits": 2,
12+
"commits": [
13+
{
14+
"id": "695d2ca35a59690449e81cb74eb25021f437c191",
15+
"message": "feat: add commit list to review runner report metadata"
16+
},
17+
{
18+
"id": "e433c2bc0b31e9e3c000ea7d04c689af9c325495",
19+
"message": "style: consolidate multi-line function parameters into single lines in cc_review_cli.py"
20+
}
21+
],
22+
"number_of_files_changed": 2,
23+
"number_of_lines_added": 4,
24+
"number_of_lines_removed": 6
2525
},
2626
"issue_metadata": {
27-
"issue_types_found": ["style", "documentation", "consistency"],
27+
"issue_types_found": [
28+
"style",
29+
"consistency",
30+
"feature"
31+
],
2832
"overall_severity": "low",
29-
"number_of_issues_found": 4,
33+
"number_of_issues_found": 3,
3034
"status": "open"
3135
},
3236
"issues": [
3337
{
3438
"issue_id": "001",
3539
"severity": "low",
3640
"type": "style",
37-
"short_description": "Missing newline at end of __init__.py file",
38-
"affected_files": ["src/__init__.py"],
39-
"affected_lines": ["line 3"],
41+
"description": "Inconsistent code formatting - function parameters were consolidated to single lines",
42+
"affected_files": [
43+
"src/utility_library/cc_review/cc_review_cli.py"
44+
],
45+
"affected_lines": [
46+
15,
47+
16,
48+
17
49+
],
4050
"suggested_fixes": [
41-
"Add a newline character at the end of the file to follow Python style conventions"
42-
]
51+
"Consider reverting to multi-line parameter formatting for better readability when there are multiple parameters",
52+
"Multi-line formatting is more consistent with Python style guides for functions with multiple parameters",
53+
"The original formatting was easier to read and maintain"
54+
],
55+
"status": "open"
4356
},
4457
{
4558
"issue_id": "002",
46-
"severity": "medium",
47-
"type": "consistency",
48-
"short_description": "Version inconsistency in uv.lock file",
49-
"affected_files": ["uv.lock"],
50-
"affected_lines": ["line 108"],
51-
"suggested_fixes": [
52-
"The uv.lock file still references version 0.4.0 for claudecode-utility-library while pyproject.toml has been updated to 1.0.0",
53-
"Run 'uv lock --update' to synchronize dependency versions"
54-
]
55-
},
56-
{
57-
"issue_id": "003",
5859
"severity": "low",
59-
"type": "documentation",
60-
"short_description": "JSON prompt escaping instructions could be clearer",
61-
"affected_files": ["src/utility_library/cc_review/cc_review_runner.py"],
62-
"affected_lines": ["lines 83-87"],
60+
"type": "style",
61+
"description": "Added unnecessary blank line after imports section",
62+
"affected_files": [
63+
"src/utility_library/cc_review/cc_review_cli.py"
64+
],
65+
"affected_lines": [
66+
14
67+
],
6368
"suggested_fixes": [
64-
"Consider improving the JSON escaping documentation to include more specific examples",
65-
"Add examples of common problematic characters that need escaping"
66-
]
69+
"Remove the extra blank line after the imports to maintain consistent spacing",
70+
"Python PEP 8 style guide recommends two blank lines after imports"
71+
],
72+
"status": "open"
6773
},
6874
{
69-
"issue_id": "004",
75+
"issue_id": "003",
7076
"severity": "low",
71-
"type": "style",
72-
"short_description": "Inconsistent error handling in run_claude_review",
73-
"affected_files": ["src/utility_library/cc_review/cc_review_runner.py"],
74-
"affected_lines": ["lines 55-60"],
77+
"type": "feature",
78+
"description": "New metadata field 'commits' added without proper documentation",
79+
"affected_files": [
80+
"src/utility_library/cc_review/cc_review_runner.py"
81+
],
82+
"affected_lines": [
83+
108
84+
],
7585
"suggested_fixes": [
76-
"Consider using logging instead of print statements for error handling",
77-
"The error message could include more context about the failed command"
78-
]
86+
"Update documentation to describe the new 'commits' field format and structure",
87+
"Ensure the actual implementation populates this new field correctly",
88+
"Consider adding example output to documentation"
89+
],
90+
"status": "open"
7991
}
8092
],
8193
"summary": {
82-
"most_critical_issues": [
83-
"Version inconsistency in uv.lock file (issue_id: 002) - This could cause dependency resolution issues"
84-
],
85-
"overall_assessment": "The version 1.0.0 release introduces the new code review command successfully. The code is well-structured with proper Typer integration. Only minor style and documentation issues were found, with one medium-severity version inconsistency issue in the lock file.",
94+
"critical_issues": [],
95+
"high_priority_issues": [],
96+
"most_critical_issues": [],
97+
"overall_assessment": "The changes in this branch are minor and primarily consist of style modifications and a small feature addition to the review report metadata. The most significant concern is the inconsistent code formatting changes that reduce readability without providing clear benefits.",
8698
"recommendations": [
87-
"Update the uv.lock file to match the new version",
88-
"Address the minor style issues for better code consistency",
89-
"Consider expanding error handling and logging capabilities"
99+
"Consider reverting the code formatting changes in cc_review_cli.py to maintain consistency with the project's existing style",
100+
"If formatting changes are desired, they should be applied project-wide using an automated formatter like Black or Ruff",
101+
"Ensure that the new 'commits' metadata field is properly implemented and documented",
102+
"Update related documentation to reflect the new metadata structure"
90103
]
91104
}
92105
}

‎src/__init__.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
"""ClaudeCode utility library."""
2-
3-
__version__ = "1.1.2"
1+
"""ClaudeCode utility library."""

‎src/utility_library/cc_review/cc_review_cli.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
from .cc_review_runner import generate_review_prompt, run_claude_review
1212
from .cc_review_utils import pretty_print_json_file
1313

14+
1415
def review(
1516
branch: Optional[str] = typer.Argument(
1617
None, help="Branch to review (optional, defaults to latest changes)"

‎src/utility_library/cc_review/cc_review_runner.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ def generate_review_prompt(branch: Optional[str] = None, output_format: str = "t
105105
- List of changed files
106106
- Date range
107107
- Number of commits
108+
- List of commits and their id and message
108109
- Number of files changed
109110
- Number of lines added
110111
- Number of lines removed

0 commit comments

Comments
 (0)