Skip to content

Remove author requirement for cargo_common_metadata #7026

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 1 commit into from
Apr 5, 2021
Merged

Remove author requirement for cargo_common_metadata #7026

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
10 changes: 2 additions & 8 deletions clippy_lints/src/cargo_common_metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,24 @@ declare_clippy_lint! {
///
/// **Example:**
/// ```toml
/// # This `Cargo.toml` is missing an authors field:
/// # This `Cargo.toml` is missing a description field:
/// [package]
/// name = "clippy"
/// version = "0.0.212"
/// description = "A bunch of helpful lints to avoid common pitfalls in Rust"
/// repository = "https://github.com/rust-lang/rust-clippy"
/// readme = "README.md"
/// license = "MIT OR Apache-2.0"
/// keywords = ["clippy", "lint", "plugin"]
/// categories = ["development-tools", "development-tools::cargo-plugins"]
/// ```
///
/// Should include an authors field like:
/// Should include a description field like:
///
/// ```toml
/// # This `Cargo.toml` includes all common metadata
/// [package]
/// name = "clippy"
/// version = "0.0.212"
/// authors = ["Someone <[email protected]>"]
/// description = "A bunch of helpful lints to avoid common pitfalls in Rust"
/// repository = "https://github.com/rust-lang/rust-clippy"
/// readme = "README.md"
Expand Down Expand Up @@ -97,10 +95,6 @@ impl LateLintPass<'_> for CargoCommonMetadata {
// only run the lint if publish is `None` (`publish = true` or skipped entirely)
// or if the vector isn't empty (`publish = ["something"]`)
if package.publish.as_ref().filter(|publish| publish.is_empty()).is_none() || self.ignore_publish {
if is_empty_vec(&package.authors) {
missing_warning(cx, &package, "package.authors");
}

if is_empty_str(&package.description) {
missing_warning(cx, &package, "package.description");
}
Expand Down
6 changes: 2 additions & 4 deletions tests/ui-cargo/cargo_common_metadata/fail/src/main.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
error: package `cargo_common_metadata` is missing `package.authors` metadata
error: package `cargo_common_metadata` is missing `package.description` metadata
|
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`

error: package `cargo_common_metadata` is missing `package.description` metadata

error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata

error: package `cargo_common_metadata` is missing `package.repository` metadata
Expand All @@ -14,5 +12,5 @@ error: package `cargo_common_metadata` is missing `package.keywords` metadata

error: package `cargo_common_metadata` is missing `package.categories` metadata

error: aborting due to 7 previous errors
error: aborting due to 6 previous errors

6 changes: 2 additions & 4 deletions tests/ui-cargo/cargo_common_metadata/fail_publish/src/main.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
error: package `cargo_common_metadata` is missing `package.authors` metadata
error: package `cargo_common_metadata` is missing `package.description` metadata
|
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`

error: package `cargo_common_metadata` is missing `package.description` metadata

error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata

error: package `cargo_common_metadata` is missing `package.repository` metadata
Expand All @@ -14,5 +12,5 @@ error: package `cargo_common_metadata` is missing `package.keywords` metadata

error: package `cargo_common_metadata` is missing `package.categories` metadata

error: aborting due to 7 previous errors
error: aborting due to 6 previous errors

6 changes: 2 additions & 4 deletions tests/ui-cargo/cargo_common_metadata/fail_publish_true/src/main.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
error: package `cargo_common_metadata` is missing `package.authors` metadata
error: package `cargo_common_metadata` is missing `package.description` metadata
|
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`

error: package `cargo_common_metadata` is missing `package.description` metadata

error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata

error: package `cargo_common_metadata` is missing `package.repository` metadata
Expand All @@ -14,5 +12,5 @@ error: package `cargo_common_metadata` is missing `package.keywords` metadata

error: package `cargo_common_metadata` is missing `package.categories` metadata

error: aborting due to 7 previous errors
error: aborting due to 6 previous errors

1 change: 0 additions & 1 deletion tests/ui-cargo/cargo_common_metadata/pass/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
name = "cargo_common_metadata"
version = "0.1.0"
publish = false
authors = ["Random person from the Internet <[email protected]>"]
description = "A test package for the cargo_common_metadata lint"
repository = "https://github.com/someone/cargo_common_metadata"
readme = "README.md"
Expand Down