bwq 0.3.1

A linter and parser for Brandwatch query files (.bwq)
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

use thiserror::Error;

#[derive(Debug, Clone, PartialEq)]
pub struct Position {
    pub line: usize,
    pub column: usize,
    pub offset: usize,
}

impl Position {
    pub fn new(line: usize, column: usize, offset: usize) -> Self {
        Self {
            line,
            column,
            offset,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct Span {
    pub start: Position,
    pub end: Position,
}

impl Span {
    pub fn new(start: Position, end: Position) -> Self {
        Self { start, end }
    }

    pub fn single(pos: Position) -> Self {
        Self {
            start: pos.clone(),
            end: pos,
        }
    }
}

#[derive(Error, Debug, Clone, PartialEq)]
pub enum LintError {
    #[error("Lexer error at {position:?}: {message}")]
    LexerError { position: Position, message: String },

    #[error("Parser error at {span:?}: {message}")]
    ParserError { span: Span, message: String },

    #[error("Validation error at {span:?}: {message}")]
    ValidationError { span: Span, message: String },

    #[error("Boolean operator '{operator}' must be capitalized at {span:?}")]
    InvalidBooleanCase { span: Span, operator: String },

    #[error("Unbalanced parentheses at {span:?}")]
    UnbalancedParentheses { span: Span },

    #[error(
        "Invalid wildcard placement at {span:?}: wildcards cannot be at the beginning of a word"
    )]
    InvalidWildcardPlacement { span: Span },

    #[error("Invalid proximity operator syntax at {span:?}: {message}")]
    InvalidProximityOperator { span: Span, message: String },

    #[error("Invalid field operator syntax at {span:?}: {message}")]
    InvalidFieldOperator { span: Span, message: String },

    #[error("Invalid range syntax at {span:?}: expected '[value TO value]'")]
    InvalidRangeSyntax { span: Span },

    #[error("Unexpected token '{token}' at {span:?}")]
    UnexpectedToken { span: Span, token: String },

    #[error("Expected '{expected}' but found '{found}' at {span:?}")]
    ExpectedToken {
        span: Span,
        expected: String,
        found: String,
    },
}

#[derive(Debug, Clone, PartialEq)]
pub enum LintWarning {
    PotentialTypo { span: Span, suggestion: String },
    DeprecatedOperator { span: Span, replacement: String },
    PerformanceWarning { span: Span, message: String },
}

pub type LintResult<T> = Result<T, LintError>;

#[derive(Debug, Clone, PartialEq, Default)]
pub struct LintReport {
    pub errors: Vec<LintError>,
    pub warnings: Vec<LintWarning>,
}

impl LintReport {
    pub fn new() -> Self {
        Self {
            errors: Vec::new(),
            warnings: Vec::new(),
        }
    }

    pub fn add_error(&mut self, error: LintError) {
        self.errors.push(error);
    }

    pub fn add_warning(&mut self, warning: LintWarning) {
        self.warnings.push(warning);
    }

    pub fn has_errors(&self) -> bool {
        !self.errors.is_empty()
    }

    pub fn has_warnings(&self) -> bool {
        !self.warnings.is_empty()
    }

    pub fn is_clean(&self) -> bool {
        self.errors.is_empty() && self.warnings.is_empty()
    }
}