plop

简介

plop 是一个微型的、零配置的代码生成器，用于快速生成代码或文本文件，帮助团队保持代码一致性。

安装

文档

bash

# 最终不需要构建到项目中,只有开发使用
npm install plop --save-dev

使用

创建 plopfile.js
- 在项目根目录下创建 plopfile.js 文件，定义生成器逻辑：

javascript

// plopfile.js
module.exports = function (plop) {
    plop.setGenerator('component', {
        description: '创建一个新的组件', // 描述
        prompts: [ // 交互式命令行
            {
                type: 'input', // 输入类型：input(输入框)|list(单选)|checkbox(多选)
                name: 'name',  // 变量名称，用于模板
                message: '组件名称', // 提示
                default: 'MyComponent', // 默认值
                choices: [ // 选项（仅限 list/checkbox 类型）
                    {
                        name: 'MyComponent', // 显示名称
                        value: 'MyComponent', // 值
                        checked: true // 默认选中（仅限 checkbox 类型）
                    }
                ]
            }
        ],
        actions: (data) => { // 动作
            console.log(data); // 打印用户输入的数据
            return [
                {
                    type: 'add',  // 动作类型：add(添加文件)|modify(修改文件)
                    path: 'src/components/{{name}}/{{name}}.js', // 生成文件路径
                    templateFile: 'plop-templates/component.hbs' // 模板文件路径
                }
            ];
        }
    });
};

创建 plop-templates 目录
- 在项目根目录下创建 plop-templates 目录，定义模板文件：
- plop-templates/component.hbs

handlebars

const {{name}} = () => {
    return (
        <div>{{name}}</div>
    );
};

运行命令
- 在项目根目录下运行命令：plop
- 输入组件名称，生成组件文件：src/components/MyComponent/MyComponent.js

plop ​

简介 ​

安装 ​

使用 ​

plop

简介

安装

使用