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

注意：如果您想 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"。默认情况下，（辅助）被忽略，这意味着它不会直接包含在模板中。但也许在“additional_operations”之后会改变。

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

    注意："meta.json"和".proplate_aux_utils"是预先排除的。

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

• "args"：类型为Text的输入可能有一个“default_value”属性，proplate将使用它作为占位符。

• "additional_op"操作列表

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