plopjs/plop

Error messages could be improved for built in actions

Open

#259 opened on Feb 25, 2021

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

Description

I was stuck for a while trying to get addMany to work, my issues turned out to be a minor typo in a property name. templateFile should have been templateFiles.

action:

{
  type: 'addMany',
  destination: 'generated/{{name}}',
  base: 'templates',
  templateFile: 'templates/base/**/*'
}

error message:

✖  +! You must pass a string or Handlebars AST to Handlebars.compile. You passed undefined

It would have saved me a headache if the error had informed me that I didn't have the required property templateFiles

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.
under 1 hour
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
Plop action APIJavaScript error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Look at the source code for the addMany action in the plop repository (likely src/ directory). Identify where the error from Handlebars.compile is thrown and add a validation check for the 'templateFiles' property before that point. Provide a descriptive error message listing required properties. Examine existing error messages in similar actions for consistent formatting.