Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: new option to display brief with custom usage #34

Merged
merged 3 commits into from
Nov 4, 2024

Conversation

molisani
Copy link
Member

@molisani molisani commented Nov 2, 2024

Resolves #20

Describe your changes
Change customUsage to accept either a string or { input: string; brief: string } and include the brief on the line after the usage (indented).

Testing performed
Updated baselines with new output and added new test cases to ensure 100% coverage.

Additional follow-up
Currently the briefs are indented and formatted with italics, but I'm not sure if it makes sense to change up the formatting to make them more visible/readable.

@molisani molisani self-assigned this Nov 2, 2024
@molisani molisani requested a review from a team as a code owner November 2, 2024 20:56
@github-actions github-actions bot added core ⚙ Relates to the @stricli/core package documentation 📝 Improvements or additions to documentation labels Nov 2, 2024
@mkubilayk mkubilayk merged commit 3cf23f9 into main Nov 4, 2024
3 checks passed
@mkubilayk mkubilayk deleted the feat/enhanced-usage branch November 4, 2024 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core ⚙ Relates to the @stricli/core package documentation 📝 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support command examples
2 participants