remove a few unnecessary layers of abstraction

Author: psteinroe

Cargo.lock

@@ -48,6 +48,7 @@ unicode-width            = "0.1.12"
 
 # postgres specific crates
 pg_analyse                = { path = "./crates/pg_analyse", version = "0.0.0" }
+pg_analyser               = { path = "./crates/pg_analyser", version = "0.0.0" }
 pg_base_db                = { path = "./crates/pg_base_db", version = "0.0.0" }
 pg_cli                    = { path = "./crates/pg_cli", version = "0.0.0" }
 pg_commands               = { path = "./crates/pg_commands", version = "0.0.0" }
@@ -64,7 +65,6 @@ pg_inlay_hints            = { path = "./crates/pg_inlay_hints", version = "0.0.0
 pg_lexer                  = { path = "./crates/pg_lexer", version = "0.0.0" }
 pg_lexer_codegen          = { path = "./crates/pg_lexer_codegen", version = "0.0.0" }
 pg_lint                   = { path = "./crates/pg_lint", version = "0.0.0" }
-pg_linter                 = { path = "./crates/pg_linter", version = "0.0.0" }
 pg_lsp_converters         = { path = "./crates/pg_lsp_converters", version = "0.0.0" }
 pg_lsp_new                = { path = "./crates/pg_lsp_new", version = "0.0.0" }
 pg_markup                 = { path = "./crates/pg_markup", version = "0.0.0" }

Cargo.toml

@@ -22,9 +22,9 @@ rustc-hash                = { workspace = true }
 biome_deserialize        = { workspace = true, optional = true }
 biome_deserialize_macros = { workspace = true, optional = true }
 enumflags2.workspace     = true
+schemars                 = { workspace = true, optional = true }
 serde                    = { workspace = true, features = ["derive"], optional = true }
 text-size.workspace      = true
-schemars                 = { workspace = true, optional = true }
 
 [features]
 serde = ["dep:serde", "dep:schemars", "dep:biome_deserialize", "dep:biome_deserialize_macros"]

crates/pg_analyse/Cargo.toml

@@ -184,7 +184,7 @@ pub(crate) enum Categories {
 }
 
 #[derive(Debug, Copy, Clone)]
-/// The categories supported by the analyzer.
+/// The categories supported by the analyser.
 ///
 /// The default implementation of this type returns an instance with all the categories.
 ///
@@ -297,7 +297,6 @@ impl schemars::JsonSchema for RuleCategories {
     }
 }
 
-
 #[derive(Debug, Default)]
 /// A convenient type create a [RuleCategories] type
 ///

crates/pg_analyse/src/categories.rs

@@ -13,14 +13,8 @@ where
     R: Rule + Sized + 'static,
 {
     #[allow(clippy::too_many_arguments)]
-    pub fn new(
-        stmt: &'a pg_query_ext::NodeEnum,
-        options: &'a R::Options,
-    ) -> Self {
-        Self {
-            stmt,
-            options,
-        }
+    pub fn new(stmt: &'a pg_query_ext::NodeEnum, options: &'a R::Options) -> Self {
+        Self { stmt, options }
     }
 
     /// Returns the group that belongs to the current rule

crates/pg_analyse/src/context.rs

@@ -12,7 +12,7 @@ pub enum RuleFilter<'a> {
     Rule(&'a str, &'a str),
 }
 
-/// Allows filtering the list of rules that will be executed in a run of the analyzer,
+/// Allows filtering the list of rules that will be executed in a run of the analyser,
 /// and at what source code range signals (diagnostics or actions) may be raised
 #[derive(Debug, Default, Clone, Copy)]
 pub struct AnalysisFilter<'a> {

crates/pg_analyse/src/filter.rs

@@ -9,47 +9,15 @@ mod rule;
 // Re-exported for use in the `declare_group` macro
 pub use pg_diagnostics::category_concat;
 
-use registry::RegistryRuleParams;
-
 pub use crate::categories::{
-    ActionCategory, RefactorKind, RuleCategories, RuleCategory,
-    SourceActionKind, SUPPRESSION_ACTION_CATEGORY, RuleCategoriesBuilder
+    ActionCategory, RefactorKind, RuleCategories, RuleCategoriesBuilder, RuleCategory,
+    SourceActionKind, SUPPRESSION_ACTION_CATEGORY,
 };
 pub use crate::filter::{AnalysisFilter, GroupKey, RuleFilter, RuleKey};
-pub use crate::options::{AnalyzerConfiguration, AnalyzerOptions, AnalyzerRules};
-pub use crate::registry::{MetadataRegistry, RegistryVisitor, RuleRegistry, RuleRegistryBuilder};
+pub use crate::options::{AnalyserOptions, AnalyserRules};
+pub use crate::registry::{
+    MetadataRegistry, RegistryRuleParams, RegistryVisitor, RuleRegistry, RuleRegistryBuilder,
+};
 pub use crate::rule::{
     GroupCategory, Rule, RuleDiagnostic, RuleGroup, RuleMeta, RuleMetadata, RuleSource,
 };
-
-pub struct Analyzer<'analyzer> {
-    /// Holds the metadata for all the rules statically known to the analyzer
-    /// we need this later when we add suppression support
-    #[allow(dead_code)]
-    metadata: &'analyzer MetadataRegistry,
-}
-
-pub struct AnalyzerContext<'a> {
-    pub root: &'a pg_query_ext::NodeEnum,
-    pub options: &'a AnalyzerOptions,
-    pub registry: RuleRegistry,
-}
-
-impl<'analyzer> Analyzer<'analyzer> {
-    /// Construct a new instance of the analyzer with the given rule registry
-    pub fn new(metadata: &'analyzer MetadataRegistry) -> Self {
-        Self { metadata }
-    }
-
-    pub fn run(self, ctx: AnalyzerContext) -> Vec<RuleDiagnostic> {
-        let params = RegistryRuleParams {
-            root: ctx.root,
-            options: ctx.options,
-        };
-
-        ctx.registry
-            .into_iter()
-            .flat_map(|rule| (rule.run)(&params))
-            .collect::<Vec<_>>()
-    }
-}

