1 use rustc_data_structures::fx::FxHashMap;
2 use rustc_lint::LintStore;
3 use rustc_lint_defs::{declare_tool_lint, Lint, LintId};
4 use rustc_session::{lint, Session};
6 use std::sync::LazyLock as Lazy;
8 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
9 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
10 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
13 /// A little detail easy to forget is that there is a way to set the lint level for all lints
14 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
15 /// inside this function.
17 /// It returns a tuple containing:
18 /// * Vector of tuples of lints' name and their associated "max" level
19 /// * HashMap of lint id with their associated "max" level
20 pub(crate) fn init_lints<F>(
21 mut allowed_lints: Vec<String>,
22 lint_opts: Vec<(String, lint::Level)>,
24 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
26 F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
28 let warnings_lint_name = lint::builtin::WARNINGS.name;
30 allowed_lints.push(warnings_lint_name.to_owned());
31 allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
34 lint::builtin::HardwiredLints::get_lints()
36 .chain(rustc_lint::SoftLints::get_lints().into_iter())
39 let lint_opts = lints()
41 // Permit feature-gated lints to avoid feature errors when trying to
43 if lint.feature_gate.is_some() || allowed_lints.iter().any(|l| lint.name == l) {
49 .chain(lint_opts.into_iter())
52 let lint_caps = lints()
54 // We don't want to allow *all* lints so let's ignore
56 if allowed_lints.iter().any(|l| lint.name == l) {
59 Some((lint::LintId::of(lint), lint::Allow))
63 (lint_opts, lint_caps)
66 macro_rules! declare_rustdoc_lint {
68 $(#[$attr:meta])* $name: ident, $level: ident, $descr: literal $(,)?
69 $(@feature_gate = $gate:expr;)?
72 $(#[$attr])* pub rustdoc::$name, $level, $descr
73 $(, @feature_gate = $gate;)?
78 declare_rustdoc_lint! {
79 /// The `broken_intra_doc_links` lint detects failures in resolving
80 /// intra-doc link targets. This is a `rustdoc` only lint, see the
81 /// documentation in the [rustdoc book].
83 /// [rustdoc book]: ../../../rustdoc/lints.html#broken_intra_doc_links
84 BROKEN_INTRA_DOC_LINKS,
86 "failures in resolving intra-doc link targets"
89 declare_rustdoc_lint! {
90 /// This is a subset of `broken_intra_doc_links` that warns when linking from
91 /// a public item to a private one. This is a `rustdoc` only lint, see the
92 /// documentation in the [rustdoc book].
94 /// [rustdoc book]: ../../../rustdoc/lints.html#private_intra_doc_links
95 PRIVATE_INTRA_DOC_LINKS,
97 "linking from a public item to a private one"
100 declare_rustdoc_lint! {
101 /// The `invalid_codeblock_attributes` lint detects code block attributes
102 /// in documentation examples that have potentially mis-typed values. This
103 /// is a `rustdoc` only lint, see the documentation in the [rustdoc book].
105 /// [rustdoc book]: ../../../rustdoc/lints.html#invalid_codeblock_attributes
106 INVALID_CODEBLOCK_ATTRIBUTES,
108 "codeblock attribute looks a lot like a known one"
111 declare_rustdoc_lint! {
112 /// The `missing_crate_level_docs` lint detects if documentation is
113 /// missing at the crate root. This is a `rustdoc` only lint, see the
114 /// documentation in the [rustdoc book].
116 /// [rustdoc book]: ../../../rustdoc/lints.html#missing_crate_level_docs
117 MISSING_CRATE_LEVEL_DOCS,
119 "detects crates with no crate-level documentation"
122 declare_rustdoc_lint! {
123 /// The `missing_doc_code_examples` lint detects publicly-exported items
124 /// without code samples in their documentation. This is a `rustdoc` only
125 /// lint, see the documentation in the [rustdoc book].
127 /// [rustdoc book]: ../../../rustdoc/lints.html#missing_doc_code_examples
128 MISSING_DOC_CODE_EXAMPLES,
130 "detects publicly-exported items without code samples in their documentation",
131 @feature_gate = rustc_span::symbol::sym::rustdoc_missing_doc_code_examples;
134 declare_rustdoc_lint! {
135 /// The `private_doc_tests` lint detects code samples in docs of private
136 /// items not documented by `rustdoc`. This is a `rustdoc` only lint, see
137 /// the documentation in the [rustdoc book].
139 /// [rustdoc book]: ../../../rustdoc/lints.html#private_doc_tests
142 "detects code samples in docs of private items not documented by rustdoc"
145 declare_rustdoc_lint! {
146 /// The `invalid_html_tags` lint detects invalid HTML tags. This is a
147 /// `rustdoc` only lint, see the documentation in the [rustdoc book].
149 /// [rustdoc book]: ../../../rustdoc/lints.html#invalid_html_tags
152 "detects invalid HTML tags in doc comments"
155 declare_rustdoc_lint! {
156 /// The `bare_urls` lint detects when a URL is not a hyperlink.
157 /// This is a `rustdoc` only lint, see the documentation in the [rustdoc book].
159 /// [rustdoc book]: ../../../rustdoc/lints.html#bare_urls
162 "detects URLs that are not hyperlinks"
165 declare_rustdoc_lint! {
166 /// The `invalid_rust_codeblocks` lint detects Rust code blocks in
167 /// documentation examples that are invalid (e.g. empty, not parsable as
168 /// Rust code). This is a `rustdoc` only lint, see the documentation in the
171 /// [rustdoc book]: ../../../rustdoc/lints.html#invalid_rust_codeblocks
172 INVALID_RUST_CODEBLOCKS,
174 "codeblock could not be parsed as valid Rust or is empty"
177 pub(crate) static RUSTDOC_LINTS: Lazy<Vec<&'static Lint>> = Lazy::new(|| {
179 BROKEN_INTRA_DOC_LINKS,
180 PRIVATE_INTRA_DOC_LINKS,
181 MISSING_DOC_CODE_EXAMPLES,
183 INVALID_CODEBLOCK_ATTRIBUTES,
184 INVALID_RUST_CODEBLOCKS,
187 MISSING_CRATE_LEVEL_DOCS,
191 pub(crate) fn register_lints(_sess: &Session, lint_store: &mut LintStore) {
192 lint_store.register_lints(&**RUSTDOC_LINTS);
193 lint_store.register_group(
197 RUSTDOC_LINTS.iter().map(|&lint| LintId::of(lint)).collect(),
199 for lint in &*RUSTDOC_LINTS {
200 let name = lint.name_lower();
201 lint_store.register_renamed(&name.replace("rustdoc::", ""), &name);
204 .register_renamed("intra_doc_link_resolution_failure", "rustdoc::broken_intra_doc_links");
205 lint_store.register_renamed("non_autolinks", "rustdoc::bare_urls");
206 lint_store.register_renamed("rustdoc::non_autolinks", "rustdoc::bare_urls");