Add forward-compatible constants for Command return codes #38199
Conversation
|
Extending the public API is considered a new feature. |
|
Tbh, return codes 0 = success and !0 = failure is something used across the complete shell/terminal industry. I don't think it'll ever change, so returning numbers is quite fine imho. It's mostly a DX feature (making it easier to understand for people not used to shell), so I don't think it's needed to step away from the normal feature-rules. |
|
@wouterj Magic numbers are generally considered a bad practice, even (actually, especially) if they will stay the same forever. If it is unnecessary, why add those constants to 5.1? And why bother clearly preferring them in the documentation: Sure, using regular ints works... but for anyone who prefers not using magic numbers, this is a cleaner fix. In our case it requires 83 Commands that need to be adjusted twice, rather than just once. And yes, if we use custom constants in the first change, we can do a few find-replaces in the second change. But that is still work that can trivially be made unnecessary. |
|
Closing as we do not add new features in old branches. |
In Symfony 5.0 it is mandatory to return an integer from Command::execute-methods.
In 5.1 two constants have been added to prevent having to write magic numbers or redefine constants for the two most used return codes.
This change includes those two constants in 4.4, to allow an easier transition to 5.1 compatible Commands.
I.e., now the constants can be used right away, rather than first changing all Commands to use magic numbers or custom constants and replacing those with these Symfony-constants after the upgrade to 5.1.