setuprs

• setuprs
  • 功能
  • 安装
  • 用法
    • CLI命令
    • 设置变量
      • 在模板中使用变量
    • 填充变量值
      • 示例工作流程

setuprs是一款强大的命令行界面（CLI）和文本用户界面（TUI）应用程序，旨在简化并加快创建项目快照的过程。通过利用clap.rs进行CLI功能和ratatui.rs进行TUI功能，setuprs允许用户轻松“克隆”快照框架，简化项目设置和管理。

功能

• 轻松创建快照：快速生成项目快照。
• 轻松克隆：无缝克隆项目快照的框架。
• 直观的CLI：使用clap.rs进行简单高效的命令行操作。
• 交互式TUI：由ratatui.rs提供动力的用户友好文本界面。（处于测试阶段）

安装

尚未完成，无法安装

如果你想测试测试版，请克隆并运行

用法

CLI命令

Usage: setuprs [OPTIONS] [COMMAND]

Commands:
  snapshot  Snapshot commands
  config    Configuration options
  init      Prepare folder to create a snapshot
  help      Print this message or the help of the given subcommand(s)

Options:
  -c, --config <TOML FILE>  Sets a custom config file
  -h, --help                Print help
  -V, --version             Print version

# to initialize the folder that will be a snapshot
setuprs snapshot init

# to create a snapshot of your current dir
setuprs snapshot create

# to clone a snapshot of your current dir
setuprs snapshot clone <snapshot_name_tag> -d <path_to_clone>

设置变量

setuprs允许你在setuprs.toml文件中定义变量。这使得自定义项目模板变得容易。按照以下方式定义你的变量

例如

[[variables]]
name = "variable_name"
default = "default_value"

在模板中使用变量

你可以在你的项目文件中使用这些变量，方法是将变量名放在双大括号内。例如，如果你定义了一个变量project_name，你可以在你的文件中使用它如下

{{project_name}}

填充变量值

当你克隆一个快照时，CLI会提示你输入这些变量的值。如果你不提供值，将使用setuprs.toml中指定的默认值。

示例工作流程

1. 在setuprs.toml中定义快照的标签（快照名称）以及变量

   [project]
   name = "example_snapshot"
   
   [[variables]]
   name = "project_name"
   default = "my_project"
   
   [[variables]]
   name = "author"
   

2. 在你的项目文件中使用这些变量

   // main.rs
   fn main() {
       println!("Project: {{project_name}}, Author: {{author}}");
   }
   

   // random_file.txt

   Project: {{project_name}}, Author: {{author}}
   

3. 创建快照

   setuprs snapshot create .
   

4. 克隆快照

   setuprs snapshot clone example_snapshot -d ./new_project
   

5. CLI将提示您

   Enter value for project_name [default: my_project]: 
   Enter value for author: 
   

此功能确保您可以在克隆过程中轻松快速地自定义项目脚手架。