Skip to content

Prefer key.workspace = true to key = { workspace = true } #10584

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

Merged
merged 2 commits into from
Apr 20, 2022
Merged

Prefer key.workspace = true to key = { workspace = true } #10584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea79548
Prefer `field.workspace = true` to `field = { workspace = true }`
Muscraft Apr 20, 2022
a18b97f
Prefer `dependency.workspace = true` to `dependency = { workspace = t…
Muscraft Apr 20, 2022
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
9 changes: 5 additions & 4 deletions src/cargo/util/toml/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,9 @@ pub fn read_manifest_from_str(
}
if let TomlDependency::Workspace(_) = dep {
bail!(
"`workspace.dependencies.{}` specified `{{ workspace = true }}`, but \
workspace dependencies cannot do this",
"{} was specified as `workspace.dependencies.{}.workspace = true`, but \
workspace dependencies cannot specify `workspace = true`",
name,
name
);
}
Expand Down Expand Up @@ -225,7 +226,7 @@ pub enum TomlDependency<P: Clone = String> {
/// In the simple format, only a version is specified, eg.
/// `package = "<version>"`
Simple(String),
/// `package = { workspace = true }`
/// `package.workspace = true`
Workspace(TomlWorkspaceDependency),
/// The simple format is equivalent to a detailed dependency
/// specifying only a version, eg.
Expand Down Expand Up @@ -990,7 +991,7 @@ where
deserializer.deserialize_any(Visitor)
}

/// Enum that allows for the parsing of { workspace = true } in a Cargo.toml
/// Enum that allows for the parsing of `field.workspace = true` in a Cargo.toml
///
/// It allows for things to be inherited from a workspace or defined as needed
#[derive(Deserialize, Serialize, Clone, Debug)]
Expand Down
28 changes: 14 additions & 14 deletions src/doc/src/reference/unstable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1432,8 +1432,8 @@ wasm-bindgen-cli = { path = "crates/cli" }
```toml
# in a workspace member's Cargo.toml
[dependencies]
log = { workspace = true }
log2 = { workspace = true }
log.workspace = true
log2.workspace = true
```

Example 2:
Expand All @@ -1458,16 +1458,16 @@ edition = "2018"
```toml
# in a workspace member's Cargo.toml
[package]
version = { workspace = true }
authors = { workspace = true }
description = { workspace = true }
documentation = { workspace = true }
readme = { workspace = true }
homepage = { workspace = true }
repository = { workspace = true }
license = { workspace = true }
license-file = { workspace = true }
keywords = { workspace = true }
categories = { workspace = true }
publish = { workspace = true }
version.workspace = true
authors.workspace = true
description.workspace = true
documentation.workspace = true
readme.workspace = true
homepage.workspace = true
repository.workspace = true
license.workspace = true
license-file.workspace = true
keywords.workspace = true
categories.workspace = true
publish.workspace = true
```
106 changes: 53 additions & 53 deletions tests/testsuite/inheritable_workspace_fields.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Tests for inheriting Cargo.toml fields with { workspace = true }
//! Tests for inheriting Cargo.toml fields with field.workspace = true
use cargo_test_support::registry::{Dependency, Package};
use cargo_test_support::{
basic_lib_manifest, basic_manifest, git, path2url, paths, project, publish, registry,
Expand Down Expand Up @@ -119,24 +119,24 @@ fn inherit_own_workspace_fields() {
"Cargo.toml",
r#"
cargo-features = ["workspace-inheritance"]
badges = { workspace = true }
badges.workspace = true

[package]
name = "foo"
version = { workspace = true }
authors = { workspace = true }
description = { workspace = true }
documentation = { workspace = true }
homepage = { workspace = true }
repository = { workspace = true }
license = { workspace = true }
keywords = { workspace = true }
categories = { workspace = true }
publish = { workspace = true }
edition = { workspace = true }
rust-version = { workspace = true }
exclude = { workspace = true }
include = { workspace = true }
version.workspace = true
authors.workspace = true
description.workspace = true
documentation.workspace = true
homepage.workspace = true
repository.workspace = true
license.workspace = true
keywords.workspace = true
categories.workspace = true
publish.workspace = true
edition.workspace = true
rust-version.workspace = true
exclude.workspace = true
include.workspace = true

[workspace]
members = []
Expand Down Expand Up @@ -251,13 +251,13 @@ fn inherit_own_dependencies() {
authors = []

[dependencies]
dep = { workspace = true }
dep.workspace = true

[build-dependencies]
dep-build = { workspace = true }
dep-build.workspace = true

[dev-dependencies]
dep-dev = { workspace = true }
dep-dev.workspace = true

[workspace]
members = []
Expand Down Expand Up @@ -393,7 +393,7 @@ fn inherit_own_detailed_dependencies() {
authors = []

[dependencies]
dep = { workspace = true }
dep.workspace = true

[workspace]
members = []
Expand Down Expand Up @@ -501,7 +501,7 @@ fn inherit_from_own_undefined_field() {
name = "foo"
version = "1.2.5"
authors = ["rustaceans"]
description = { workspace = true }
description.workspace = true

[workspace]
members = []
Expand Down Expand Up @@ -623,27 +623,27 @@ fn inherit_workspace_fields() {
.file(
"bar/Cargo.toml",
r#"
badges = { workspace = true }
badges.workspace = true
cargo-features = ["workspace-inheritance"]
[package]
name = "bar"
workspace = ".."
version = { workspace = true }
authors = { workspace = true }
description = { workspace = true }
documentation = { workspace = true }
readme = { workspace = true }
homepage = { workspace = true }
repository = { workspace = true }
license = { workspace = true }
license-file = { workspace = true }
keywords = { workspace = true }
categories = { workspace = true }
publish = { workspace = true }
edition = { workspace = true }
rust-version = { workspace = true }
exclude = { workspace = true }
include = { workspace = true }
version.workspace = true
authors.workspace = true
description.workspace = true
documentation.workspace = true
readme.workspace = true
homepage.workspace = true
repository.workspace = true
license.workspace = true
license-file.workspace = true
keywords.workspace = true
categories.workspace = true
publish.workspace = true
edition.workspace = true
rust-version.workspace = true
exclude.workspace = true
include.workspace = true
"#,
)
.file("LICENSE", "license")
Expand Down Expand Up @@ -758,11 +758,11 @@ fn inherit_dependencies() {
version = "0.2.0"
authors = []
[dependencies]
dep = { workspace = true }
dep.workspace = true
[build-dependencies]
dep-build = { workspace = true }
dep-build.workspace = true
[dev-dependencies]
dep-dev = { workspace = true }
dep-dev.workspace = true
"#,
)
.file("bar/src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -901,9 +901,9 @@ fn inherit_target_dependencies() {
version = "0.2.0"
authors = []
[target.'cfg(unix)'.dependencies]
dep = { workspace = true }
dep.workspace = true
[target.'cfg(windows)'.dependencies]
dep = { workspace = true }
dep.workspace = true
"#,
)
.file("bar/src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -1071,7 +1071,7 @@ fn inherit_detailed_dependencies() {
version = "0.2.0"
authors = []
[dependencies]
detailed = { workspace = true }
detailed.workspace = true
"#,
)
.file("bar/src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -1116,7 +1116,7 @@ fn inherit_path_dependencies() {
version = "0.2.0"
authors = []
[dependencies]
dep = { workspace = true }
dep.workspace = true
"#,
)
.file("bar/src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -1200,13 +1200,13 @@ fn error_workspace_dependency_looked_for_workspace_itself() {
workspace = ".."

[dependencies]
dep = { workspace = true }
dep.workspace = true

[workspace]
members = ["bar"]

[workspace.dependencies]
dep = { workspace = true }
dep.workspace = true

"#,
)
Expand All @@ -1221,8 +1221,8 @@ fn error_workspace_dependency_looked_for_workspace_itself() {
[ERROR] failed to parse manifest at `[CWD]/Cargo.toml`

Caused by:
`workspace.dependencies.dep` specified `{ workspace = true }`, but workspace dependencies \
cannot do this
dep was specified as `workspace.dependencies.dep.workspace = true`, but \
workspace dependencies cannot specify `workspace = true`
",
)
.run();
Expand Down Expand Up @@ -1298,7 +1298,7 @@ fn error_no_root_workspace() {
workspace = ".."
version = "1.2.3"
authors = ["rustaceans"]
description = { workspace = true }
description.workspace = true
"#,
)
.file("src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -1347,7 +1347,7 @@ fn error_inherit_unspecified_dependency() {
version = "1.2.3"
authors = ["rustaceans"]
[dependencies]
foo = { workspace = true }
foo.workspace = true
"#,
)
.file("bar/src/main.rs", "fn main() {}")
Expand Down Expand Up @@ -1385,7 +1385,7 @@ fn workspace_inheritance_not_enabled() {
name = "foo"
version = "1.2.5"
authors = ["rustaceans"]
description = { workspace = true }
description.workspace = true

[workspace]
members = []
Expand Down Expand Up @@ -1431,7 +1431,7 @@ fn nightly_required() {
name = "foo"
version = "1.2.5"
authors = ["rustaceans"]
description = { workspace = true }
description.workspace = true

[workspace]
members = []
Expand Down