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"
  }
]

文本输入渲染如下

让我们尝试添加一个用于许可证的选择输入，并添加一些 选项

"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 用于在特定文件中替换变量绑定，这些文件被称为 动态文件

如何编写动态文件？

... 很简单：$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": [
    {
      "operations": [
        {
          "Remove": {
            "files": ["SIMPLY_DELETE"]
          }
        }
      ]
    }
  ]
}

MIT License

Copyright (c) 2024 $author

...

{
  "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