apple / apple/swift-argument-parser

Customisable command synopsis in help message

Open
#184 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Swift
Stars
3.8k
Forks
411
Avg merge
7d 14h
Merged PRs (30d)
15

Description

I'd like to be able to customise the command synopsis a little bit more. The current synopsis generator in `UsageGenerator` will collapse all options into a single `` entry if there are more than twelve. My command has only 3 options, but with the long names being included in the synopsis, it's already unwieldy.

A few of ideas:

- Allow providing a manual synopsis.
- Similar to `.hidden`, allow hiding of options on a case-by-case basis.
- Collapse options with default values by default.

Contributor guide

Open the contributing guide

Research direction

Start by reading the UsageGenerator synopsis generator and its current behavior when more than twelve options are present. Compare the requested approaches—manual synopsis, per-option hiding, and collapsing options with default values—and determine which behavior should be specified. Done means the chosen customization is implemented consistently and its synopsis output is covered by tests, though no test file is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.