Repository navigation
Make CI disallow leftover debugging code #511
Description
See #483 (comment)
A CI job could ensure that there are no dbg! (or pr_info!, etc.) calls left in pushed code would be a nice addition to the test suite. I have three high level ideas for how to accomplish this, but I haven't checked the applicability of any of them:
- Use rust-analyzer to find all references of the disallowed methods
- I believe there are certain clippy lints similar to what we want (
disallowed-methodsor so, relatively new) that could potentially be used - Just grep over all of the Rust code / all
*.rsfiles
While the last option is probably simplest, it may not be the cleanest. (note that these are just my first ideas, anyone implementing this can of course diverge from them :D ).
Activity
bjorn3 commentedon Oct 9, 2021
What about adding an option that will be enabled on CI replacing the definitions of these macros with
compile_error!("some error message")?niklasmohrin commentedon Oct 9, 2021
Good idea! It could be gated by a feature or env variable
riking commentedon Nov 18, 2022
How about a checkpatch.pl rule?
bjorn3 commentedon Nov 18, 2022
That would trigger on the
pr_log!call in thedbg!definition too, right? Even ifdbg!isn't called.nbdd0121 commentedon Nov 18, 2022
We just need to add
#[rustc_diagnostic_item = "dbg_macro"]to ourdbgmacro and then enable clippy'sdbg_macrolint.(Alternatively I can add a similar lint to klint)