#xtask

xtaskops

Goodies for working with the xtask concept

7 unstable releases (3 breaking)

0.4.1 Dec 25, 2022
0.4.0 Dec 18, 2022
0.3.0 Nov 29, 2022
0.2.2 Nov 11, 2022
0.1.0 Aug 9, 2022

#239 in Development tools

Download history 148/week @ 2022-11-29 87/week @ 2022-12-06 86/week @ 2022-12-13 153/week @ 2022-12-20 72/week @ 2022-12-27 114/week @ 2023-01-03 573/week @ 2023-01-10 262/week @ 2023-01-17 347/week @ 2023-01-24 307/week @ 2023-01-31 299/week @ 2023-02-07 514/week @ 2023-02-14 229/week @ 2023-02-21 1117/week @ 2023-02-28 651/week @ 2023-03-07 605/week @ 2023-03-14

2,712 downloads per month

Apache-2.0

15KB
275 lines

xtaskops

github crates.io docs.rs build status

This is a Rust library that has a few goodies for working with the xtask concept.

Dependency

[dependencies]
xtaskops = "0.4.0"

For most recent version see crates.io

Usage

You should have the xtask concept already set up for your project.

Available Tasks

Full workflow tasks for your daily development.

  • bloat_deps Show biggest crates in release build
  • bloat_time Show crate build times
  • dev Run cargo check followed by cargo test for every file change
  • ci Run typical CI tasks in series: fmt, clippy, and tests
  • coverage Run coverage
  • docs Run cargo docs in watch mode
  • install Instal cargo tools
  • powerset Perform a CI build with powerset of features

Here's an example for how to integrate the coverage task with clap:

use xtaskops::tasks;
// assuming you use `clap`
let res = match matches.subcommand() {
    Some(("coverage", sm)) => tasks::coverage(sm.is_present("dev")),
  //..

Quick start

You can include everything from xtask in your project. In your xtask/main.rs:

fn main() -> Result<(), anyhow::Error> {
    xtaskops::tasks::main()
}

Ops

Low level convenience operations, for file system operations, user input and more.

use xtaskops::ops::{remove_dir, create_dir_all, cmd};

remove_dir("target")?;
create_dir_all("target")?;
// cmd! is from the `duct` library
cmd!("cargo", "watch", "-s", "cargo doc --no-deps").run()?;
Ok(())

Running Tasks

Run:

$ cargo xtask coverage

Recommended: alias cargo xtask to x:

# in your zshrc/shell rcfile
alias x="cargo xtask"

Copyright

Copyright (c) 2022 @jondot. See LICENSE for further details.

Dependencies

~3.5–8.5MB
~146K SLoC