![crates-badge] ![license-badge] ![rustc-badge]
A tool to work around some limitations on cargo.
Cargo is a great tool but has some limitations. This tool provides additional flags to avoid some of these limitations.
sh
cargo install cargo-hack
To install the current cargo-hack requires Rust 1.36 or later.
See cargo hack --help for a complete list of options (output is here).
cargo-hack is basically wrapper of cargo that propagates subcommand and most of the passed flags to cargo, but provides additional flags and changes the behavior of some existing flags.
--each-feature
Perform for each feature which includes default features and --no-default-features of the package.
This is useful to check that each feature is working properly. (When used for this purpose, it is recommended to use with --no-dev-deps to avoid [rust-lang/cargo#4866].)
sh
cargo hack check --each-feature --no-dev-deps
--feature-powerset
Perform for the feature powerset which includes --no-default-features and
default features of the package.
This is useful to check that every combination of features is working
properly. (When used for this purpose, it is recommended to use with
--no-dev-deps to avoid [rust-lang/cargo#4866].)
sh
cargo hack check --feature-powerset --no-dev-deps
--no-dev-deps
Perform without dev-dependencies.
This is a workaround for an issue that dev-dependencies leaking into normal build ([rust-lang/cargo#4866]).
Also, this can be used as a workaround for an issue that cargo does not allow publishing a package with cyclic dev-dependencies. ([rust-lang/cargo#4242])
sh
cargo hack publish --no-dev-deps --dry-run --allow-dirty
Note: Currently, using --no-dev-deps flag removes dev-dependencies from real manifest while cargo-hack is running and restores it when finished. See [rust-lang/cargo#4242] for why this is necessary.
Also, this behavior may change in the future on some subcommands. See also [#15].
--remove-dev-deps
Equivalent to --no-dev-deps except for does not restore the original Cargo.toml after execution.
This is useful to know what Cargo.toml that cargo-hack is actually using with --no-dev-deps.
This flag also works without subcommands.
--ignore-private
Skip to perform on publish = false packages.
--ignore-unknown-features
Skip passing --features to cargo if that feature does not exist.
This feature was formerly called --ignore-non-exist-features, but has been renamed. The old name can be used as an alias, but is deprecated.
--clean-per-run
Remove artifacts for that package before running the command.
The following flags can be used with --each-feature and --feature-powerset.
--optional-deps
Use optional dependencies as features.
--skip
Space-separated list of features to skip.
To skip run of default feature, using value --skip default.
--skip-no-default-features
Skip run of just --no-default-features flag.
--depth
Specify a max number of simultaneous feature flags of --feature-powerset.
If the number is set to 1, --feature-powerset is equivalent to --each-feature.
cargo-hack changes the behavior of the following existing flags.
--features, --no-default-features
Unlike cargo ([rust-lang/cargo#3620], [rust-lang/cargo#4106], [rust-lang/cargo#4463], [rust-lang/cargo#4753], [rust-lang/cargo#5015], [rust-lang/cargo#5364], [rust-lang/cargo#6195]), it can also be applied to sub-crates.
--all, --workspace
Perform command for all packages in the workspace.
Unlike cargo, it does not compile all members at once.
For example, running cargo hack check --all in a workspace with members foo and bar behaves almost the same as the following script:
```sh
members=("foo" "bar")
for member in "${members[@]}"; do cargo check --manifest-path "${member}/Cargo.toml" done ```
Workspace members will be performed according to the order of the 'packages' fields of cargo metadata.
Licensed under either of
at your option.
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.