赋能敏捷开发：使用 node 和 templa-cli 轻松制作项目模板

2023-10-04 01:40:49

基于 Node 和 Templa-CLI 构建高效项目模板

简介

在软件开发过程中，我们经常遇到需要反复进行的配置和设置，例如 ESLint、TSconfig.json 等。为了提高效率，我们可以利用 Node 和 Templa-CLI 创建动态模板工具，省去重复设置的繁琐步骤。本文将深入探讨如何利用这些技术构建一个自定义模板工具。

安装 Node 和 Templa-CLI

首先，确保在你的计算机上已安装 Node.js 和 Templa-CLI。通过以下命令进行安装：

npm install -g node
npm install -g templa-cli

创建模板项目

使用 Templa-CLI 创建一个新的模板项目：

templa-cli new my-template

编写模板文件

在创建的模板项目中，找到 template.js 文件。这是模板的核心，用于定义模板的结构和内容。

例如，以下是一个简单的 ESLint 模板：

module.exports = {
  files: [
    '.eslintrc.js',
    '.eslintignore'
  ],
  content: {
    '.eslintrc.js': `{
      "extends": "eslint:recommended",
      "rules": {
        "semi": ["error", "always"]
      }
    }`
  }
};

定义模板变量

模板变量允许你在模板文件中使用动态内容。Templa-CLI 支持以下类型的变量：

常量变量： 用 {{CONSTANT_NAME}} 表示，只能在模板文件中使用。
环境变量： 用 {{ENV_VARIABLE_NAME}} 表示，可以访问运行模板时的环境变量。
用户输入变量： 用 {{USER_INPUT_NAME}} 表示，可以从用户那里收集输入。

例如，我们可以使用环境变量动态生成项目名称：

module.exports = {
  files: [
    '{{ENV_PROJECT_NAME}}/package.json'
  ],
  content: {
    '{{ENV_PROJECT_NAME}}/package.json': `{
      "name": "{{ENV_PROJECT_NAME}}",
      "version": "1.0.0"
    }`
  }
};

创建 Node 脚本

我们需要创建一个 Node 脚本来使用 Templa-CLI 渲染模板。创建一个名为 run.js 的文件：

const templa = require('templa-cli');

// 创建渲染器
const renderer = templa.createRenderer({
  template: 'template.js'
});

// 渲染模板，并提供用户输入变量
const result = await renderer.render({
  USER_PROJECT_NAME: 'my-project'
});

// 输出渲染结果
console.log(result);