plop是一个小型脚手架工具,主要用于生成项目中重复使用的基础代码模板文件
下面介绍一下plop工具的使用
1.将plop安装到项目中
yarn add plop --dev
2.在根目录创建入口文件 plopfile.js
3.在根目录创建模板文件夹 用于存放代码模板
其中的{{ name }}表示启动plop时询问用户输入的name
4.plopfile文件的配置项
// Plop 入口文件,需要导出一个函数
// 此函数接收一个 plop 对象,用于创建生成器任务
module.exports = (plop) => {
// 参数1:生成器名称 参数2:配置项
plop.setGenerator("component", {
description: "create a component",
prompts: [ //用于询问用户
{
type: "input",
name: "name",
message: "component name",
default: "MyComponent",
},
],
actions: [ // 生成代码文件的任务列表
{
type: "add", // 代表添加文件
path: "src/components/{{name}}/{{name}}.vue", //输出目录
templateFile: "plop-templates/btn.vue", //输入目录
},
],
});
};
5.启动方式
运行
yarn plop 生成器名字
运行完成,就能在指定的目标目录看到生成的代码文件