Skip to content

Conversation

@m-hemmings
Copy link
Member

PURPOSE

Add clippy_report_generator.sh script to generate a styled HTML report from cargo clippy output.
This script provides an easier way to review warnings/errors in a browser rather than parsing raw JSON or terminal logs.

  • Resolve manifest path automatically relative to script location
  • Support --manifest-path and --out flags for overrides
  • Clean up temp files after run
  • Generate a self-contained HTML report

ISSUES

  • Without this script, developers have to manually parse raw JSON or terminal output from cargo clippy, which is hard to review
  • No existing HTML reporting mechanism exists for this

NOTES FOR REVIEWERS

  • Verified defaults work when from from project root
  • Report is written to clippy_report.html at project root by default
  • Script exits with Clippy's return code
  • REQUIRES jq, sed, and grep to be present in the environment

@m-hemmings m-hemmings linked an issue Sep 18, 2025 that may be closed by this pull request
Copy link
Contributor

@DyanB DyanB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me!

@rennergade
Copy link
Contributor

This is helpful and we'll definitely use it when cleaning up the clippy errors. I'm not sure we should host it in our repo though since its mostly unrelated to Lind.

Could be a cool tool for you to host somewhere that we'll use?

@m-hemmings
Copy link
Member Author

This is helpful and we'll definitely use it when cleaning up the clippy errors. I'm not sure we should host it in our repo though since its mostly unrelated to Lind.

Could be a cool tool for you to host somewhere that we'll use?

Is there a tools repo you guys use that I should put it in instead?

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.

Create report script for clippy warnings

4 participants