Show HN: I built a linter for undocumented linter warnings. AI hates me now
A new tool called Shamefile has been developed to help document linter warnings in code. It requires developers to provide reasons for suppressing warnings, promoting accountability and reducing tech debt. The tool integrates with various programming languages and aims to improve code review processes by making suppression documentation a standard practice.
- ▪Shamefile prevents developers from silencing linter warnings without justification.
- ▪It creates a shamefile.yaml for documentation and a shame CLI for interaction.
- ▪The tool supports multiple programming languages and integrates with CI/CD processes.
Opening excerpt (first ~120 words) tap to expand
Turn silent tech debt into reviewable and documented decisions. How it works • Why use it • Installation • Supported languages • FAQ • Roadmap • Contributing shamefile won't let anyone silence a linter warning in your code without writing down why. People are lazy. Both committer and code reviewer. The committer slaps a // NOLINT comment when there's no easy fix. They don't justify it — in most languages there's no good place for that. The code reviewer focuses on more important things: security, bugs, design. There's no dedicated time for checking new suppression arrivals. Shamefile adds shamefile.yaml for the code reviewer and the shame CLI for the committer to give them tools to react before tech debt gets out of control.
…
Excerpt limited to ~120 words for fair-use compliance. The full article is at GitHub.