apple / apple/swift-argument-parser
customisation to swift argumentparser's help command output and error output
- Dominant language
- Swift
- Stars
- 3.8k
- Forks
- 411
- Avg merge
- 7d 13h
- Merged PRs (30d)
- 17
Description
Hello I want to implement customisation to swift argumentparser, Here are following changes want to do it in my cli
1. changing default footer present in help command output
currently help command output coming like this
OVERVIEW: clisample
USAGE: clisample
OPTIONS:
--version show the version.
-h, --help show the help.
SUBCOMMANDS:
logs (default) Export logs for clisample processes.
See 'clisample --help' for more information.'`
so instead of `See 'clisample --help' for more information.'` I want `For more details, run 'clisample help '`
2. customise error string getting from validation error
currently output of error
```
Error: Missing value for '-t
so I want error output with example and customised footer, like this
```
Error: Missing value for '-t
Help: -t
Usage: clisample logs --time
Example: clisample logs -t 5m
For more details, run 'clisample help '
```
If this feature is already available, please guide me, as i haven't seen anything on forums and any other place
Contributor guide
Research direction
Start by reviewing Swift Argument Parser's existing help-command and validation-error output customization capabilities. Compare the requested footer, error, usage, and example wording with the current behavior; done would require a clearly defined supported customization path for both output types.
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
- 25/100