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 (266 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (6,845 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Find the source of the error message in the addMany action handler, add validation check for missing required properties like templateFiles, and generate a more specific error message.
Tech stack
javascript
Domain
clideveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80