oclif / oclif/core

flag level help can show exclusive/dependsOn

Open
#1,002 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

--help output good first issue help wanted
Dominant language
TypeScript
Stars
316
Forks
98
Avg merge
12h 32m
Merged PRs (30d)
2

Description

some flag properties (required, default, options) show up at the flag-level help.

It would be cool if dependsOn and exclusive did, too.

Right now, we rely descriptions (or errors) to tell the user what they should have done.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the flag-level help generation and how existing properties such as required, default, and options are rendered. Check how dependsOn and exclusive are represented, then update the relevant help output and add or adjust coverage so both properties appear for applicable flags.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.