1 //! lint on missing cargo common metadata
3 use std::path::PathBuf;
5 use crate::utils::{run_lints, span_lint};
6 use rustc_hir::{hir_id::CRATE_HIR_ID, Crate};
7 use rustc_lint::{LateContext, LateLintPass};
8 use rustc_session::{declare_lint_pass, declare_tool_lint};
9 use rustc_span::source_map::DUMMY_SP;
11 declare_clippy_lint! {
12 /// **What it does:** Checks to see if all common metadata is defined in
13 /// `Cargo.toml`. See: https://rust-lang-nursery.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata
15 /// **Why is this bad?** It will be more difficult for users to discover the
16 /// purpose of the crate, and key information related to it.
18 /// **Known problems:** None.
22 /// # This `Cargo.toml` is missing an authors field:
25 /// version = "0.0.212"
26 /// authors = ["Someone <someone@rust-lang.org>"]
27 /// description = "A bunch of helpful lints to avoid common pitfalls in Rust"
28 /// repository = "https://github.com/rust-lang/rust-clippy"
29 /// readme = "README.md"
30 /// license = "MIT OR Apache-2.0"
31 /// keywords = ["clippy", "lint", "plugin"]
32 /// categories = ["development-tools", "development-tools::cargo-plugins"]
34 pub CARGO_COMMON_METADATA,
36 "common metadata is defined in `Cargo.toml`"
39 fn missing_warning(cx: &LateContext<'_>, package: &cargo_metadata::Package, field: &str) {
40 let message = format!("package `{}` is missing `{}` metadata", package.name, field);
41 span_lint(cx, CARGO_COMMON_METADATA, DUMMY_SP, &message);
44 fn is_empty_str(value: &Option<String>) -> bool {
45 value.as_ref().map_or(true, String::is_empty)
48 fn is_empty_path(value: &Option<PathBuf>) -> bool {
49 value.as_ref().and_then(|x| x.to_str()).map_or(true, str::is_empty)
52 fn is_empty_vec(value: &[String]) -> bool {
53 // This works because empty iterators return true
54 value.iter().all(String::is_empty)
57 declare_lint_pass!(CargoCommonMetadata => [CARGO_COMMON_METADATA]);
59 impl LateLintPass<'_> for CargoCommonMetadata {
60 fn check_crate(&mut self, cx: &LateContext<'_>, _: &Crate<'_>) {
61 if !run_lints(cx, &[CARGO_COMMON_METADATA], CRATE_HIR_ID) {
65 let metadata = unwrap_cargo_metadata!(cx, CARGO_COMMON_METADATA, false);
67 for package in metadata.packages {
68 if is_empty_vec(&package.authors) {
69 missing_warning(cx, &package, "package.authors");
72 if is_empty_str(&package.description) {
73 missing_warning(cx, &package, "package.description");
76 if is_empty_str(&package.license) && is_empty_path(&package.license_file) {
77 missing_warning(cx, &package, "either package.license or package.license_file");
80 if is_empty_str(&package.repository) {
81 missing_warning(cx, &package, "package.repository");
84 if is_empty_path(&package.readme) {
85 missing_warning(cx, &package, "package.readme");
88 if is_empty_vec(&package.keywords) {
89 missing_warning(cx, &package, "package.keywords");
92 if is_empty_vec(&package.categories) {
93 missing_warning(cx, &package, "package.categories");