fix pylint upstream category

astral-sh · Mar 18, 2024 · 7f7d4d2 · 7f7d4d2
1 parent 526abeb
commit 7f7d4d2
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 26 deletions.
diff --git a/crates/ruff_dev/src/generate_rules_table.rs b/crates/ruff_dev/src/generate_rules_table.rs
@@ -180,8 +180,17 @@ pub(crate) fn generate() -> String {
             .map(|rule| (rule.upstream_category(&linter), rule))
             .into_group_map();
 
+        let mut rules_by_upstream_category: Vec<_> = rules_by_upstream_category.iter().collect();
+
+        // Sort the upstream categories alphabetically by prefix.
+        rules_by_upstream_category.sort_by(|a, b| {
+            a.0.as_ref()
+                .map_or("", |x| &x.prefix)
+                .cmp(&b.0.as_ref().map_or("", |x| &x.prefix))
+        });
+
         if rules_by_upstream_category.len() > 1 {
-            for (opt, rules) in &rules_by_upstream_category {
+            for (opt, rules) in rules_by_upstream_category {
                 if opt.is_some() {
                     let UpstreamCategoryAndPrefix { category, prefix } = opt.unwrap();
                     table_out.push_str(&format!("#### {category} ({prefix})"));

diff --git a/crates/ruff_linter/src/upstream_categories.rs b/crates/ruff_linter/src/upstream_categories.rs
@@ -8,29 +8,19 @@ pub struct UpstreamCategoryAndPrefix {
     pub prefix: &'static str,
 }
 
-const PLC: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
+const C: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
     category: "Convention",
-    prefix: "PLC",
+    prefix: "C",
 };
 
-const PLE: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
+const E: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
     category: "Error",
-    prefix: "PLE",
+    prefix: "E",
 };
 
-const PLR: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
+const R: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
     category: "Refactor",
-    prefix: "PLR",
-};
-
-const PLW: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
-    category: "Warning",
-    prefix: "PLW",
-};
-
-const E: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
-    category: "Error",
-    prefix: "E",
+    prefix: "R",
 };
 
 const W: UpstreamCategoryAndPrefix = UpstreamCategoryAndPrefix {
@@ -52,14 +42,14 @@ impl Rule {
                 }
             }
             Linter::Pylint => {
-                if code.starts_with("PLC") {
-                    Some(PLC)
-                } else if code.starts_with("PLE") {
-                    Some(PLE)
-                } else if code.starts_with("PLR") {
-                    Some(PLR)
-                } else if code.starts_with("PLW") {
-                    Some(PLW)
+                if code.starts_with('C') {
+                    Some(C)
+                } else if code.starts_with('E') {
+                    Some(E)
+                } else if code.starts_with('R') {
+                    Some(R)
+                } else if code.starts_with('W') {
+                    Some(W)
                 } else {
                     None
                 }
@@ -73,7 +63,7 @@ impl Linter {
     pub const fn upstream_categories(&self) -> Option<&'static [UpstreamCategoryAndPrefix]> {
         match self {
             Linter::Pycodestyle => Some(&[E, W]),
-            Linter::Pylint => Some(&[PLC, PLE, PLR, PLW]),
+            Linter::Pylint => Some(&[C, E, R, W]),
             _ => None,
         }
     }