notabene 0.2.0

A fast linter for changelogs in Keep a Changelog format
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

//! Linter diagnostics.
use std::ops::Range;
use std::path::PathBuf;

use serde::{Deserialize, Serialize};

use crate::rule::Rule;
use crate::span::{Locator, Position, Ranged, Span};

/// A rule violation.
///
/// A `Diagnostic` can hold either a [`Span`] or [`Position`].
/// [`Diagnostic::new`] accepts a `Span`.
///
/// Use [`Diagnostic::locate`] to convert a `Diagnostic<Span>` to a `Diagnostic<Position>`.
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
pub struct Diagnostic<L = Span> {
    /// The rule that was violated.
    pub rule: Rule,
    /// Where the violation occurred in the source document. The location may be `None` if the
    /// violation is for the document as a whole (e.g. it is missing a title).
    pub location: Option<L>,
    /// The source path, used in reporting.
    pub path: Option<PathBuf>,
}

impl Diagnostic {
    /// Create a new diagnostic from a `Span`.
    pub fn new(rule: Rule, location: Option<Span>) -> Self {
        Self {
            rule,
            location,
            path: None,
        }
    }
}

impl<L> Diagnostic<L> {
    /// Return the diagnostic rule code.
    pub fn code(&self) -> &str {
        self.rule.code()
    }
}

impl<Span: Ranged<usize>> Diagnostic<Span> {
    /// Locate a diagnostic in the source document.
    pub fn locate(self, locator: &Locator) -> Diagnostic<Position> {
        Diagnostic {
            rule: self.rule,
            location: self.location.map(|s| locator.position(&s.range())),
            path: self.path,
        }
    }
}

impl<L: Ranged<usize>> Diagnostic<L> {
    /// Return a formatted message.
    pub fn message(&self, source: &str) -> String {
        let range = self.location.as_ref().map(|l| l.range());
        match range {
            Some(range) => {
                let snippet = &source[range];
                self.rule.message().replace("{}", snippet)
            }
            None => self.rule.message().to_string(),
        }
    }

    /// Return the range of offsets in the source document for this diagnostic.
    pub fn range(&self) -> Option<Range<usize>> {
        Some(self.location.as_ref()?.range())
    }

    /// Return the unist Position of the diagnostic.
    pub(crate) fn position(&self, locator: &Locator) -> Option<Position> {
        self.location.as_ref().map(|l| locator.position(&l.range()))
    }
}

impl Diagnostic<Position> {
    /// Return the line number corresponding to the start offset of this diagnostic's span.
    pub fn line(&self) -> Option<usize> {
        self.location.map(|p| p.start.line)
    }

    /// Return the column number corresponding to the start offset of this diagnostic's span.
    pub fn column(&self) -> Option<usize> {
        self.location.map(|p| p.start.column)
    }
}

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

    #[test]
    fn test_new() {
        assert_eq!(
            Diagnostic::new(Rule::MissingTitle, None),
            Diagnostic {
                rule: Rule::MissingTitle,
                location: None,
                path: None
            }
        );
        assert_eq!(
            Diagnostic::new(Rule::MissingTitle, Some(Span::default())),
            Diagnostic {
                rule: Rule::MissingTitle,
                location: Some(Span::default()),
                path: None
            }
        );
    }

    #[test]
    fn test_code() {
        assert_eq!(
            Diagnostic::new(Rule::MissingTitle, None).code(),
            Rule::MissingTitle.code()
        );
    }

    #[test]
    fn test_message() {
        let source = "";
        let diagnostic = Diagnostic::new(Rule::MissingTitle, None);
        assert_eq!(diagnostic.message(source), Rule::MissingTitle.message());

        let source = "# Changelog";
        let diagnostic = Diagnostic::new(Rule::DuplicateTitle, Some(Span::new(2, 11)));
        assert_eq!(
            diagnostic.message(source),
            Rule::DuplicateTitle.message().replace("{}", "Changelog")
        );
    }
}