fix(forge): fix the --debug flag in forge debug, default to off
#4793
Conversation
| opts: BuildArgs { args: self.opts, ..Default::default() }, | ||
| evm_opts: self.evm_opts, | ||
| debug: true, | ||
| debug: self.debug, |
There was a problem hiding this comment.
hmm, so in order to launch the debugger you'd need to run forge debug --debug?
this does not sound right to me
--debug Open the script in the debugger Revert string configuration. Possible values are "default", "strip" (remove), "debug"
I think the only reason --debug is even available is because we reused a common type that has this.
wdyt @iFrostizz ?
There was a problem hiding this comment.
The change makes sense, but not sure about forge debug utility, why don't we just use forge script --debug for the same purpose ?
There was a problem hiding this comment.
I agree that forge debug --debug is a bit odd, but since that's exactly what the documentation (forge help) says and it took a trivial change to make it so, I rolled with it. I'd be happy to change the docs and/or behavior though if there's consensus on something more sensible.
All I was looking for was the ability to run my contract function and get a trace. I used forge debug because the docs made that sound correct, and I didn't try forge script because it sounded like that was more about building transactions to run on chain, but having just tried it, forge script worked fine for me too.
Any thoughts on the following (mutually exclusive) options? :
- remove the
--debugflag fromforge debugand documentation, and potentially add a--traceflag instead which turns off the debugger and just prints a trace. This would leave the default behavior unchanged. - remove
forge debugaltogether and make it clear thatforge scriptis the right thing to use in this case. This seems a bit clearer, but may break people's existing infrastructure.
There was a problem hiding this comment.
forge script should be enough because it's kind of a superset of forge debug so I would be on the side of nuking it, good suggestions
There was a problem hiding this comment.
Given that, I'd be in favor of nuking forge debug as well, just to simplify the interface. I'll defer to you folks who know the project better, but If you'd like me to make either of these changes happen, let me know and I'll see what I can do.
|
Deprecating for the upcoming debugger refactor |
4 participants
'forge debug' was ignoring the --debug flag. This change fixes that, so without running without --debug will print a trace, and running with --debug will run in the debugger. This is as already described in the documentation.
Motivation
I wanted to run 'forge debug' without the debugger, and was confused that the behavior did not match the documentation.
Solution
Just plumb the command line arg through.