3 ms·
I worked on a codebase that had a special logging function with a name like NoPushLog that was just a direct wrapper of the base log function. A githook checked
by names_are_hard 2y ago
I worked on a codebase that had a special logging function with a name like NoPushLog that was just a direct wrapper of the base log function. A githook checked that this string was not in pushed code.
This solves many of the concerns raised in this thread about readability, automation, avoiding typos in the magic string.
The tricky thing you have to solve is how to push the code that defines the custom logging function, but there are solutions.
- deleted 2y ago[deleted]
- mattnewton 2y agoIt doesn’t allow you to put that in comments, config files or other languages though like a plain text string.
- sneak 2y agoWhy wouldn’t it? Sounds like the git hook is probably just grep…
- mattnewton 2y agoThen why have a function?
- saagarjha 2y agoBecause it distinguishes the normal logging function from the ones that are for local debugging.
- ajb 2y agoBecause of you made a typo, you're more likely to notice than in a comment or string, because it will fail, even at build time if you're using a compiled language
- mattnewton 2y agoRight, but the whole point of DO NOT SUBMIT is that it doesn’t need to be in the compilation step. It can be in data files, comments, etc. You can change your syntax highlighting theme to spot the typos x (I added them with a keyboard shortcut anyways)
- sneak 2y agoYou need to compile the code with all the debugging logging in it so it can run and print out all the “got here 3”s and so forth.