Clippy lint · Cargo · checked with Clippy 0.1.99

clippy::cargo_common_metadata: Checks to see if all common metadata is defined in Cargo.toml

What it meansChecks to see if all common metadata is defined in Cargo.toml. See: https://rust-lang.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata It is in the cargo group and off by default.

Does it matter?

It will be more difficult for users to discover the purpose of the crate, and key information related to it.

Checks on Cargo.toml metadata. Off by default.

How to fix it

Clippy does not fix this one automatically. Change the code by hand:

Turn it off, or on

It is off by default. To use it, set it to warn or deny:

Whole crate (Cargo.toml)

[lints.clippy]
cargo_common_metadata = "warn"

In code

#![warn(clippy::cargo_common_metadata)]

One run

cargo clippy -- -W clippy::cargo-common-metadata

The [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.

Settings in clippy.toml

cargo-ignore-publish: For internal testing only, ignores the current publish settings in the Cargo manifest.

Cargogroup

allowdefault level

nofixed by cargo clippy --fix

1.32.0added in Rust

Clippy's own documentation

What it does

Checks to see if all common metadata is defined in Cargo.toml. See: https://rust-lang.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata

Why is this bad?

It will be more difficult for users to discover the purpose of the crate, and key information related to it.

Example

[package]
name = "clippy"
version = "0.0.212"
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 a description field like:

[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"]

Configuration

cargo-ignore-publish: For internal testing only, ignores the current publish settings in the Cargo manifest.

(default: false)

From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.

Up next

Also worth your time

Did this answer your question?