cargo/diagnostics/rules/
im_a_teapot.rs

1use std::path::Path;
2
3use cargo_util_terminal::report::AnnotationKind;
4use cargo_util_terminal::report::Group;
5use cargo_util_terminal::report::Level;
6use cargo_util_terminal::report::Origin;
7use cargo_util_terminal::report::Snippet;
8use tracing::instrument;
9
10use super::TEST_DUMMY_UNSTABLE;
11use crate::CargoResult;
12use crate::GlobalContext;
13use crate::core::Feature;
14use crate::core::Package;
15use crate::core::Workspace;
16use crate::diagnostics::DiagnosticStats;
17use crate::diagnostics::Lint;
18use crate::diagnostics::LintLevelProduct;
19use crate::diagnostics::get_key_value_span;
20use crate::diagnostics::rel_cwd_manifest_path;
21
22/// This lint is only to be used for testing purposes
23pub static LINT: &Lint = &Lint {
24    name: "im_a_teapot",
25    desc: "`im_a_teapot` is specified",
26    primary_group: &TEST_DUMMY_UNSTABLE,
27    msrv: None,
28    feature_gate: Some(Feature::test_dummy_unstable()),
29    docs: None,
30};
31
32#[instrument(skip_all)]
33pub(crate) fn lint_package(
34    _ws: &Workspace<'_>,
35    pkg: &Package,
36    path: &Path,
37    level: LintLevelProduct,
38    stats: &mut DiagnosticStats,
39    gctx: &GlobalContext,
40) -> CargoResult<()> {
41    let manifest = pkg.manifest();
42    let LintLevelProduct {
43        level: lint_level,
44        source,
45    } = level;
46
47    if manifest
48        .normalized_toml()
49        .package()
50        .is_some_and(|p| p.im_a_teapot.is_some())
51    {
52        let level = lint_level.to_diagnostic_level();
53        let manifest_path = rel_cwd_manifest_path(path, gctx);
54        let emitted_source = LINT.emitted_source(lint_level, source);
55
56        let mut desc = Group::with_title(level.primary_title(LINT.desc));
57
58        if let Some(document) = manifest.document()
59            && let Some(contents) = manifest.contents()
60        {
61            let span = get_key_value_span(document, &["package", "im-a-teapot"]).unwrap();
62
63            desc = desc.element(
64                Snippet::source(contents)
65                    .path(&manifest_path)
66                    .annotation(AnnotationKind::Primary.span(span.key.start..span.value.end)),
67            );
68        } else {
69            desc = desc.element(Origin::path(&manifest_path));
70        }
71
72        let report = &[desc.element(Level::NOTE.message(&emitted_source))];
73
74        stats.record_lint(lint_level);
75        gctx.shell().print_report(report, lint_level.force())?;
76    }
77    Ok(())
78}
cargo/diagnostics/rules/im_a_teapot.rs

cargo/diagnostics/rules/
im_a_teapot.rs
