sqruff-lib 0.21.12

A high-speed 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

use std::collections::BTreeMap;

use serde::Serialize;
use sqruff_lib_core::errors::SQLBaseError;

impl From<SQLBaseError> for Diagnostic {
    fn from(value: SQLBaseError) -> Self {
        Diagnostic {
            range: Range {
                start: Position::new(value.line_no as u32, value.line_pos as u32),
                end: Position::new(value.line_no as u32, value.line_pos as u32),
            },
            message: value.description,
            severity: if value.warning {
                DiagnosticSeverity::Warning
            } else {
                DiagnosticSeverity::Error
            },
            source: Some("sqruff".to_string()),
            // code: todo!(),
            // source: Some(value.get_source().to_string()),
            // code: Some(DiagnosticCode {
            //     value: value.rule_code().to_string(),
            //     target: Uri::new("".to_string()),
            // }),
            // related_information: Vec::new(),
            // tags: Vec::new(),
        }
    }
}

/// Represents a line and character position, such as the position of the cursor.
#[derive(Serialize)]
struct Position {
    /// The zero-based line value.
    line: u32,
    /// The zero-based character value.
    character: u32,
}

impl Position {
    /// Creates a new `Position` instance.
    fn new(line: u32, character: u32) -> Self {
        Self { line, character }
    }
}

/// A range represents an ordered pair of two positions. It is guaranteed that `start` is before or equal to `end`.
#[derive(Serialize)]
struct Range {
    /// The start position. It is before or equal to `end`.
    start: Position,
    /// The end position. It is after or equal to `start`.
    end: Position,
}

/// Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a file.
#[derive(Serialize)]
pub struct Diagnostic {
    /// The range to which this diagnostic applies.
    range: Range,
    /// The human-readable message.
    message: String,
    /// The severity, default is {@link DiagnosticSeverity::Error error}.
    pub severity: DiagnosticSeverity,
    /// A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.
    source: Option<String>,
    // A code or identifier for this diagnostic. Should be used for later processing, e.g. when providing {@link CodeActionContext code actions}.
    // code: Option<DiagnosticCode>,
    // TODO Maybe implement
    // An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
    // related_information: Vec<DiagnosticRelatedInformation>,
    // Additional metadata about the diagnostic.
    // tags: Vec<DiagnosticTag>,
}

// /// Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or are related to a diagnostics, e.g when duplicating a symbol in a scope.
// #[derive(Serialize)]
// struct DiagnosticCode {
//     /// A code or identifier for this diagnostic.
//     value: String,
//     // TODO Maybe implement
//     // A target URI to open with more information about the diagnostic error.
//     // target: Uri,
// }

/// Represents the severity of diagnostics.
#[derive(Serialize)]
pub enum DiagnosticSeverity {
    /// Something not allowed by the rules of a language or other means.
    Error = 0,
    /// Something suspicious but allowed.
    Warning = 1,
    /// Something to inform about but not a problem.
    Information = 2,
    /// Something to hint to a better way of doing it, like proposing a refactoring.
    Hint = 3,
}

pub type DiagnosticCollection = BTreeMap<String, Vec<Diagnostic>>;