carloscuesta/gitmoji-cli

Add shell completions for bash/zsh/fish/posh/etc

Open

#912 opened on Sep 6, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (219 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (4,418 stars)
PR merge metrics
 (Avg merge 23d 12h) (3 merged PRs in 30d)

Description

Description of the problem

❯ gitmoji -<TAB>
option
-c          Interactively commit using the prompts
--commit    Interactively commit using the prompts
--config    Setup gitmoji-cli preferences.
-g          Setup gitmoji-cli preferences.
-i          Initialize gitmoji as a commit hook
--init      Initialize gitmoji as a commit hook
--list      List all the available gitmojis
...

Solution

I guess in javascript there exists a library to generate shell completions automatically like

Alternatives

Don't use any library, like https://github.com/ytdl-org/youtube-dl/blob/master/devscripts or https://github.com/ogham/exa/tree/master/completions?

Additional context

No response

Validations

Contributor guide

Research direction
Check the current argument parsing library (e.g., 'yargs' or 'commander') and add shell completion support using a library like 'tabtab' or integrate with 'yargs completions'. Follow the pattern from linked examples.
Tech stack
javascriptnodejs
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.
Clear
Prerequisites
Node.jsnpmGitFamiliar with CLI tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65