Crate cli_xtask

source · [−]

Expand description

A collection of utility functions and command line interfaces for cargo-xtask.

This crate provides the following utilities:

cargo xtask dist and related subcommands
- Builds a distributable tar.gz package for your bin crate.
cargo xtask lint and related subcommands
- Runs the lints for your bin/lib crate.
- Integrated with rustdoc, rustfmt, clippy, cargo-rdme, cargo-udeps.
cargo xtask tidy and related subcommands
- Fixes the problems on your bin/lib crate.
- Integrated with rustfmt, clippy, cargo-rdme.
cargo xtask pre-release
- Checks if your bin/lib crate is ready for a release.
cargo xtask build, clippy, doc, fmt, test
- Runs the cargo commands with options useful for testing and continuous integration.
  - --all-workspaces - Runs the cargo commands for all workspaces.
  - --workspace - Runs the cargo commands for all packages in the workspace.
  - --each-features - Repeats to runs the cargo commands for each feature enabled.
  - --exhaustive - Same as --all-workspaces --workspace --each-features.
cargo xtask docsrs
- - Builds the documentation for your lib crate with configuration for docs.rs.
cargo xtask exec
- Runs a command in the gicontext of all workspaces.

Usage

First, create an xtask crate following the instructions on the cargo-xtask website.

Then, run the following command to add cli-xtask to the dependencies.

For bin crates:

cargo add -p xtask cli-xtask --features main,bin-crate

If you want to use extra tools such as cargo-rdme and cargo-udeps, add the bin-crate-extra feature.

cargo add -p xtask cli-xtask --features main,bin-crate,bin-crate-extra

For lib crates:

cargo add -p xtask cli-xtask --features main,lib-crate

If you want to use extra tools such as cargo-rdme and cargo-udeps, add the lib-crate-extra feature.

cargo add -p xtask cli-xtask --features main,lib-crate,lib-crate-extra

Finally, edit xtask/src/main.rs as follows

use cli_xtask::{Result, Xtask};

fn main() -> Result<()> {
    <Xtask>::main()
}

Now you can run various workflows with cargo xtask.

Customizing

If you want to remove the subcommands that are not useful for your project, you can remove them by disabling the corresponding cargo features. See the Feature flags section for more information.

If you want to add the subcommands that are not included in this crate, you can add them by creating a new data structure that implements the clap::Subcommand and Run. See the documentation of Xtask for more information.

Feature flags

By using the features flags of cli-xtask, you can enable only the features and commands you need. By default, all features are disabled.

The following section contains a list of available features:

CLI features

main - Enables main function and main_with_config function that are the premade entry point for the CLI.
error-handler - Enables functions for error handling in error_handler module.
logger - Enables functions for logging in logger module.

Subcommand features

There are two types of features that enable subcommands:

Combined features - features that enable several useful subcommands at once, depending on the type of crate
Separated features - features that enable each subcommand separately

Combined features

bin-crate:- Enables useful subcommands for bin crates.
lib-crate - Enables useful subcommands for lib crates.
bin-crate-extra - Enables the additional subcommands useful for bin crates.
lib-crate-extra - Enables the additional subcommands useful for lib crates.

The {bin,lib}-crate feature requires only the standard Rust tools that can be installed with rustup. The {bin,lib}-crate-extra feature may require third-party tools.

Separated features

The following features require only the standard Rust tools:

subcommand-build - Enables cargo xtask build.
subcommand-clippy - Enables cargo xtask clippy.
subcommand-dist - Enables cargo xtask dist.
subcommand-dist-archive - Enables cargo xtask dist-archive.
subcommand-dist-build-bin - Enables cargo xtask dist-build-bin.
subcommand-dist-build-completion - Enables cargo xtask dist-build-completion.
subcommand-dist-build-doc - Enables cargo xtask dist-build-doc.
subcommand-dist-build-license - Enables cargo xtask dist-build-license.
subcommand-dist-build-man - Enables cargo xtask dist-build-man.
subcommand-dist-build-readme - Enables cargo xtask dist-build-readme.
subcommand-dist-clean - Enables cargo xtask dist-clean.
subcommand-doc - Enables cargo xtask doc.
subcommand-docsrs - Enables cargo xtask docsrs.
subcommand-exec - Enables cargo xtask exec.
subcommand-fmt - Enables cargo xtask fmt.
subcommand-lint - Enables cargo xtask lint.
subcommand-pre-release - Enables cargo xtask pre-release.
subcommand-test - Enables cargo xtask test.
subcommand-tidy - Enables cargo xtask tidy.

The following features require third-party tools:

subcommand-rdme - Enables cargo xtask rdme. Requires cargo-rdme installed.
subcommand-udeps - Enables cargo xtask udeps. Requires cargo-udeps installed.

Other features

archive - Enables archive module which provides the functionality to create the archive file for distribution.

Minimum supported Rust version (MSRV)

The minimum supported Rust version is Rust 1.60.0. At least the last 3 versions of stable Rust are supported at any given time.

While a crate is a pre-release status (0.x.x) it may have its MSRV bumped in a patch release. Once a crate has reached 1.x, any MSRV bump will be accompanied by a new minor version.

License

This project is licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.