Handle cargo fmt --manifest-path when specifying the workspace's root Cargo.toml
#6524
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ytmimi
commented
Mar 29, 2025
Comment on lines
+373
to
+375
| target_manifest | ||
| .parent() | ||
| .is_some_and(|manifest| workspace_root_path == manifest), |
There was a problem hiding this comment.
The way this check is currently implemented a user could be in a sub package and run cargo fmt --manifest-path ../path/to/root/Cargo.toml and that would find all the targets in the workspace and format them. I'm not sure if that's something we want to allow, or if we should check that the user's env::current_dir() is also in the workspace's root.
There was a problem hiding this comment.
In fact, a user could be in a sub-package of one workspace (or even a non-cargo project) and specify cargo fmt --manifest-path ../../path/to/some/other/projects/Cargo.toml, and I think that'll format the files in the other project. Again, just want to double check if that's expected behavior.
The test case loads package targets from the root of a workspace.
Previously, when running `cargo fmt --manifest-path Cargo.toml` from a cargo workspace's root directory `cargo fmt` would error with a message that read `Failed to find targets`. The issue stemmed from an incorrect comparison between the path to the workspace's root **directory** and the path to the specified `Cargo.toml` **file**. This lead `cargo fmt` to incorrectly determine that the command wasn't being run from the workspace's root.
ytmimi
changed the title
cargo fmt --manifest-path when running from the workspace root with the workspace's root Cargo.tomlcargo fmt --manifest-path when specifying the workspace's root Cargo.toml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #6517
The underlying issue was an incorrect comparison between a
Cargo.tomlfile path and the workspace's root directory path. Now that we're comparing two directory pathsin_workspace_rootgets set correctly, andcargo-fmtis able to find all the workspace's package targets.PR best reviewed 1 commit at a time.