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" 属性下枚举它们，如下所示，您可以将“文件”或“目录”枚举出来。然而，此时，其余的文件/目录变为静态

    {
      "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"操作列表

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