ruff icon indicating copy to clipboard operation
ruff copied to clipboard

Feature Request: Audit for codetags

Open mattgiles opened this issue 1 year ago • 0 comments

This is potentially beyond the perimeter of Ruff's core linting/formatting concerns, but I'm curious if there's any appetite to support a simple workflow/command for auditing/printing/outputting codetag comments (TODO:, HACK:, etc) from target paths. Either as it's own subcommand, or as an option for ruff check.

Codetags are obviously extremely common/idiomatic, but as far as I can tell tooling around codetags is minimal (it seems like rake might support such a workflow with rake notes).

Minimal tooling may indicate minimal utility/interest. However, I am increasingly aware of CI build steps in the wild that use roll-your-own scripts to audit/report on codetages in similar ways. And I've been surprised at how useful it can be to just see, per file, all codetagged comments in one place.

Cf. PEP 350 - Codetags

mattgiles avatar Feb 22 '24 15:02 mattgiles