1 个不稳定版本
| 0.1.0 | 2022年3月9日 |
|---|
#529 in 模板引擎
46KB
85 行
Cakecutter
从预构建的蛋糕（模板）创建项目！支持文件、包、内容、运行命令等！
Cakecutter是一个实用工具，可以从预构建的模板快速设置项目。
所有模板文件都是.toml格式，这意味着它们很容易编辑并与他人共享。
这是一个Python项目演示
注意它如何创建文件并运行VENV命令来初始化虚拟环境，并开始安装依赖项 
功能
- 从预构建的蛋糕（模板）创建项目并创建自己的！
- 支持所有语言（Python、Js、Rust、Go等。）
- 跨平台
- 超快⚡
- 从GitHub获取蛋糕或使用本地的Cakefile
安装
cargo install cakecutter
用法
cakecutter [TEMPLATE_NAME]
您还可以使用GitHub上的蛋糕（如果仓库根目录中有Cake.toml文件）
cakecutter https://github.com/dhravya/cakecutter
制作自己的Cakefile
制作自己的蛋糕文件非常简单。有4个主要部分
[metadata]
[filestructure]
[content]
[commands]
基本规则
由于TOML不支持.和/作为键，我们使用-和--代替。
所以，而不是main.py，我们使用main-py，而不是src/main.py，我们使用src--main-py
元数据
元数据是可选的，但如果包含它，请确保包含以下内容
name：蛋糕的名称version：蛋糕版本description：蛋糕的用途author：蛋糕的作者
文件结构
文件结构是您定义项目结构的地方。
要将当前目录中的文件包含进来，请将它们放入root列表中，如下所示：root = [".gitignore", "Cargo.toml", "README.md", "LICENSE"]
对于其他每个目录，使用以下语法：directory_name = [file1, file2] 因此，对于这个存储库，它看起来是这样的
root = [".gitignore", "Cargo.toml", "README.md", "LICENSE"]
examples = ["Python.toml"]
内容
内容是您定义文件内容的地方。它很简单，只需写出文件名（遵循基本规则）以及文件名之后的文件内容
[content]
src--main-py = """
print("Hello World")
"""
这将使用字符串的内容填充文件src/main.py
命令
这些是在制作蛋糕时运行的命令（例如安装依赖项）
这里所有的键都应该是从1开始的数字，并逐步递增。
命令应像在Dockerfile中编写的那样编写
以下是一个示例
[commands]
1 = ['python', '-m', 'venv', 'venv']
2 = ['pip', 'install', '-r', 'requirements.txt']
3 = ['python', 'src/main.py']
许可证
此项目受MIT许可证许可
展示你的支持
如果你喜欢这个项目，请留下⭐
使用README Generator by Dhravya Shah（用💖制作的readme）
依赖项
~6–14MB
~186K SLoC