Tyrrrz/CliFx

Command examples

Open

#115 opened on Dec 5, 2021

View on GitHub
 (3 comments) (2 reactions) (0 assignees)C# (64 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (1,603 stars)
PR merge metrics
 (Avg merge 3d 1h) (1 merged PR in 30d)

Description

Discussed in https://github.com/Tyrrrz/CliFx/discussions/114

Originally posted by wayneyaoo December 4, 2021 Can we have concept of "Example" for each command that can be specified by the CLI author and a new section is rendered as "EXAMPLE".

I was imaging something like

[Command("verb")]
public class MyCommand : ICommand
{
    // options and parameters go here as property

    [Example]
    public (static) Example[] Examples = new [] 
        { new Example("verb --option value"), new Example("verb --anotherPositionalOption") };
}

and the examples could be rendered to another section like "EXAMPLE" when ./myapp verb -h is called.

I'm happy to contribute if this looks good. Or we can discuss.

Contributor guide

Research direction
Examine the existing help rendering system and attribute mechanism. Implement an `Example` attribute that can be applied to command classes to define usage examples, then modify the help text generation to display them in a new section.
Tech stack
csharp
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#CLI framework concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75