dry-rb/dry-cli

Conflicting aliases between global and command options.

Open

#133 opened on Oct 30, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Ruby (39 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (354 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug

When global options are defined in a Base command class from which all other commands are derived, it is possible for an alias in the global space to be "re-used" in the command space. For example if "-v" is an alias for :verbose in the global space and a command implements and option :validate with a "-v" alias there is now a conflict. I'm not sure what the current functionality is when dealing with this kind of conflict. It might be the command options rule; or, the global options rule. My preference would be to add a notation to the help text that calls out the conflict as a warning.... or maybe something else.

To Reproduce

Provide detailed steps to reproduce, an executable script would be best.

Expected behavior

In my Github repo MadBomber/experiments/cli_options/dry-cli

The base command defines -x for :xyzzy, and :exec command defines -x for the :exit option.

My environment

  • Affects my production application: NO
  • Ruby version: ... 3.2.2
  • OS: ... MacOS::HighSerria

Contributor guide

Research direction
Investigate how aliases are currently resolved between global and command options in dry cli. Identify where in the codebase alias conflicts can occur (e.g., during option parsing or help generation). Then propose adding a warning in the help text when a conflict is detected.
Tech stack
ruby
Domain
cli
Issue type
Bug
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.
1-3 hours
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
Ruby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55