crates/pg_analyse/src/lib.rs

@@ -1,4 +1,4 @@
-/// This macro is used to declare an analyzer rule type, and implement the
+/// This macro is used to declare an analyser rule type, and implement the
 //  [RuleMeta] trait for it
 ///  # Example
 ///

crates/pg_analyse/src/macros.rs

@@ -28,9 +28,9 @@ impl RuleOptions {
 
 /// A convenient new type data structure to insert and get rules
 #[derive(Debug, Default)]
-pub struct AnalyzerRules(FxHashMap<RuleKey, RuleOptions>);
+pub struct AnalyserRules(FxHashMap<RuleKey, RuleOptions>);
 
-impl AnalyzerRules {
+impl AnalyserRules {
     /// It tracks the options of a specific rule
     pub fn push_rule(&mut self, rule_key: RuleKey, options: RuleOptions) {
         self.0.insert(rule_key, options);
@@ -42,27 +42,19 @@ impl AnalyzerRules {
     }
 }
 
-/// A data structured derived from the `pglsp.toml` file
+/// A set of information useful to the analyser infrastructure
 #[derive(Debug, Default)]
-pub struct AnalyzerConfiguration {
-    /// A list of rules and their options
-    pub rules: AnalyzerRules,
-}
-
-/// A set of information useful to the analyzer infrastructure
-#[derive(Debug, Default)]
-pub struct AnalyzerOptions {
+pub struct AnalyserOptions {
     /// A data structured derived from the [`pglsp.toml`] file
-    pub configuration: AnalyzerConfiguration,
+    pub rules: AnalyserRules,
 }
 
-impl AnalyzerOptions {
+impl AnalyserOptions {
     pub fn rule_options<R>(&self) -> Option<R::Options>
     where
         R: Rule<Options: Clone> + 'static,
     {
-        self.configuration
-            .rules
+        self.rules
             .get_rule_options::<R::Options>(&RuleKey::rule::<R>())
             .cloned()
     }

crates/pg_analyse/src/options.rs

@@ -4,7 +4,7 @@ use crate::{
     context::RuleContext,
     filter::{AnalysisFilter, GroupKey, RuleKey},
     rule::{GroupCategory, Rule, RuleDiagnostic, RuleGroup},
-    AnalyzerOptions,
+    AnalyserOptions,
 };
 
 pub trait RegistryVisitor {
@@ -126,7 +126,7 @@ impl RegistryVisitor for RuleRegistryBuilder<'_> {
 
 /// The rule registry holds type-erased instances of all active analysis rules
 pub struct RuleRegistry {
-    rules: Vec<RegistryRule>,
+    pub rules: Vec<RegistryRule>,
 }
 
 impl IntoIterator for RuleRegistry {
@@ -141,7 +141,7 @@ impl IntoIterator for RuleRegistry {
 /// Internal representation of a single rule in the registry
 #[derive(Copy, Clone)]
 pub struct RegistryRule {
-    pub(crate) run: RuleExecutor,
+    pub run: RuleExecutor,
 }
 
 impl RuleRegistry {
@@ -155,9 +155,9 @@ impl RuleRegistry {
     }
 }
 
-pub struct RegistryRuleParams<'analyzer> {
-    pub root: &'analyzer pg_query_ext::NodeEnum,
-    pub options: &'analyzer AnalyzerOptions,
+pub struct RegistryRuleParams<'a> {
+    pub root: &'a pg_query_ext::NodeEnum,
+    pub options: &'a AnalyserOptions,
 }
 
 /// Executor for rule as a generic function pointer