Friendlier names for the hooks

[bittner]

The pre-commit-hooks project has very human textual output when hooks are executed, e.g.

Trim Trailing Whitespace.................................................Passed
Fix End of Files.........................................................Passed
Check Yaml...............................................................Passed
Check for added large files..............................................Passed

The ruff-pre-commit OTOH is much more silent, e.g.

ruff.....................................................................Passed
ruff-format..............................................................Passed

Can we change the name attribute of the two hooks to something more friendly? e.g.

Check Python code quality................................................Passed
Check Python code formatting.............................................Passed

[zanieb]

I honestly prefer the shorter names. I'd maybe say ruff-check instead of ruff but these reflect the actual invocations which is helpful, e.g., if you're using Ruff alongside other tools.

[bittner]

Fair enough.

Care to change "ruff" to "ruff-check" for better clarity then?

[zanieb]

As long as it's not a breaking change, I'm all for it. I presume it's just legacy, as ruff used to invoke ruff check but no longer does.

[dhruvmanila]

Happy to accept a PR for the suggested name change if you want to

[dhruvmanila]

We should only change the name attribute, changing the id would be a breaking change, I think.

[dhruvmanila]

My only concern would be whether that would create any confusion as users would still need to specify "ruff" but they would see "ruff-check"

[bittner]

I think this discussion shows that there are really two issues:

1. The id vs. name confusion aka "Do developers want to see the item they configured, or rather a descriptive text?"
2. Technical debt from not updating the ruff id to ruff-check

This is certainly not a big issue, so there's no urge to change anything. If it was my code base I'd probably

• Add a ruff-check id
• Deprecate the ruff id
• Change the name attributes to at least mimik the CLI commands (e.g. ruff check, ruff format)

This way the defaults, incuding the id values to activate the hooks, would make sense.

[zanieb]

Yeah adding a duplicate ruff-check id then updating both names seems fine to me?

[AA-Turner]

See #124 to add a ruff-check ID, whilst retaining the ruff ID. This keeps the hook display names the same, though.

[plyrthn]

ruff-check doesnt work now after this i think!
Switched to ruff and it worked

[ERROR] ruff-check is not present in repository https://github.com/astral-sh/ruff-pre-commit. Typo? Perhaps it is introduced in a newer version? Often pre-commit autoupdate fixes this.

[AA-Turner]

I don't believe there's been a tagged release since that PR was merged. Check again after the next release of Ruff, it should work then.

[dhruvmanila]

Yeah, ruff-pre-commit is bumped whenever a new version of Ruff comes out.

[plyrthn]

Appreciate it folks!! On a new install its been a bit broken haha

…

On Tue, May 13, 2025, 5:53 PM Dhruv Manilawala ***@***.***> wrote: *dhruvmanila* left a comment (astral-sh/ruff-pre-commit#123) <#123 (comment)> Yeah, ruff-pre-commit is bumped whenever a new version of Ruff comes out. — Reply to this email directly, view it on GitHub <#123 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADGO5ISLMMIRRJMOGMS7IRL26JSUXAVCNFSM6AAAAAB33VGWNOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNZYGAZTQOBXGY> . You are receiving this because you commented.Message ID: ***@***.***>