dors 0.0.3

No-fuss workspace-friendly task runner for cargo

🌈 Dors more, with Dorsfiles 🌂

crates.io Build Status

What is this?

A task runner for the rust and cargo ecosystem.

Especially targeted toward environments with a large cargo workspace, like embedded or cloud-based, that often contain multiple targets, tools outside of the rust ecosystem, complex deploy scripts, and CI pipelines.

Designed with the hope that easy things will be easy, and hard things will be possible.

Example

# ./Dorsfile.toml
[task.do-tests]
command = "cargo test --target x86_86-unknown-linux-gnu -- --nocapture"
$ cargo dors do-tests

Installation

$ cargo install dors

Features

Run commands on all members of a workspace:

# ./Dorsfile.toml
[task.test]
command = "echo Hello, World! from $PWD"
run-from = "members"

Set crate-specific environment variables:

# ./member-1/Dorsfile
[env]
CARGO_TARGET_DIR = "../target-member-1"

Reduce duplication by inheriting workspace commands in member crates:

# ./Dorsfile.toml
[task.check]
command = "cargo check --all-targets"
$ cd shared_code && cargo dors check

Run multi-line bash scripts:

# ./Dorsfile.toml
[task.play-go]
command = '''
url="igs.joyjoy.net 6969"
telnet $url
'''

Invoke commands before or after others:

#./Dorsfile.toml
[task.play-go]
before = ["install-telnet"]
command = "telnet igs.joyjoy.net 6969"
after = ["congratulate"]

[task.install-telnet]
command = "sudo apt-get install -y --no-install-recommends telnet"

[task.congratulate]
command = "echo 'I hope you played well!'"

Overwrite workspace-wide commands for a single workspace member:

#./Dorsfile.toml
[task.build]
command = "cargo build"
run-from = "members"
#./embedded_device/Dorsfile.toml
[task.build]
command = "cargo build --target arm-unknown-linux-gnueabi"

Skip particular members:

#./Dorsfile.toml
[task.test]
command = "cargo test"
run-from = "members"
skip-members = ["embedded_device"]

[task.clippy]
command = "cargo clippy"
run-from = "members"
only-members = ["shared_code"]

Run commands from member crate on workspace root:

# ./embedded_device/Dorsfile.toml
[task.pre-build]
run-from = "workspace-root"
command = "echo interestingstuff > target/special-file"

Run commands from arbitrary paths:

# ./Dorsfile.toml
[task.run-other-project]
run-from = { path = "../random_node_project" }
command = "npm run"

...And more! 🎩

FAQ:

Q: Will this automatically provide me with standard cargo commands?
A: Nope. A blank Dorsfile is a blank Dorsfile. It's up to you to build it out.

Q: Is this ready for production?
A: This is currently in alpha. Use at your own risk.

Q: This looks pretty similar to cargo-make. What are the differences?
A: The syntax was inspired by cargo-make, and this project was originally started due to limitations in cargo-make's workspace support. This project has different goals, a different task execution model, and a different syntax.

Q: How do you pronounce this?
A: Like 'horse'

Q: Shouldn't you just add an 'e' at the end? Like 'dorse'?
A: Never. Nope. Go to your room. Don't come out till you've learned your lesson 🙃

Q: Do I have to use this with a workspace?
A: You can use this crate with or without your crate being a workspace.

Q: What are the next steps for improvement?
A: Likely error messaging. Want something? Open an issue!

Q: Would you accept a PR?
A: Absolutely!

Q: My question wasn't answered here
A: Feel free to reach out!

An open book