dthree/vorpal

.catch should not trigger on a command group

Open

#64 opened on Dec 21, 2015

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (5,609 stars) (313 forks)batch import
bughelp wanted

Description

when not implementing a catch hook, typing in a command of a group gives you the help for it's subcommands.

if however you implement a catch hook, the catch hook is triggered instead.

I think it would still be useful to show the help for a command group, instead of triggering the catch.

Contributor guide

Tech stack
javascriptnodejs
Domain
cli
Issue type
bug
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsbasic Vorpal knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine Vorpal's command group and catch hook logic in the source code (likely in lib/command.js). Understand how the library distinguishes between a command group and a regular command. The current behavior triggers catch when a group is invoked; the expected behavior is to show help for the group. Modify the command execution flow to skip catch for command groups and instead display help.