Move internal lints to their own crate

Author: Jarcho

Cargo.toml

@@ -23,6 +23,7 @@ path = "src/driver.rs"
 [dependencies]
 clippy_config = { path = "clippy_config" }
 clippy_lints = { path = "clippy_lints" }
+clippy_internal_lints = { path = "clippy_internal_lints", optional = true }
 rustc_tools_util = "0.3.0"
 tempfile = { version = "3.3", optional = true }
 termize = "0.1"
@@ -51,9 +52,9 @@ tokio = { version = "1", features = ["io-util"] }
 rustc_tools_util = "0.3.0"
 
 [features]
-deny-warnings = ["clippy_lints/deny-warnings"]
-integration = ["tempfile"]
-internal = ["clippy_lints/internal", "tempfile"]
+deny-warnings = ["clippy_lints/deny-warnings", "clippy_internal_lints?/deny-warnings"]
+integration = ["dep:tempfile"]
+internal = ["dep:clippy_internal_lints", "dep:tempfile"]
 
 [package.metadata.rust-analyzer]
 # This package uses #[feature(rustc_private)]

clippy_deprecated_lints/Cargo.toml

@@ -0,0 +1,4 @@
+[package]
+name = "clippy_deprecated_lints"
+version = "0.0.1"
+edition = "2021"

clippy_lints/src/deprecated_lints.rs renamed to clippy_deprecated_lints/src/lib.rs

