#toml #cargo-toml #productivity #cargo

bin+lib scaffold

Quickly add dependencies to your Rust project

7 releases (4 breaking)

0.5.1 Jul 30, 2021
0.5.0 Jul 30, 2021
0.4.0 Nov 3, 2020
0.3.0 Sep 5, 2020
0.1.2 Nov 11, 2019

#420 in Text editors

MIT license

24KB
555 lines

Scaffold

Quickly add dependencies to your existing Rust project.

I find myself always scouring the internet or looking through old projects to find the same dependencies over and over. This is a tool I made to automate that process.

Find it on crates.io

The help screen really says it all.

scaffold 0.3.0
Quickly add dependencies to your Rust project.

USAGE:
    scaffold [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -a, --ask        Ask before each dependency
    -h, --help       Prints help information
    -t, --tilde      Use tilde versioning. Instead of "1.0.104", the version becomes "~1.0". See: https://doc.rust-
                     lang.org/cargo/reference/specifying-dependencies.html#tilde-requirements
    -V, --version    Prints version information
    -v, --verbose    Be more verbose

OPTIONS:
    -g, --groups <groups-path>     [default: ~/.config/scaffold/groups.toml]
    -p, --path <toml-path>         [default: Cargo.toml]

SUBCOMMANDS:
    add     Add groups to your project.
    help    Prints this message or the help of the given subcommand(s)
    list    List all available groups.

Define custom groups

By default, scaffold will look for groups in ~/.config/scaffold/groups.toml. If this file doesn't exist, it will be created.

For the sake of convenience, groups.toml is a toml file, with the intent of looking and feeling like Cargo.toml.

Example:

[json]
serde_derive = "*"
serde_json = "*"
serde = { version = "*", features = ["derive"] }

[cli]
structopt = "*"
config = "*"
shellexpand = "*"

Note that if the version is starred, then scaffold will try to determine the latest version.

List available groups

You can list all your available groups:

$ scaffold list

Result:

cli
    config = "0.9.3"
    shellexpand = "1.0.0"
    structopt = "0.3.4"
json
    serde = { features = ["derive"], version = "1.0.102" }
    serde_derive = "1.0.102"
    serde_json = "1.0.41"

Add groups to your project

To add groups simply say:

$ scaffold --verbose add json

Result:

Adding serde = { features = ["derive"], version = "1.0.102" }.
Adding serde_derive = "1.0.102".
Adding serde_json = "1.0.41".

You can add more than one at the same time:

$ scaffold --verbose add json cli

Result:

Adding serde = { features = ["derive"], version = "1.0.102" }.
Adding serde_derive = "1.0.102".
Adding serde_json = "1.0.41".
Adding config = "0.9.3".
Adding shellexpand = "1.0.0".
Adding structopt = "0.3.4".

Asking before inserting each crate

You can also tell it to ask you before each crate to see if you want it:

$ scaffold --ask --verbose add json cli

Result:

Add config = "0.9.3"? [Y/n] y
Adding config = "0.9.3".
Add shellexpand = "1.0.0"? [Y/n] n
Add structopt = "0.3.4"? [Y/n] y
Adding structopt = "0.3.4".

Dependencies

~5–16MB
~191K SLoC