rust-script-ext
Opinionated set of extensions for use with rust-script.
Using rust-script to run Rust like a shell script is great! This crate provides an opinionated set of extensions tailored towards common patterns in scripts. These patterns include file reading, argument parsing, error handling. The goal is for script writers to focus on the business logic, not implementing parsers, handling errors, parsing arguments, etc.
$ cargo install rust-script
..
$ cat ./template.rs
#!/usr/bin/env -S rust-script -c
//! You might need to chmod +x your script!
//! ```cargo
//! [dependencies.rust-script-ext]
//! git = "https://github.com/kurtlawrence/rust-script-ext"
//! rev = "4fe5b852eb2daffb8c188774961dd9baeb7b0c72"
//! ```
use rust_script_ext::prelude::*;
fn main() {
// fastrand comes from rust_script_ext::prelude::*
let n = std::iter::repeat_with(|| fastrand::u32(1..=100))
.take(5)
.collect::<Vec<_>>();
println!("Here's 5 random numbers: {n:?}");
}
$ ./template.rs
Here's 5 random numbers: [28, 97, 9, 23, 58]
Template Quickstart
template.rs contains a simple scaffold for a rust-script[-ext]:
curl -L https://github.com/kurtlawrence/rust-script-ext/raw/main/template.rs -o my-script.rs
chmod +x my-script.rs
./my-script.rs
What's included?
What rust-script-ext provides is continually evolving. It is best to review the API documentation. At a high level, the crate provides helpers and data structures which are common in a scripting environment, such as easy error handling, file reading, serialisation/deserialisation, etc. If you find something lacking, I encourage you to open a PR!
Versioning
Versioning does not follow semver as would a normal crate. Instead, it is best to pin a script to a revision number of the repository. As most scripts are ephemeral, or at least not pushed to a large userbase, this encourages a simple versioning scheme where you will be mostly guaranteed that when you run the script, it will compile! Leaving off the revision number should also be fairly safe (cargo should lock it to a revision), but moving the script to another system or clearing the cache could potentially break compilation.
8 Aug 3, 2022
48 Dec 9, 2022
4 Apr 18, 2023
12 Nov 22, 2022
1 Jan 10, 2022
643 Jan 3, 2023
63.8k Jan 7, 2023
0 Feb 4, 2022
3 Jun 24, 2022
22 Sep 16, 2023
213 Dec 30, 2022
4 Nov 23, 2023
8 Nov 4, 2021
161 Dec 29, 2022
177 Jan 5, 2023
11 Mar 6, 2023
7 Jul 23, 2023
219 Oct 10, 2023
17 Nov 12, 2021