Skip to content

Conversation

@adrian-thurston
Copy link
Contributor

@adrian-thurston adrian-thurston commented Jun 24, 2025

What type of PR is this?

  • feature

What this PR does / why we need it:

We have switched from v2 to v3 mainly because we want to support flags after the arguments. There are many other benefits, but this one drove the work.

We do have some commands though where the old v2 behaviour is desirable, specifically, when we pass arguments through. For example our ssh command:

  tool ssh MACHINE-NAME ls -la

It is possible to require the user to use the special argument --, however we would prefer to not disrupt existing usage where the old bahaviour is relied on.

To support this per-command, added an option to the Command struct called StopOnNthArg. It terminates flag parsing after seeing N positional arguments.

Which issue(s) this PR fixes:

There is no issue for this that I am aware of.

Special notes for your reviewer:

Using a pointer to int might be considered odd. Maybe there is a project convention to follow?

Testing

Test cases for the feature have been added.

Release Notes

New feature: allow the user to stop processing flags after seeing N args.

@adrian-thurston adrian-thurston requested a review from a team as a code owner June 24, 2025 22:20
@adrian-thurston adrian-thurston marked this pull request as draft June 24, 2025 23:28
@adrian-thurston adrian-thurston force-pushed the feat/stop-on-nth-arg branch 3 times, most recently from 0c5bcbe to 9d3591b Compare June 25, 2025 00:40
We have switched from v2 to v3 mainly because we want to support parsing flags
after the arguments. There are many other benefits, but this one drove the
work.

We do have some commands where the old v2 behaviour is desirable, specifically,
when we pass arguments through. For example our ssh command:

  tool ssh MACHINE-NAME ls -la

To support this on a per-command basis, added an option to the Command struct
called StopOnNthArg. It terminates flag parsing like '--'.
@adrian-thurston adrian-thurston marked this pull request as ready for review June 25, 2025 05:25
@adrian-thurston adrian-thurston changed the title feat: allow the user to stop processing flags after seeing N args Allow the user to stop processing flags after seeing N args Jun 25, 2025
@dearchap dearchap merged commit b75f9c0 into urfave:main Aug 16, 2025
7 checks passed
saschazepter pushed a commit to saschazepter/forgejo that referenced this pull request Oct 23, 2025
This PR contains the following updates:

| Package | Change | Age | Confidence |
|---|---|---|---|
| [github.com/urfave/cli/v3](https://github.com/urfave/cli) | `v3.4.1` -> `v3.5.0` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2furfave%2fcli%2fv3/v3.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2furfave%2fcli%2fv3/v3.4.1/v3.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>urfave/cli (github.com/urfave/cli/v3)</summary>

### [`v3.5.0`](https://github.com/urfave/cli/releases/tag/v3.5.0)

[Compare Source](urfave/cli@v3.4.1...v3.5.0)

#### What's Changed

- Update mkdocs reqs by [@&#8203;meatballhat](https://github.com/meatballhat) in [#&#8203;2190](urfave/cli#2190)
- Allow the user to stop processing flags after seeing N args by [@&#8203;adrian-thurston](https://github.com/adrian-thurston) in [#&#8203;2163](urfave/cli#2163)
- chore(deps): bump github.com/stretchr/testify from 1.10.0 to 1.11.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2194](urfave/cli#2194)
- chore(deps): bump mkdocs-material from 9.6.16 to 9.6.18 in the python-packages group by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2195](urfave/cli#2195)
- chore(deps): bump actions/setup-go from 5 to 6 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2198](urfave/cli#2198)
- chore(deps): bump actions/setup-node from 4 to 5 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2199](urfave/cli#2199)
- chore(deps): bump actions/setup-python from 5 to 6 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2200](urfave/cli#2200)
- chore(deps): bump github.com/stretchr/testify from 1.11.0 to 1.11.1 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2197](urfave/cli#2197)
- chore(deps): bump mkdocs-material from 9.6.18 to 9.6.19 in the python-packages group by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2201](urfave/cli#2201)
- chore(deps): bump mkdocs-material from 9.6.19 to 9.6.20 in the python-packages group by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2202](urfave/cli#2202)
- feat: add name of argument into error message when parsing fails by [@&#8203;oprudkyi](https://github.com/oprudkyi) in [#&#8203;2203](urfave/cli#2203)
- chore(deps): bump mkdocs-material from 9.6.20 to 9.6.21 in the python-packages group by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2204](urfave/cli#2204)
- add space between arguments usage by [@&#8203;dimfu](https://github.com/dimfu) in [#&#8203;2207](urfave/cli#2207)
- chore(deps): bump mkdocs-material from 9.6.21 to 9.6.22 in the python-packages group by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;2213](urfave/cli#2213)
- Fix: Make DefaultText behaviour consistent by [@&#8203;dearchap](https://github.com/dearchap) in [#&#8203;2214](urfave/cli#2214)

#### New Contributors

- [@&#8203;adrian-thurston](https://github.com/adrian-thurston) made their first contribution in [#&#8203;2163](urfave/cli#2163)
- [@&#8203;oprudkyi](https://github.com/oprudkyi) made their first contribution in [#&#8203;2203](urfave/cli#2203)
- [@&#8203;dimfu](https://github.com/dimfu) made their first contribution in [#&#8203;2207](urfave/cli#2207)

**Full Changelog**: <urfave/cli@v3.4.1...v3.5.0>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNTIuOSIsInVwZGF0ZWRJblZlciI6IjQxLjE1Mi45IiwidGFyZ2V0QnJhbmNoIjoiZm9yZ2VqbyIsImxhYmVscyI6WyJkZXBlbmRlbmN5LXVwZ3JhZGUiLCJ0ZXN0L25vdC1uZWVkZWQiXX0=-->

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9818
Reviewed-by: Earl Warren <[email protected]>
Co-authored-by: Renovate Bot <[email protected]>
Co-committed-by: Renovate Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants