wdl-core 0.2.0

Common functionality for the `wdl` family of crates
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

//! Linting.

use std::collections::VecDeque;

use convert_case::Case;
use convert_case::Casing;
use nonempty::NonEmpty;

use crate::concern::Code;
use crate::file::location;

mod level;
mod tag_set;
pub mod warning;

pub use level::Level;
pub use tag_set::Tag;
pub use tag_set::TagSet;
pub use warning::Warning;

/// An unrecoverable error that occurs during linting.
#[derive(Debug)]
pub enum Error {
    /// A location error.
    Location(location::Error),
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Error::Location(err) => write!(f, "location error: {err}"),
        }
    }
}

impl std::error::Error for Error {}

/// A [`Result`](std::result::Result) returned from a lint check.
pub type Result = std::result::Result<Option<NonEmpty<Warning>>, Error>;

/// A tree linter.
#[derive(Debug)]
pub struct Linter;

impl Linter {
    /// Lints a tree according to a set of lint rules and returns a
    /// set of lint warnings (if any are detected).
    pub fn lint<'a, E>(tree: &'a E, rules: Vec<Box<dyn Rule<&'a E>>>) -> Result {
        let mut warnings = rules
            .iter()
            .map(|rule| rule.check(tree))
            .collect::<std::result::Result<Vec<Option<NonEmpty<Warning>>>, Error>>()?
            .into_iter()
            .flatten()
            .flatten()
            .collect::<VecDeque<Warning>>();

        match warnings.pop_front() {
            Some(front) => {
                let mut result = NonEmpty::new(front);
                result.extend(warnings);
                Ok(Some(result))
            }
            None => Ok(None),
        }
    }
}

/// A lint rule.
pub trait Rule<E>: std::fmt::Debug + Sync {
    /// The name of the lint rule.
    fn name(&self) -> String {
        format!("{:?}", self).to_case(Case::Snake)
    }

    /// Get the code for this lint rule.
    fn code(&self) -> Code;

    /// Get the lint tags for this lint rule.
    fn tags(&self) -> TagSet;

    /// Get the body of the lint rule.
    fn body(&self) -> &'static str;

    /// Checks the tree according to the implemented lint rule.
    fn check(&self, tree: E) -> Result;
}