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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use std::collections::HashSet;
use std::path::Path;

use serde::{Deserialize, Serialize};
use toml;

use crate::rule::Rule;

use super::error::Result;
use super::report::Format;

#[derive(Debug, Default, PartialEq, Deserialize, Serialize)]
#[serde(default)]
pub struct Config {
    // When deserializing from a file, we want to consider empty values unset instead of their
    // default values.
    #[serde(default = "Lint::empty")]
    pub lint: Lint,
}

#[derive(Debug, PartialEq, Deserialize, Serialize)]
pub struct Lint {
    #[serde(default = "default_select")]
    pub select: Option<HashSet<Rule>>,
    pub ignore: Option<HashSet<Rule>>,
    pub output_format: Option<Format>,
}

#[derive(Debug, PartialEq, Deserialize, Serialize)]
struct PyProjectConfig {
    tool: PyProjectTool,
}

#[derive(Debug, PartialEq, Deserialize, Serialize)]
struct PyProjectTool {
    nb: Config,
}

impl Config {
    #[cfg(test)]
    pub fn empty() -> Self {
        Self {
            lint: Lint::empty(),
        }
    }

    pub fn merge(&self, other: &Config) -> Self {
        Self {
            lint: self.lint.merge(&other.lint),
        }
    }

    // Load default configuration
    pub fn load(path: Option<&Path>) -> Result<Config> {
        let mut config = Config::default();
        // TODO: Add debug logging for I/O error.
        if let Ok(s) = std::fs::read_to_string("pyproject.toml") {
            let pyproject = PyProjectConfig::from_str(&s)?;
            config = config.merge(&pyproject.tool.nb);
        }
        if let Ok(s) = std::fs::read_to_string("nb.toml") {
            config = config.merge(&Config::from_str(&s)?);
        }
        // Return an error if opening the user-specified file fails.
        if let Some(path) = path {
            let s = std::fs::read_to_string(path)?;
            let other = Config::from_str(&s)?;
            config = config.merge(&other);
        }
        Ok(config)
    }

    pub fn from_str(s: &str) -> Result<Self> {
        Ok(toml::from_str(s)?)
    }

    pub fn from_file(path: &Path) -> Result<Self> {
        let s = std::fs::read_to_string(path)?;
        Self::from_str(&s)
    }
}

impl PyProjectConfig {
    pub fn from_str(s: &str) -> Result<Self> {
        Ok(toml::from_str(s)?)
    }
}

impl Lint {
    pub fn empty() -> Self {
        Self {
            select: Default::default(),
            ignore: Default::default(),
            output_format: Default::default(),
        }
    }

    pub fn merge(&self, other: &Lint) -> Self {
        Self {
            select: other.select.clone().or(self.select.clone()),
            ignore: other.ignore.clone().or(self.ignore.clone()),
            output_format: other.output_format.or(self.output_format),
        }
    }
}

impl Default for Lint {
    fn default() -> Self {
        Self {
            select: default_select(),
            ignore: Some(Default::default()),
            output_format: Some(Default::default()),
        }
    }
}

fn default_select() -> Option<HashSet<Rule>> {
    Some(HashSet::from(Rule::ALL))
}

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

    #[test]
    fn test_default() {
        assert_eq!(
            Config::default(),
            Config {
                lint: Lint {
                    select: Some(HashSet::from(Rule::ALL)),
                    ignore: Some(HashSet::new()),
                    output_format: Some(Format::Short),
                }
            },
        );
    }

    #[test]
    fn test_merge() {
        let empty = Config::empty();
        let default = Config::default();
        assert_eq!(empty.merge(&default), default);
        assert_eq!(default.merge(&empty), default);
        let user = Config {
            lint: Lint {
                select: Some(HashSet::from([Rule::MissingTitle])),
                ignore: Some(HashSet::from([Rule::InvalidTitle])),
                output_format: Some(Format::Json),
            },
        };
        assert_eq!(default.merge(&user), user);
    }

    #[test]
    fn test_from_str() {
        let config = Config::from_str("").unwrap();
        assert_eq!(config, Config::empty());

        let config = Config::from_str(
            r#"
            [lint]
            select = ["E001"]
            ignore = ["E002"]
            output_format = "json"
        "#,
        )
        .unwrap();
        assert_eq!(
            config,
            Config {
                lint: Lint {
                    select: Some(HashSet::from([Rule::MissingTitle])),
                    ignore: Some(HashSet::from([Rule::DuplicateTitle])),
                    output_format: Some(Format::Json),
                }
            }
        );
    }
}