cargo template

:toc

一个用于从现有项目或模板创建cargo项目的工具

用法

最简单的安装方式是通过 cargo install

[source,bash]

$ cargo install cargo-template

安装后，你可以这样创建新的 rust 项目

[source,bash]

$ cargo template ~/path/to/my/template my-new-project

如果你本地没有任何模板，你也可以使用我们的模板索引

[source,bash]

$ cargo template iron-basic my-new-iron-project

这需要一个网络连接，并将模板保存在 ~/.cargo/cargo-template 中。

索引和模板将被保存在你的 ~/.cargo 目录中，因此如果你知道你想要的模板就在那里，你可以将 --frozen 传递给 cargo-template 来确保它不会尝试使用网络。

使用 cargo install 安装 cargo-template 的问题之一是我们使用 cargo 来以一致的方式处理cargo配置文件。不幸的是，cargo 大部分是一个庞大的库，所以我们不能只拉入它的 cargo/config 部分，我们必须拉入并编译所有内容。由于 cargo install 在 --release 模式下构建，这意味着需要一些时间来编译 cargo。希望有一天 cargo 将会被拆分成更小的crates。

配置

默认情况下，cargo-template 将使用我们的索引，https://github.com/rusttemplates/templates.git。但可以通过编辑你的 ~/.cargo/config 文件来更改。

[source,toml]

[template.registry]
index = "https://github.com/foo/bar"

注意事项

目前这是实现此功能所需的绝对最小化版本，因此还有很多功能缺失，肯定存在一些错误。欢迎提交PR！

贡献模板

如果你想向我们贡献模板，谢谢！以下是你可以这样做的方式

1. 分叉并检出模板注册表，https://github.com/rusttemplates/templates
2. 打开 index.json 文件，然后在 index 数组中添加一个包含您的模板的 name 和 loc（位置）的对象。
3. 在索引处打开一个拉取请求
4. 享受您的出色之处！