rigsql-rules 0.7.1

Lint rules (sqlfluff-compatible) for the rigsql SQL linter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use rigsql_core::SegmentType;

use crate::rule::{CrawlType, Rule, RuleContext, RuleGroup};
use crate::violation::LintViolation;

/// ST06: Select column order convention.
///
/// This is a stub rule. The full sqlfluff ST06 checks for specific column
/// ordering conventions (e.g., aggregates after non-aggregates) which is
/// complex to detect reliably.
#[derive(Debug, Default)]
pub struct RuleST06;

impl Rule for RuleST06 {
    fn code(&self) -> &'static str {
        "ST06"
    }
    fn name(&self) -> &'static str {
        "structure.column_order"
    }
    fn description(&self) -> &'static str {
        "Select column order convention."
    }
    fn explanation(&self) -> &'static str {
        "Columns in a SELECT clause should follow a consistent ordering convention. \
         For example, wildcards and simple columns before aggregate or window functions. \
         This rule is currently a stub and does not produce violations."
    }
    fn groups(&self) -> &[RuleGroup] {
        &[RuleGroup::Structure]
    }
    fn is_fixable(&self) -> bool {
        false
    }

    fn crawl_type(&self) -> CrawlType {
        CrawlType::Segment(vec![SegmentType::SelectClause])
    }

    fn eval(&self, _ctx: &RuleContext) -> Vec<LintViolation> {
        // Stub: not implemented yet
        vec![]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::lint_sql;

    #[test]
    fn test_st06_no_false_positives() {
        let violations = lint_sql("SELECT a, b, COUNT(*) FROM t GROUP BY a, b;", RuleST06);
        assert_eq!(violations.len(), 0);
    }
}