apple / apple/swift-argument-parser

Document & enforce valid characters for all configuration

Open
#768 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
3.8k
Forks
411
Avg merge
7d 13h
Merged PRs (30d)
17

Description

It would be exceptionally useful to document the valid characters for all configurations of SAP (e.g., long & short flag names, long & short option names, command names, etc.), and enforce rejection of all invalid characters in one central location.

This will:

- prevent different parts of SAP from expecting different sets of valid characters for the same values
- simplify shell completion script generation
- prevent bugs

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the configuration paths for long and short flag names, long and short option names, and command names, then identify where their validation can be centralized. Done means the valid characters are documented for each configuration and invalid characters are consistently rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.