Add tidy check for dbg

[gimbling-away]

Fixes #106169

[rustbot]

r? @jyn514

(rustbot has picked a reviewer for you, use r? to override)

[rustbot]

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

• Stabilizing library features
• Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
• Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
• Changing public documentation in ways that create new stability guarantees
• Changing observable runtime behavior of library APIs

[gimbling-away]

One possible nit: dbg! in multi line block comments (/* */) are detected as normal macro calls, I don't really have a idea how to detect that without parsing the source itself

[gimbling-away]

@jyn514 Any idea how to detect that? 😄

[albertlarsan68]

I know there is a clippy lint for that, but it is not what is intended for now.

[gimbling-away]

There is a clippy lint for dbg yeah + Is there any specific reason we aren't running clippy with default and a few others in CI?

[jyn514]

x.py clippy doesn't really work 😅 it uses your rustup install of clippy and just hopes that the versions are close enough. It's not reliable enough I'd want to gate on it in CI.

If you want, uplifting that lint to rustc seems reasonable (as an allow-by-default lint).

cc #97443

[gimbling-away]

The block comment issue doesn't seem that annoying considering that the lint is suppressable, if you (for some reason) have to have a dbg! in a block comment, suppress it

And cc @jyn514 considering uplifting that lint into rustc or running clippy in CI is a much bigger rock to throw, the current solution should work okay

[jyn514]

Looks great, thanks! Ideally it would use the clippy lint, but I understand getting clippy working will be a pain 😓 I don't mind landing this in the meantime.

@bors r+

[bors]

📌 Commit cc28813 has been approved by jyn514

It is now in the queue for this repository.