clippy_lints/src/cargo_common_metadata.rs

   1 //! lint on missing cargo common metadata
   2
   3 use std::path::PathBuf;
   4
   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;
  10
  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
  14     ///
  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.
  17     ///
  18     /// **Known problems:** None.
  19     ///
  20     /// **Example:**
  21     /// ```toml
  22     /// # This `Cargo.toml` is missing an authors field:
  23     /// [package]
  24     /// name = "clippy"
  25     /// version = "0.0.212"
  26     /// description = "A bunch of helpful lints to avoid common pitfalls in Rust"
  27     /// repository = "https://github.com/rust-lang/rust-clippy"
  28     /// readme = "README.md"
  29     /// license = "MIT OR Apache-2.0"
  30     /// keywords = ["clippy", "lint", "plugin"]
  31     /// categories = ["development-tools", "development-tools::cargo-plugins"]
  32     /// ```
  33     ///
  34     /// Should include an authors field like:
  35     ///
  36     /// ```toml
  37     /// # This `Cargo.toml` includes all common metadata
  38     /// [package]
  39     /// name = "clippy"
  40     /// version = "0.0.212"
  41     /// authors = ["Someone <someone@rust-lang.org>"]
  42     /// description = "A bunch of helpful lints to avoid common pitfalls in Rust"
  43     /// repository = "https://github.com/rust-lang/rust-clippy"
  44     /// readme = "README.md"
  45     /// license = "MIT OR Apache-2.0"
  46     /// keywords = ["clippy", "lint", "plugin"]
  47     /// categories = ["development-tools", "development-tools::cargo-plugins"]
  48     /// ```
  49     pub CARGO_COMMON_METADATA,
  50     cargo,
  51     "common metadata is defined in `Cargo.toml`"
  52 }
  53
  54 fn missing_warning(cx: &LateContext<'_>, package: &cargo_metadata::Package, field: &str) {
  55     let message = format!("package `{}` is missing `{}` metadata", package.name, field);
  56     span_lint(cx, CARGO_COMMON_METADATA, DUMMY_SP, &message);
  57 }
  58
  59 fn is_empty_str(value: &Option<String>) -> bool {
  60     value.as_ref().map_or(true, String::is_empty)
  61 }
  62
  63 fn is_empty_path(value: &Option<PathBuf>) -> bool {
  64     value.as_ref().and_then(|x| x.to_str()).map_or(true, str::is_empty)
  65 }
  66
  67 fn is_empty_vec(value: &[String]) -> bool {
  68     // This works because empty iterators return true
  69     value.iter().all(String::is_empty)
  70 }
  71
  72 declare_lint_pass!(CargoCommonMetadata => [CARGO_COMMON_METADATA]);
  73
  74 impl LateLintPass<'_> for CargoCommonMetadata {
  75     fn check_crate(&mut self, cx: &LateContext<'_>, _: &Crate<'_>) {
  76         if !run_lints(cx, &[CARGO_COMMON_METADATA], CRATE_HIR_ID) {
  77             return;
  78         }
  79
  80         let metadata = unwrap_cargo_metadata!(cx, CARGO_COMMON_METADATA, false);
  81
  82         for package in metadata.packages {
  83             if is_empty_vec(&package.authors) {
  84                 missing_warning(cx, &package, "package.authors");
  85             }
  86
  87             if is_empty_str(&package.description) {
  88                 missing_warning(cx, &package, "package.description");
  89             }
  90
  91             if is_empty_str(&package.license) && is_empty_path(&package.license_file) {
  92                 missing_warning(cx, &package, "either package.license or package.license_file");
  93             }
  94
  95             if is_empty_str(&package.repository) {
  96                 missing_warning(cx, &package, "package.repository");
  97             }
  98
  99             if is_empty_path(&package.readme) {
 100                 missing_warning(cx, &package, "package.readme");
 101             }
 102
 103             if is_empty_vec(&package.keywords) {
 104                 missing_warning(cx, &package, "package.keywords");
 105             }
 106
 107             if is_empty_vec(&package.categories) {
 108                 missing_warning(cx, &package, "package.categories");
 109             }
 110         }
 111     }
 112 }