Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disallow excess arguments #2223

Merged

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Jul 7, 2024

Problem

By default, if is not an error to pass excess command-arguments. This may sometimes be as intended but
will often mean a command-line error by the user will be silently ignored. A nice example from #2149

One particular case is when an argument is a name/title/label, in which the user may include spaces while forgetting quotes.

I originally intended excess arguments to be an error by default, but made it opt-in for the first release to reduce breakage at the time:

See: #2149

Solution

  • Make allowExcessArguments false by default.
  • Fix lots of broken tests where passing undeclared arguments!
  • Add migration tips to CHANGELOG for the breaking change.

@shadowspawn shadowspawn changed the base branch from develop to release/13.x July 7, 2024 04:35
@shadowspawn shadowspawn changed the title Feature/disallow excess arguments Disallow excess arguments Jul 7, 2024
@shadowspawn shadowspawn added the semver: major Releasing requires a major version bump, not backwards compatible label Jul 7, 2024
@shadowspawn shadowspawn marked this pull request as ready for review July 7, 2024 04:35
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Jul 8, 2024
@shadowspawn shadowspawn merged commit 58c28eb into tj:release/13.x Jul 8, 2024
11 checks passed
@shadowspawn shadowspawn deleted the feature/disallow-excess-arguments branch July 8, 2024 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pending release Merged into a branch for a future release, but not released yet semver: major Releasing requires a major version bump, not backwards compatible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants