Tyrrrz/CliFx

Pass-through arguments

Open

#39 opened on Jan 27, 2020

View on GitHub
 (2 comments) (2 reactions) (0 assignees)C# (64 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

Add support for path-through arguments.

Sometimes the application may act as a proxy to another application. An example of this is dotnet run which routes any arguments after -- directly to the executed application.

Example:

dotnet run -c Release -- arg1 arg2 --flag

Arguments arg1, arg2, --flag are passed as is to the executed application.

Allow [CommandArgumentSink] attribute on properties of type IEnumerable<string> or any other type that can be assigned from a string array or initialized with a string array (similar to how we do conversions currently). There can only be one such property.

Note: this has to play nicely with #38.

Open question:

  • Should arguments after -- only be consumed by argument sinks?
  • If not, then we need to determine how parameters/options and argument sinks should work together.

Contributor guide

Research direction
Study the behavior of pass through arguments in dotnet run and similar CLI tools. Familiarize yourself with CliFx's attribute based binding (e.g., [CommandOption], [CommandArgument]). Implement a new [CommandArgumentSink] attribute that collects all arguments after into a property of type IEnumerable<string>. Ensure compatibility with existing argument parsing and handle the open question about argument sink interaction with other parameters.
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.
3
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.
Mostly clear
Prerequisites
C#.NETGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65