Enh: introduce Rule Categories

astral-sh · Oct 30, 2024 · 378cce9 · 378cce9
1 parent 60a2dc5
commit 378cce9
Show file tree

Hide file tree

Showing 4 changed files with 1,023 additions and 883 deletions.
diff --git a/crates/ruff_dev/src/generate_docs.rs b/crates/ruff_dev/src/generate_docs.rs
@@ -8,6 +8,7 @@ use std::path::PathBuf;
 use anyhow::Result;
 use itertools::Itertools;
 use regex::{Captures, Regex};
+use ruff_linter::codes::RuleCategory;
 use strum::IntoEnumIterator;
 
 use ruff_diagnostics::FixAvailability;
@@ -92,6 +93,13 @@ pub(crate) fn main(args: &Args) -> Result<()> {
                 output.push('\n');
             }
 
+            let category = rule.category();
+            if !matches!(category, RuleCategory::Uncategorized) {
+                output.push_str(&format!(r"Category: {category}."));
+                output.push('\n');
+                output.push('\n');
+            }
+
             process_documentation(
                 explanation.trim(),
                 &mut output,