Hejsil / Hejsil/zig-clap

Support CLI description lines when parsing parameters

Open
#150 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Zig
Stars
1.6k
Forks
99
Avg merge
3h 53m
Merged PRs (30d)
1

Description

Hi, I was wondering if it's possible to support skipping cli description lines before parsing parameters?

```zig
const PARAMS = clap.parseParamsComptime(
\\my-package-name - My Package Description [v0.1.0]
\\
\\-o, --opt Optional argument (default: 3)
\\-h, --help Display help
\\ Positional argument
\\
);
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the parseParamsComptime entry point and trace how the parameter description lines are currently parsed. Use the example in the issue as the acceptance case: description and blank lines before the options should be skipped while the options and positional argument are still recognized.

Written by the indexing model from the issue text.

Assessment

Tech stack
zig
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.