Proplate 🛠⚙

每次开始使用相同技术的项目时，放弃设置环境；相反，一次性制作一个模板，并利用它为所有未来的项目。

目录

1. 安装
2. 使用模板创建项目
3. 创建自己的模板
   • 参考
   • 实践学习
     • 最小的模板配置
     • 参数
     • 上下文绑定
   • 一些额外功能

安装

先决条件： git

Github 发布

您可以从 发布页面 下载它。
我建议在您的终端中将其设置为全局可用。 (wip: install.sh)

Cargo

如果您已安装 cargo

cargo install proplate

cargo 将直接将其添加到您的 $PATH 中

使用模板创建项目

proplate create --template <location> --dest <output_dir>

location 可以是一个 Github 仓库或本地目录

为了测试目的，我将留下此模板 https://github.com/YumeT023/proplate-simple-npm-template
运行以下命令从上述模板开始您的项目

proplate create --template https://github.com/YumeT023/proplate-simple-npm-template --dest your-project-name

NB: 如果您希望 proplate 为您初始化 git 仓库，请添加 --git

此时，... 与 Proplate 对话:D

创建自己的模板

参考

• Proplate 模板是一个包含 meta.json 的目录

实践学习

示例模板可以在 https://github.com/YumeT023/proplate/tree/master/examples/learn-by-doing 找到

最小的模板配置

最小的配置如下

{
  "id": "initial-template",
  "args": []
}

参数

"args" 是什么意思？

Proplate 使用它们在模板初始化期间创建交互式提示。

您可以使用 Proplate 获取两种输入： Select 和 Text。

"args": [
  {
    "key": "project_name",
    "q_type": "Text",
    "label": "Enter your project name"
  }
]

文本输入渲染如下

让我们尝试为许可证添加一个具有一些 options 的选择输入

"args": [
  {
    "key": "project_name",
    "q_type": "Text",
    "label": "Enter your project name"
  },
  {
    "key": "license",
    "q_type": "Select",
    "label": "Select a license for your project",
    "options": ["MIT", "BSD-2-Clause", "none"]
  }
]

选择输入渲染如下

...但现在...是什么？args是什么：( ?

上下文绑定

args或context用于替换特定文件中的变量绑定，这些文件被称为dynamic files

如何编写动态文件？

...非常简单：$var_name，在我们的例子中$license和$project_name

让我们添加一个动态文件README.md，如下所示

README.md

# $project_name

licensed under $license

运行proplate

proplate create --template learn-by-doing --dest dynamic-uh

让我们打开输出 dynamic-uh/README.md

...

我们做到了 ✨

我该如何告诉proplate我想直接写入$not-binding呢？

只需转义它们 -uh

README.md

# $project_name

licensed under $license

hey proplate, leave this one \$not-binding

我的意思是...

您可以创建任意数量的文件并添加绑定，Proplate会处理它们

更多关于动态文件的信息

附加操作

有时，您想做的不仅仅是替换动态文件。Proplate已经为您准备好了。

目前，proplate支持2个基本的fs操作：Remove、Copy、CopyDir

这些操作在"additional_operations"下列举

...比如说，我们只是想没有任何理由地删除一些东西

将文件SIMPLY_DELETE添加到您的模板目录中。

{
  "additional_operations": [
    {
      "operations": [
        {
          "Remove": {
            "files": ["SIMPLY_DELETE"]
          }
        }
      ]
    }
  ]
}

您可以在"operations"下添加任意数量的操作

...但是等等，"additional_operations"有点奇怪...为什么不直接忽略SIMPLY_DELETE文件呢？

在执行条件操作时，删除和复制变得更加实用... Proplate可以做到这一点！！

让我们稍微修改一下模板

将MIT添加到".proplate_aux_utils"目录中（该目录默认忽略更多信息

MIT

添加$author绑定；)

MIT License

Copyright (c) 2024 $author

...

现在，只有在选择MIT许可时，才将MIT复制到LICENSE文件中

{
  "args": [
    {
      "key": "author",
      "q_type": "Text",
      "label": "Who is da author"
    }
    ...
  ],
  "additional_operations": [
    {
      "conditions": [
        {
          "lhs": "$license",
          "op": "Eq",
          "rhs": "MIT"
        }
      ],
      "operations": [
        {
          "Copy": {
            "file": ".proplate_aux_utils/MIT",
            "dest": "LICENSE"
          }
        }
      ]
    }
    ...
  ]
}

proplate create --template learn-by-doing --dest additional-op-uh

支持的条件操作有：Eq、NotEq

-您可能会说-

我们为什么不运行一些bash脚本-uh？...为了您的安全，不

一些额外功能

• "dynamic_files"：如果您不包含此属性，proplate将把模板文件视为动态的。

  • 对于更大的模板，您可能希望指定确切的动态文件。您可以在"dynamic_files"属性下列举它们，如下所示您可以选择列举"files"或"directories"。然而，此时，其余的文件/目录变为静态

    {
      "dynamic_files": ["package.json", "directory"]
      ...
    }
    

• "exclude"：我之前告诉过您，".proplate_aux_utils"。（辅助）默认忽略，这意味着它不会直接包含在模板中。但在“附加操作”期间，可能会被忽略

  • 您也可以在"exclude"下添加您自己的辅助目录/文件。

    注意：以下文件已被预排除 "meta.json" 和 ".proplate_aux_utils"

    {
      "exclude": [".git", "node_modules"]
      ...
    }
    

• "args"：输入类型为 Text 的 "default_value" 属性可以被 proplate 用作占位符

• "additional_op" 操作列表

  • 复制 { 文件，目标 }
  • 复制目录 { 路径，目标 }
  • 删除 { 文件 }