脚手架解密：打造你的定制 CLI 工具

2024-02-05 11:08:22

脚手架工具：揭开开发者的神秘工具

互动式命令行界面

脚手架工具与用户交互的基础是 交互式命令行界面 (CLI) 。它允许用户通过提示回答问题，从而动态生成项目结构和文件。借助 inquirer 库，我们可以轻松地创建列表、复选框和单选框，让用户选择所需选项。

灵活的模板引擎

模板引擎是脚手架工具的另一个关键组成部分。它使我们能够根据用户的输入生成文件和目录。我们使用 Handlebars 作为模板引擎，因为它简单易用，并且与 Node.js 集成良好。有了 Handlebars，我们可以使用模板文件创建动态项目结构和文件。

脚本自动化

自动化脚本 负责脚手架工具的核心操作，例如创建项目结构、安装依赖项和运行必要的命令。在我们的工具中，我们使用 npm 脚本来实现这些任务。通过定义脚本，我们可以简化开发流程，只需运行一个命令即可完成多个任务。

实例演示

为了进一步理解脚手架工具的工作原理，我们提供了一个简单的脚手架工具示例。这个工具创建一个带有 Jest 测试的 Node.js 项目：

# 安装依赖项
npm install inquirer handlebars --save
npm install jest --dev

# 创建模板
mkdir templates
touch templates/package.json
touch templates/index.js
touch templates/test.js

# 创建脚本
package.json:
{
  "scripts": {
    "create": "npx create-cli"
  }
}

# index.js
const inquirer = require("inquirer");
const handlebars = require("handlebars");
const fs = require("fs");

inquirer
  .prompt([
    {
      type: "input",
      name: "name",
      message: "What is the name of your project?"
    },
    {
      type: "input",
      name: "description",
      message: "Describe your project."
    }
  ])
  .then((answers) => {
    const template = fs.readFileSync("./templates/package.json", "utf8");
    const compiledTemplate = handlebars.compile(template);
    const result = compiledTemplate(answers);
    fs.writeFileSync("./package.json", result);
  });