plopjs/plop

Error messages could be improved for built in actions

Open

#259 创建于 2021年2月25日

在 GitHub 查看
 (3 评论) (3 反应) (0 负责人)JavaScript (6,845 star) (266 fork)batch import
enhancementgood first issue

描述

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

贡献者指南

技术栈
javascriptnodejs
领域
clideveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Plop action APIJavaScript error handling
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.
Error messages could be improved for built in actions · plopjs/plop#259 | Good First Issue