crashappsec / crashappsec/chalk

Consider improving output for `chalk help help` and `chalk help --help`

Open
#168 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nim
Stars
436
Forks
25
No merged PRs in 30d

Description

Description

These commands output the same thing:

  • chalk
  • chalk help
  • chalk --help
  • chalk help --help

But the output of chalk help help outputs the same information twice.

Chalk lists help as a command in chalk help commands, and says to run chalk help "cmdname" to get help for a command. So a user may try to run chalk help help or chalk help --help to get extra information about using the help command.

Impact

Low impact:

  • A user who runs chalk help help gets duplicated output.
  • A user who runs chalk help help or chalk help --help doesn't get help for the help command.

Steps to Reproduce

Run chalk help help with the latest chalk release (0.3.1).

Other information

4

Contributor guide

No contributing guide indexed for this repository

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 reproducing chalk help help and chalk help --help with Chalk 0.3.1, then locate the CLI help-command handling. Done means the duplicated output is removed and these commands provide useful help for the help command rather than repeating the general help text.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.