feat: Add markdown report format #777
Conversation
hahwul
commented
Jul 5, 2025
hahwul
commented
- Add 'markdown' and 'md' options for --report-format flag
- Implement GenerateMarkdownReport function to generate reports in Markdown format
- Add tests for Markdown report generation
- Update documentation for new report format
- Add 'markdown' and 'md' options for --report-format flag - Implement GenerateMarkdownReport function to generate reports in Markdown format - Add tests for Markdown report generation - Update documentation for new report format
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @hahwul, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the tool's reporting capabilities by introducing a new Markdown output format. This allows users to generate human-readable and easily shareable reports directly from their scan results, complementing the existing plain text and JSON formats.
Highlights
- New Report Format Option: The
--report-formatcommand-line flag now supportsmarkdownandmdas valid options, allowing users to generate scan reports in Markdown format. - Markdown Report Generation Logic: A new
GenerateMarkdownReportfunction has been implemented to construct comprehensive Markdown reports from scan results, including sections for general information, parameter analysis, and detailed XSS Proof-of-Concepts (PoCs). - Unit Test Coverage: Dedicated unit tests have been added for the
GenerateMarkdownReportfunction, ensuring its correctness and reliability across various scenarios, such as reports with and without parameters or PoCs. - Documentation Update: The project's documentation has been updated to include instructions and examples for utilizing the newly added Markdown report format.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Code Review
This pull request introduces a new markdown report format, along with corresponding documentation and tests. The implementation is well-structured. My review includes feedback on a data sanitization issue in the report generation that could lead to corrupted output and a recommendation to improve the robustness of one of the new test cases.
Example ReportInformation
Parameter Analysis
XSS PoCs
PoC #0PoC #1 |
