Plop 项目技术文档

Plop 项目技术文档

【免费下载链接】plop Consistency Made Simple 项目地址: https://gitcode.com/gh_mirrors/pl/plop

1. 安装指南

1.1 将 Plop 添加到项目

首先，你需要将 Plop 作为开发依赖安装到你的项目中：

$ npm install --save-dev plop

1.2 全局安装 Plop（可选，推荐）

为了方便在任何地方使用 Plop，你可以选择全局安装：

$ npm install -g plop

1.3 创建 Plopfile

在项目的根目录下创建一个名为 plopfile.js 的文件，并添加以下内容：

module.exports = function (plop) {
    // 创建生成器
    plop.setGenerator('basics', {
        description: '这是一个基础plopfile模板',
        prompts: [], // 确认问题数组
        actions: []  // 操作列表
    });
};

2. 项目的使用说明

2.1 编写 Plopfile

Plopfile 是一个简单的 Node 模块，导出一个函数，该函数接收一个 plop 对象作为参数。你可以使用 plop.setGenerator 方法来创建生成器。

module.exports = function (plop) {
    // controller generator
    plop.setGenerator('controller', {
        description: 'application controller logic',
        prompts: [{
            type: 'input',
            name: 'name',
            message: 'controller name please'
        }],
        actions: [{
            type: 'add',
            path: 'src/{{name}}.js',
            templateFile: 'plop-templates/controller.hbs'
        }]
    });
};

2.2 使用 Prompts

Plop 使用 inquirer.js 库来接受用户输入。你可以定义各种类型的问题，如输入、选择、确认等。

2.3 通过 CLI 调用

安装并配置好 Plop 后，你可以通过命令行运行 Plop。直接调用 plop 命令将会输出所有可用的生成器。你也可以使用 plop [生成器名称] 来直接调用某个生成器。

$ plop

或者

$ plop controller

2.4 直接传入参数

你可以直接在命令行中传入参数来回答生成器的问题。例如：

$ plop component "my component" react

3. 项目 API 使用文档

3.1 Plopfile API

Plopfile API 提供了一系列方法来帮助你创建和管理生成器。以下是一些常用的方法：

3.1.1 setGenerator

plop.setGenerator('generatorName', {
    description: '生成器的描述',
    prompts: [],
    actions: []
});

3.1.2 setHelper

plop.setHelper('upperCase', function (text) {
    return text.toUpperCase();
});

3.1.3 setPartial

plop.setPartial('myTitlePartial', '<h1>{{titleCase name}}</h1>');

3.1.4 setActionType

plop.setActionType('doTheThing', function (answers, config, plop) {
    // 自定义操作逻辑
});

3.1.5 setPrompt

import autocompletePrompt from 'inquirer-autocomplete-prompt';
plop.setPrompt('autocomplete', autocompletePrompt);

4. 项目安装方式

4.1 本地安装

将 Plop 作为开发依赖安装到项目中：

$ npm install --save-dev plop

4.2 全局安装

为了在任何地方使用 Plop，你可以选择全局安装：

$ npm install -g plop

4.3 创建 Plopfile

在项目的根目录下创建一个名为 plopfile.js 的文件，并添加生成器配置。

通过以上步骤，你就可以开始使用 Plop 来生成代码文件，提高开发效率。

【免费下载链接】plop Consistency Made Simple 项目地址: https://gitcode.com/gh_mirrors/pl/plop