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 (4,418 stars) (219 forks)batch import
featurehelp wanted

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

Tech stack
javascriptnodejs
Domain
clideveloper experience
Issue type
feature
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsgitmoji cli structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Explore shell completion libraries for Node.js like yargs completion or shtab. Review the gitmoji cli source code, particularly the command definitions in src/ or lib/. Determine whether to integrate completions via a subcommand or a separate file. Check how similar tools (e.g., gitmoji cli's own dependencies) handle completions. Aim to generate completions for bash, zsh, and fish based on the existing CLI options.