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

use crate::ast::*;
use crate::error::{LintError, LintWarning};

pub mod engine;
pub mod rules;

pub use engine::ValidationEngine;

#[derive(Debug, Clone, Default)]
pub struct ValidationContext {
    pub inside_group: bool,
    pub parent_operator: Option<BooleanOperator>,
    pub field_context: Option<FieldType>,
}

pub trait ValidationRule {
    fn name(&self) -> &'static str;
    fn validate(&self, expr: &Expression, ctx: &ValidationContext) -> ValidationResult;
    fn can_validate(&self, expr: &Expression) -> bool;
}

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

impl ValidationResult {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_error(error: LintError) -> Self {
        Self {
            errors: vec![error],
            warnings: vec![],
        }
    }

    pub fn with_warning(warning: LintWarning) -> Self {
        Self {
            errors: vec![],
            warnings: vec![warning],
        }
    }

    pub fn extend(&mut self, other: ValidationResult) {
        self.errors.extend(other.errors);
        self.warnings.extend(other.warnings);
    }
}