Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use cargo metadata instead of manual manifest validation #17

Merged
merged 1 commit into from
Nov 10, 2019
Merged

Use cargo metadata instead of manual manifest validation #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ jobs:
run: |
cargo test
- name: cargo hack
shell: bash
run: |
cargo run -- hack check --each-feature --no-dev-deps
cargo run -- hack --remove-dev-deps
Expand Down
55 changes: 45 additions & 10 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ A tool to work around some limitations on cargo.

[dependencies]
anyhow = "1.0.19"
serde = { version = "1.0.102", features = ["derive"] }
serde_json = "1.0.41"
termcolor = "1.0.5"
toml_edit = "0.1.5"
indexmap = "1.3.0"

[dev-dependencies]
easy-ext = "0.1.6"
32 changes: 17 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,15 @@ cargo install cargo-hack

To install the current cargo-hack requires Rust 1.36 or later.

*Note: cargo-hack is currently only tested on Linux and macOS. It may not work well on other platforms. See [#3] for Windows support.*

## Usage

`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 `--no-default-features` and default features* of the package.
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`.*)
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 [cargo#4866].)

```sh
cargo hack check --each-feature --no-dev-deps
Expand All @@ -48,20 +46,22 @@ To install the current cargo-hack requires Rust 1.36 or later.

This is a workaround for an issue that dev-dependencies leaking into normal build ([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. ([cargo#4242])

```sh
cargo hack publish --no-dev-deps --dry-run --allow-dirty
```

Currently, using `--no-dev-deps` flag removes dev-dependencies from real manifest while cargo-hack is running and restores it when finished. See [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`.

Also, this can be used as a workaround for an issue that `cargo` does not allow publishing a package with cyclic dev-dependencies. ([cargo#4242])

```sh
# This flag also works without subcommands.
cargo hack --remove-dev-deps
cargo publish --dry-run --allow-dirty
# Equivalent to `cargo hack publish --no-dev-deps --dry-run --allow-dirty`
```
*This flag also works without subcommands.*

* **`--ignore-private`**

Expand All @@ -79,7 +79,7 @@ To install the current cargo-hack requires Rust 1.36 or later.

* **`--features`**, **`--no-default-features`**

Unlike `cargo` ([cargo#3620], [cargo#4106], [cargo#4463], [cargo#4753], [cargo#5015], [cargo#5364], [cargo#6195]), it can also be applied to sub-crate.
Unlike `cargo` ([cargo#3620], [cargo#4106], [cargo#4463], [cargo#4753], [cargo#5015], [cargo#5364], [cargo#6195]), it can also be applied to sub-crates.

* **`--all`**, **`--workspace`**

Expand All @@ -92,13 +92,14 @@ To install the current cargo-hack requires Rust 1.36 or later.
members=("foo" "bar")

for member in ${members[@]}; do
cargo check --manifest-path "${member}"
cargo check --manifest-path "${member}"
done
```

*Note that there is currently no guarantee in which order workspace members will be performed.* (This means that `cargo hack publish --all --ignore-private` does not necessarily function as you intended.)
Workspace members will be performed according to the order of the 'packages' fields of [cargo-metadata].

[#3]: https://github.com/taiki-e/cargo-hack/issues/3
[#15]: https://github.com/taiki-e/cargo-hack/issues/15
[cargo#3620]: https://github.com/rust-lang/cargo/issues/3620
[cargo#4106]: https://github.com/rust-lang/cargo/issues/4106
[cargo#4463]: https://github.com/rust-lang/cargo/issues/4463
Expand All @@ -108,6 +109,7 @@ To install the current cargo-hack requires Rust 1.36 or later.
[cargo#5364]: https://github.com/rust-lang/cargo/issues/5364
[cargo#6195]: https://github.com/rust-lang/cargo/issues/6195
[cargo#4242]: https://github.com/rust-lang/cargo/issues/4242
[cargo-metadata]: https://doc.rust-lang.org/cargo/commands/cargo-metadata.html

## License

Expand Down
Loading