finish codegen

Author: psteinroe

crates/pg_analyse/src/lib.rs

@@ -1,5 +1,5 @@
 mod categories;
-mod context;
+pub mod context;
 mod filter;
 pub mod macros;
 mod options;
@@ -15,7 +15,6 @@ pub use crate::categories::{
     ActionCategory, RefactorKind, RuleCategories, RuleCategoriesBuilder, RuleCategory,
     SourceActionKind, SUPPRESSION_ACTION_CATEGORY,
 };
-pub use crate::context::RuleContext;
 pub use crate::filter::{AnalysisFilter, GroupKey, RuleKey};
 pub use crate::options::{AnalyzerConfiguration, AnalyzerOptions, AnalyzerRules};
 pub use crate::registry::{MetadataRegistry, RegistryVisitor, RuleRegistry, RuleRegistryBuilder};

crates/pg_analyse/src/rule.rs

@@ -1,7 +1,6 @@
 use pg_console::fmt::Display;
 use pg_console::{markup, MarkupBuf};
 use pg_diagnostics::advice::CodeSuggestionAdvice;
-use pg_diagnostics::location::AsSpan;
 use pg_diagnostics::{
     Advices, Category, Diagnostic, DiagnosticTags, Location, LogCategory, MessageAndDescription,
     Visit,
@@ -162,11 +161,11 @@ pub struct Detail {
 impl RuleDiagnostic {
     /// Creates a new [`RuleDiagnostic`] with a severity and title that will be
     /// used in a builder-like way to modify labels.
-    pub fn new(category: &'static Category, span: impl AsSpan, title: impl Display) -> Self {
+    pub fn new(category: &'static Category, span: Option<TextRange>, title: impl Display) -> Self {
         let message = markup!({ title }).to_owned();
         Self {
             category,
-            span: span.as_span(),
+            span,
             message: MessageAndDescription::from(message),
             tags: DiagnosticTags::empty(),
             rule_advice: RuleAdvice::default(),
@@ -200,17 +199,17 @@ impl RuleDiagnostic {
     /// Attaches a label to this [`RuleDiagnostic`].
     ///
     /// The given span has to be in the file that was provided while creating this [`RuleDiagnostic`].
-    pub fn label(mut self, span: impl AsSpan, msg: impl Display) -> Self {
+    pub fn label(mut self, span: Option<TextRange>, msg: impl Display) -> Self {
         self.rule_advice.details.push(Detail {
             log_category: LogCategory::Info,
             message: markup!({ msg }).to_owned(),
-            range: span.as_span(),
+            range: span,
         });
         self
     }
 
     /// Attaches a detailed message to this [`RuleDiagnostic`].
-    pub fn detail(self, span: impl AsSpan, msg: impl Display) -> Self {
+    pub fn detail(self, span: Option<TextRange>, msg: impl Display) -> Self {
         self.label(span, msg)
     }
 

crates/pg_diagnostics_categories/src/categories.rs

@@ -13,12 +13,11 @@
 // must be between `define_categories! {\n` and `\n    ;\n`.
 
 define_categories! {
-    "lint/nursery/banDropColumn": "https://pglsp.dev/linter/rules/ban-drop-column",
+    "lint/safety/banDropColumn": "https://pglsp.dev/linter/rules/ban-drop-column",
     // end lint rules
     ;
     // General categories
     "stdin",
-    "lint",
     "check",
     "configuration",
     "database/connection",
@@ -31,8 +30,9 @@ define_categories! {
     "syntax",
     "dummy",
 
-    // Lint groups
+    // Lint groups start
     "lint",
     "lint/performance",
-    "lint/suspicious",
+    "lint/safety",
+    // Lint groups end
 }

crates/pg_linter/src/lint.rs

@@ -1,5 +1,4 @@
 //! Generated file, do not edit by hand, see `xtask/codegen`
 
-pub mod nursery;
-pub mod performance;
-::pg_analyse::declare_category! { pub Lint { kind : Lint , groups : [self :: nursery :: Nursery , self :: performance :: Performance ,] } }
+pub mod safety;
+::pg_analyse::declare_category! { pub Lint { kind : Lint , groups : [self :: safety :: Safety ,] } }

crates/pg_linter/src/lint/nursery/ban_drop_column.rs

@@ -2,4 +2,4 @@
 
 use pg_analyse::declare_lint_group;
 pub mod ban_drop_column;
-declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: ban_drop_column :: BanDropColumn ,] } }
+declare_lint_group! { pub Safety { name : "safety" , rules : [self :: ban_drop_column :: BanDropColumn ,] } }

crates/pg_linter/src/lint/performance.rs

@@ -0,0 +1,50 @@
+use pg_analyse::{context::RuleContext, declare_lint_rule, Rule, RuleDiagnostic};
+use pg_console::markup;
+
+declare_lint_rule! {
+    /// Dropping a column may break existing clients.
+    ///
+    /// Update your application code to no longer read or write the column.
+    ///
+    /// You can leave the column as nullable or delete the column once queries no longer select or modify the column.
+    ///
+    /// ## Examples
+    ///
+    /// ### Invalid
+    ///
+    /// ```sql,expect_diagnostic
+    /// alter table test drop column id;
+    /// ```
+    ///
+    pub BanDropColumn {
+        version: "next",
+        name: "banDropColumn",
+        recommended: true,
+    }
+}
+
+impl Rule for BanDropColumn {
+    type Options = ();
+
+    fn run(ctx: &RuleContext<Self>) -> Vec<RuleDiagnostic> {
+        let mut diagnostics = Vec::new();
+
+        if let pg_query_ext::NodeEnum::AlterTableStmt(stmt) = &ctx.stmt() {
+            for cmd in &stmt.cmds {
+                if let Some(pg_query_ext::NodeEnum::AlterTableCmd(cmd)) = &cmd.node {
+                    if cmd.subtype() == pg_query_ext::protobuf::AlterTableType::AtDropColumn {
+                        diagnostics.push(RuleDiagnostic::new(
+                            rule_category!(),
+                            None,
+                            markup! {
+                                "Dropping a column may break existing clients."
+                            },
+                        ).detail(None, "You can leave the column as nullable or delete the column once queries no longer select or modify the column."));
+                    }
+                }
+            }
+        }
+
+        diagnostics
+    }
+}

crates/pg_linter/src/lint/performance/prefer_text_field.rs

@@ -2,6 +2,4 @@
 
 use crate::lint;
 pub type BanDropColumn =
-    <lint::nursery::ban_drop_column::BanDropColumn as pg_analyse::Rule>::Options;
-pub type PreferTextField =
-    <lint::performance::prefer_text_field::PreferTextField as pg_analyse::Rule>::Options;
+    <lint::safety::ban_drop_column::BanDropColumn as pg_analyse::Rule>::Options;