@@ -43,17 +43,16 @@ fn generate_lint_files(
     deprecated_lints: &[DeprecatedLint],
     renamed_lints: &[RenamedLint],
 ) {
-    let internal_lints = Lint::internal_lints(lints);
-    let mut usable_lints = Lint::usable_lints(lints);
-    usable_lints.sort_by_key(|lint| lint.name.clone());
+    let mut lints = lints.to_owned();
+    lints.sort_by_key(|lint| lint.name.clone());
 
     replace_region_in_file(
         update_mode,
         Path::new("README.md"),
         "[There are over ",
         " lints included in this crate!]",
         |res| {
-            write!(res, "{}", round_to_fifty(usable_lints.len())).unwrap();
+            write!(res, "{}", round_to_fifty(lints.len())).unwrap();
         },
     );
 
@@ -63,7 +62,7 @@ fn generate_lint_files(
         "[There are over ",
         " lints included in this crate!]",
         |res| {
-            write!(res, "{}", round_to_fifty(usable_lints.len())).unwrap();
+            write!(res, "{}", round_to_fifty(lints.len())).unwrap();
         },
     );
 
@@ -73,7 +72,7 @@ fn generate_lint_files(
         "<!-- begin autogenerated links to lint list -->\n",
         "<!-- end autogenerated links to lint list -->",
         |res| {
-            for lint in usable_lints
+            for lint in lints
                 .iter()
                 .map(|l| &*l.name)
                 .chain(deprecated_lints.iter().filter_map(|l| l.name.strip_prefix("clippy::")))
@@ -92,7 +91,7 @@ fn generate_lint_files(
         "// begin lints modules, do not remove this comment, it’s used in `update_lints`\n",
         "// end lints modules, do not remove this comment, it’s used in `update_lints`",
         |res| {
-            for lint_mod in usable_lints.iter().map(|l| &l.module).unique().sorted() {
+            for lint_mod in lints.iter().map(|l| &l.module).unique().sorted() {
                 writeln!(res, "mod {lint_mod};").unwrap();
             }
         },
@@ -101,7 +100,7 @@ fn generate_lint_files(
     process_file(
         "clippy_lints/src/declared_lints.rs",
         update_mode,
-        &gen_declared_lints(internal_lints.iter(), usable_lints.iter()),
+        &gen_declared_lints(lints.iter()),
     );
 
     let content = gen_deprecated_lints_test(deprecated_lints);
@@ -112,10 +111,9 @@ fn generate_lint_files(
 }
 
 pub fn print_lints() {
-    let (lint_list, _, _) = gather_all();
-    let usable_lints = Lint::usable_lints(&lint_list);
-    let usable_lint_count = usable_lints.len();
-    let grouped_by_lint_group = Lint::by_lint_group(usable_lints.into_iter());
+    let (lints, _, _) = gather_all();
+    let lint_count = lints.len();
+    let grouped_by_lint_group = Lint::by_lint_group(lints.into_iter());
 
     for (lint_group, mut lints) in grouped_by_lint_group {
         println!("\n## {lint_group}");
@@ -127,7 +125,7 @@ pub fn print_lints() {
         }
     }
 
-    println!("there are {usable_lint_count} lints");
+    println!("there are {lint_count} lints");
 }
 
 /// Runs the `rename_lint` command.
@@ -191,11 +189,14 @@ pub fn rename(old_name: &str, new_name: &str, uplift: bool) {
         .into_iter()
         .map(Result::unwrap)
         .filter(|f| {
-            let name = f.path().file_name();
-            let ext = f.path().extension();
-            (ext == Some(OsStr::new("rs")) || ext == Some(OsStr::new("fixed")))
-                && name != Some(OsStr::new("rename.rs"))
-                && name != Some(OsStr::new("deprecated_lints.rs"))
+            let path = f.path();
+            path.extension().is_some_and(|ext| ext == "rs" || ext == "fixed")
+                && !(path.file_name().is_some_and(|n| n == "lib.rs")
+                    && path
+                        .parent()
+                        .and_then(|p| p.parent())
+                        .and_then(|p| p.file_name())
+                        .is_some_and(|name| name == "clippy_deprecated_lints"))
         })
     {
         rewrite_file(file.path(), |s| {
@@ -204,7 +205,7 @@ pub fn rename(old_name: &str, new_name: &str, uplift: bool) {
     }
 
     let version = crate::new_lint::get_stabilization_version();
-    rewrite_file(Path::new("clippy_lints/src/deprecated_lints.rs"), |s| {
+    rewrite_file(Path::new("clippy_deprecated_lints/src/lib.rs"), |s| {
         insert_at_marker(
             s,
             "// end renamed lints. used by `cargo dev rename_lint`",
@@ -289,10 +290,7 @@ pub fn rename(old_name: &str, new_name: &str, uplift: bool) {
             &replacements[0..1]
         };
 
-        // Don't change `clippy_utils/src/renamed_lints.rs` here as it would try to edit the lint being
-        // renamed.
-        for (_, file) in clippy_lints_src_files().filter(|(rel_path, _)| rel_path != OsStr::new("deprecated_lints.rs"))
-        {
+        for (_, file) in clippy_lints_src_files() {
             rewrite_file(file.path(), |s| replace_ident_like(s, replacements));
         }
 
@@ -306,7 +304,7 @@ pub fn rename(old_name: &str, new_name: &str, uplift: bool) {
 /// Runs the `deprecate` command
 ///
 /// This does the following:
-/// * Adds an entry to `deprecated_lints.rs`.
+/// * Adds an entry to `clippy_deprecated_lints/src/lib.rs`.
 /// * Removes the lint declaration (and the entire file if applicable)
 ///
 /// # Panics
@@ -336,7 +334,7 @@ pub fn deprecate(name: &str, reason: &str) {
         mod_path
     };
 
-    let deprecated_lints_path = &*clippy_project_root().join("clippy_lints/src/deprecated_lints.rs");
+    let deprecated_lints_path = &*clippy_project_root().join("clippy_deprecated_lints/src/lib.rs");
 
     if remove_lint_declaration(stripped_name, &mod_path, &mut lints).unwrap_or(false) {
         let version = crate::new_lint::get_stabilization_version();
@@ -541,22 +539,6 @@ impl Lint {
         }
     }
 
-    /// Returns all non-deprecated lints and non-internal lints
-    #[must_use]
-    fn usable_lints(lints: &[Self]) -> Vec<Self> {
-        lints
-            .iter()
-            .filter(|l| !l.group.starts_with("internal"))
-            .cloned()
-            .collect()
-    }
-
-    /// Returns all internal lints
-    #[must_use]
-    fn internal_lints(lints: &[Self]) -> Vec<Self> {
-        lints.iter().filter(|l| l.group == "internal").cloned().collect()
-    }
-
     /// Returns the lints in a `HashMap`, grouped by the different lint groups
     #[must_use]
     fn by_lint_group(lints: impl Iterator<Item = Self>) -> HashMap<String, Vec<Self>> {
@@ -593,23 +575,14 @@ impl RenamedLint {
 
 /// Generates the code for registering lints
 #[must_use]
-fn gen_declared_lints<'a>(
-    internal_lints: impl Iterator<Item = &'a Lint>,
-    usable_lints: impl Iterator<Item = &'a Lint>,
-) -> String {
-    let mut details: Vec<_> = internal_lints
-        .map(|l| (false, &l.module, l.name.to_uppercase()))
-        .chain(usable_lints.map(|l| (true, &l.module, l.name.to_uppercase())))
-        .collect();
+fn gen_declared_lints<'a>(lints: impl Iterator<Item = &'a Lint>) -> String {
+    let mut details: Vec<_> = lints.map(|l| (&l.module, l.name.to_uppercase())).collect();
     details.sort_unstable();
 
     let mut output = GENERATED_FILE_COMMENT.to_string();
     output.push_str("pub(crate) static LINTS: &[&crate::LintInfo] = &[\n");
 
-    for (is_public, module_name, lint_name) in details {
-        if !is_public {
-            output.push_str("    #[cfg(feature = \"internal\")]\n");
-        }
+    for (module_name, lint_name) in details {
         let _: fmt::Result = writeln!(output, "    crate::{module_name}::{lint_name}_INFO,");
     }
     output.push_str("];\n");
@@ -669,13 +642,12 @@ fn gather_all() -> (Vec<Lint>, Vec<DeprecatedLint>, Vec<RenamedLint>) {
         } else {
             module.strip_suffix(".rs").unwrap_or(&module)
         };
-
-        if module == "deprecated_lints" {
-            parse_deprecated_contents(&contents, &mut deprecated_lints, &mut renamed_lints);
-        } else {
-            parse_contents(&contents, module, &mut lints);
-        }
+        parse_contents(&contents, module, &mut lints);
     }
+    let contents = fs::read_to_string(clippy_project_root().join("clippy_deprecated_lints/src/lib.rs"))
+        .unwrap_or_else(|e| panic!("Cannot read from `clippy_deprecated_lints/src/lib.rs`: {e}"));
+    parse_deprecated_contents(&contents, &mut deprecated_lints, &mut renamed_lints);
+
     (lints, deprecated_lints, renamed_lints)
 }
 
@@ -999,41 +971,6 @@ mod tests {
         assert_eq!(expected, result);
     }
 
-    #[test]
-    fn test_usable_lints() {
-        let lints = vec![
-            Lint::new(
-                "should_assert_eq2",
-                "Not Deprecated",
-                "\"abc\"",
-                "module_name",
-                Range::default(),
-            ),
-            Lint::new(
-                "should_assert_eq2",
-                "internal",
-                "\"abc\"",
-                "module_name",
-                Range::default(),
-            ),
-            Lint::new(
-                "should_assert_eq2",
-                "internal_style",
-                "\"abc\"",
-                "module_name",
-                Range::default(),
-            ),
-        ];
-        let expected = vec![Lint::new(
-            "should_assert_eq2",
-            "Not Deprecated",
-            "\"abc\"",
-            "module_name",
-            Range::default(),
-        )];
-        assert_eq!(expected, Lint::usable_lints(&lints));
-    }
-
     #[test]
     fn test_by_lint_group() {
         let lints = vec![

clippy_dev/src/update_lints.rs

@@ -0,0 +1,22 @@
+[package]
+name = "clippy_internal_lints"
+version = "0.0.1"
+edition = "2021"
+
+[dependencies]
+clippy_deprecated_lints = { path = "../clippy_deprecated_lints" }
+clippy_config = { path = "../clippy_config" }
+clippy_utils = { path = "../clippy_utils" }
+itertools = "0.12"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = { version = "1.0" }
+tempfile = { version = "3.3.0" }
+regex = { version = "1.5" }
+rustc-semver = "1.1"
+
+[features]
+deny-warnings = ["clippy_config/deny-warnings", "clippy_utils/deny-warnings"]
+
+[package.metadata.rust-analyzer]
+# This crate uses #[feature(rustc_private)]
+rustc_private = true

clippy_internal_lints/Cargo.toml

@@ -1,12 +1,13 @@
-use crate::utils::internal_lints::lint_without_lint_pass::is_lint_ref_type;
+use crate::lint_without_lint_pass::is_lint_ref_type;
 use clippy_utils::diagnostics::span_lint_and_help;
 use regex::Regex;
 use rustc_ast as ast;
 use rustc_hir::{Item, ItemKind, Mutability};
 use rustc_lint::{LateContext, LateLintPass};
+use rustc_lint_defs::declare_tool_lint;
 use rustc_session::impl_lint_pass;
 
-declare_clippy_lint! {
+declare_tool_lint! {
     /// ### What it does
     /// Checks if lint formulations have a standardized format.
     ///
@@ -15,9 +16,10 @@ declare_clippy_lint! {
     ///
     /// ### Example
     /// `Checks for use...` can be written as `Checks for usage...` .
-    pub ALMOST_STANDARD_LINT_FORMULATION,
-    internal,
-    "lint formulations must have a standardized format."
+    pub clippy::ALMOST_STANDARD_LINT_FORMULATION,
+    Warn,
+    "lint formulations must have a standardized format.",
+    report_in_external_macro: true
 }
 
 impl_lint_pass!(AlmostStandardFormulation => [ALMOST_STANDARD_LINT_FORMULATION]);

clippy_lints/src/utils/internal_lints/almost_standard_lint_formulation.rs renamed to clippy_internal_lints/src/almost_standard_lint_formulation.rs

@@ -4,11 +4,12 @@ use clippy_utils::{is_expr_path_def_path, is_lint_allowed, peel_blocks_with_stmt
 use rustc_errors::Applicability;
 use rustc_hir::{Closure, Expr, ExprKind};
 use rustc_lint::{LateContext, LateLintPass};
+use rustc_lint_defs::declare_tool_lint;
 use rustc_session::declare_lint_pass;
 
 use std::borrow::{Borrow, Cow};
 
-declare_clippy_lint! {
+declare_tool_lint! {
     /// ### What it does
     /// Lints `span_lint_and_then` function calls, where the
     /// closure argument has only one statement and that statement is a method
@@ -63,9 +64,10 @@ declare_clippy_lint! {
     /// span_lint_and_note(cx, TEST_LINT, expr.span, lint_msg, Some(expr.span), note_msg);
     /// span_lint_and_note(cx, TEST_LINT, expr.span, lint_msg, None, note_msg);
     /// ```
-    pub COLLAPSIBLE_SPAN_LINT_CALLS,
-    internal,
-    "found collapsible `span_lint_and_then` calls"
+    pub clippy::COLLAPSIBLE_SPAN_LINT_CALLS,
+    Warn,
+    "found collapsible `span_lint_and_then` calls",
+    report_in_external_macro: true
 }
 
 declare_lint_pass!(CollapsibleCalls => [COLLAPSIBLE_SPAN_LINT_CALLS]);