Skip to content

feature/preview report md format#24

Merged
k-kohey merged 7 commits intomainfrom
feature/preview-report-md-format
Feb 28, 2026
Merged

feature/preview report md format#24
k-kohey merged 7 commits intomainfrom
feature/preview-report-md-format

Conversation

@k-kohey
Copy link
Copy Markdown
Owner

@k-kohey k-kohey commented Feb 28, 2026

  • Enhance axe preview report command to support Markdown output format
  • Enhance axe preview report command to support HTML output format
  • Enhance HTML report generation in axe preview report command
  • Refactor HTML report generation in axe preview report command
  • Enhance report generation in axe preview report command

- Updated the `README.md` to clarify the usage of the `axe preview report` command, including the new Markdown output option.
- Modified `preview_report.go` to implement support for generating Markdown reports alongside PNG screenshots.
- Added validation for output paths and formats in the report generation process.
- Introduced tests to ensure correct handling of files without `#Preview` blocks and to validate output paths for Markdown reports.

This update improves the reporting capabilities of the preview command, providing users with more flexible output options.
- Updated the `README.md` to include HTML as a new output option for the `axe preview report` command.
- Modified `preview_report.go` to implement support for generating HTML reports alongside existing PNG and Markdown formats.
- Refactored report generation logic to accommodate multiple output formats.
- Added tests to validate the new HTML report generation and ensure correct handling of output paths.

This update improves the versatility of the preview command, allowing users to generate responsive HTML reports in addition to existing formats.
- Added functionality to automatically open the generated HTML report using the default application.
- Updated CSS styles for improved aesthetics, including background colors, text colors, and hover effects.
- Introduced animation effects for report cards and adjusted layout for better responsiveness.
- Enhanced the structure of the report with new header styles and improved section formatting.

These changes improve the user experience by making the report visually appealing and easier to navigate.
- Replaced direct HTML escaping with the `html` package for improved safety and consistency.
- Introduced structured data types for HTML report generation, enhancing readability and maintainability.
- Updated the report template to utilize the new data structures, improving the organization of the generated HTML.
- Enhanced the rendering logic to dynamically populate report data, including file and preview counts.

These changes streamline the report generation process and improve the overall structure of the HTML output.
- Introduced functionality to capture and report failures during preview generation, allowing for more informative output.
- Updated the rendering logic for both Markdown and HTML reports to include failure details, improving error visibility.
- Added versioning information to reports, providing context for the generated output.
- Refactored capture logic to support partial results, enabling report generation even when some captures fail.

These changes enhance the robustness and usability of the reporting features in the preview command.
- Updated the rendering functions for Markdown and HTML reports to return errors, improving error handling during report generation.
- Refactored the report generation logic to utilize helper functions for better readability and maintainability.
- Enhanced the report templates to dynamically pluralize file and preview counts, improving the accuracy of displayed information.

These changes enhance the robustness and clarity of the reporting features in the preview command.
- Updated the test for rendering Markdown reports to ensure proper escaping of pipe characters and newlines in both error messages and titles.
- Refactored the report generation logic to enhance clarity and maintainability, ensuring that failures are accurately represented in the output.

These changes enhance the robustness of the reporting features in the `axe preview report` command.
@k-kohey k-kohey marked this pull request as ready for review February 28, 2026 12:55
@k-kohey k-kohey merged commit 83cf381 into main Feb 28, 2026
2 checks passed
@k-kohey k-kohey deleted the feature/preview-report-md-format branch March 24, 2026 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant