plopjs/plop

Display description when running plop for a specific generator

Open

#186 opened on Nov 14, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (6,845 stars) (266 forks)batch import
enhancementgood first issue

Description

Hi there. Really love plop. It is making my job a lot easier now. Was wondering one thing though.

How do we get the cli to display the description for a generator before asking for all the prompts? The description is anyways in the plopfile. It would be great if we can display it in the CLI so that the person running the command would get an idea then and there rather than having to check the plopfile.

Thanks.

Contributor guide

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.
2
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsplop basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the plop generator codebase to understand how generator descriptions are defined in plopfiles and how the CLI currently outputs prompts. Look at the generator selection logic, likely in the CLI entry point, and add a line to display the description before prompting for inputs. Check the plopfile schema to confirm the description field is available and how it is used.