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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use rigsql_core::{Segment, SegmentType};

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

/// RF04: Keywords used as identifiers.
///
/// Detects identifiers that match SQL reserved keywords, which can cause
/// confusion and portability issues.
#[derive(Debug, Default)]
pub struct RuleRF04;

const RESERVED_KEYWORDS: &[&str] = &[
    "SELECT",
    "FROM",
    "WHERE",
    "INSERT",
    "UPDATE",
    "DELETE",
    "CREATE",
    "DROP",
    "ALTER",
    "TABLE",
    "INDEX",
    "VIEW",
    "JOIN",
    "ON",
    "AND",
    "OR",
    "NOT",
    "IN",
    "IS",
    "NULL",
    "TRUE",
    "FALSE",
    "BETWEEN",
    "LIKE",
    "ORDER",
    "BY",
    "GROUP",
    "HAVING",
    "LIMIT",
    "OFFSET",
    "UNION",
    "EXCEPT",
    "INTERSECT",
    "INTO",
    "VALUES",
    "SET",
    "AS",
    "CASE",
    "WHEN",
    "THEN",
    "ELSE",
    "END",
    "EXISTS",
    "ALL",
    "ANY",
    "DISTINCT",
    "TOP",
    "COUNT",
    "SUM",
    "AVG",
    "MIN",
    "MAX",
    "CAST",
    "COALESCE",
    "NULLIF",
];

impl Rule for RuleRF04 {
    fn code(&self) -> &'static str {
        "RF04"
    }
    fn name(&self) -> &'static str {
        "references.keywords"
    }
    fn description(&self) -> &'static str {
        "Keywords should not be used as identifiers."
    }
    fn explanation(&self) -> &'static str {
        "Using SQL reserved keywords as identifiers (column names, table names, aliases) \
         can cause parsing ambiguity, confuse readers, and reduce portability across \
         SQL dialects. Use descriptive, non-reserved names instead."
    }
    fn groups(&self) -> &[RuleGroup] {
        &[RuleGroup::References]
    }
    fn is_fixable(&self) -> bool {
        false
    }

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

    fn eval(&self, ctx: &RuleContext) -> Vec<LintViolation> {
        let Segment::Token(t) = ctx.segment else {
            return vec![];
        };

        let upper = t.token.text.to_ascii_uppercase();
        if RESERVED_KEYWORDS.contains(&upper.as_str()) {
            vec![LintViolation::with_msg_key(
                self.code(),
                format!("Identifier '{}' is a reserved keyword.", t.token.text),
                t.token.span,
                "rules.RF04.msg",
                vec![("name".to_string(), t.token.text.to_string())],
            )]
        } else {
            vec![]
        }
    }
}

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

    #[test]
    fn test_rf04_flags_keyword_as_identifier() {
        // "table" used as a table name identifier
        let violations = lint_sql("SELECT id FROM \"table\"", RuleRF04);
        // QuotedIdentifier won't be visited since we crawl Identifier only
        assert_eq!(violations.len(), 0);
    }

    #[test]
    fn test_rf04_accepts_normal_identifiers() {
        let violations = lint_sql("SELECT user_id, email FROM users", RuleRF04);
        assert_eq!(violations.len(), 0);
    }

    #[test]
    fn test_rf04_flags_keyword_identifier_in_alias() {
        // If the parser emits "table" as an Identifier segment, this should flag it
        let violations = lint_sql("SELECT 1 AS \"values\"", RuleRF04);
        // "values" in quotes is QuotedIdentifier, not Identifier — so no violation
        assert_eq!(violations.len(), 0);
    }
}