lychee 0.24.0

A fast, async link checker
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

//! `lychee.toml` configuration loader.
//!
//! This module allows configuring lychee via a standard `lychee.toml` file.
//! This is the default configuration file format for lychee.
//!
//! Unlike `Cargo.toml` and `pyproject.toml` which require the configuration
//! to be scoped under a specific section (like `[package.metadata.lychee]`),
//! `lychee.toml` defines the configuration at the root level of the document.
//!
//! # Example
//!
//! ```toml
//! exclude = ["foo", "bar"]
//! timeout = 10
//! ```

use super::{ConfigLoader, ConfigMatch};
use anyhow::{Context, Result};

pub(crate) const LYCHEE_CONFIG_FILE: &str = "lychee.toml";

pub(crate) struct LycheeTomlLoader;

impl ConfigLoader for LycheeTomlLoader {
    fn filename(&self) -> &str {
        LYCHEE_CONFIG_FILE
    }

    /// We strictly deserialize the entire file directly into our `Config` struct.
    /// Any failure here is a genuine configuration error that we want to bubble up.
    /// A dedicated `lychee.toml` file is assumed to always contain lychee configuration.
    fn load(&self, contents: &str) -> Result<ConfigMatch> {
        let config =
            toml::from_str(contents).with_context(|| "Failed to parse configuration file")?;
        Ok(ConfigMatch::Found(Box::new(config)))
    }
}

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

    #[test]
    fn test_load_config() {
        let toml = r#"
        exclude = ["foo"]
        "#;
        let result = LycheeTomlLoader.load(toml).unwrap();
        match result {
            ConfigMatch::Found(config) => assert_eq!(config.exclude, vec!["foo".to_string()]),
            ConfigMatch::NotFound => panic!("Expected config to be found"),
        }
    }

    #[test]
    fn test_load_invalid_config() {
        let toml = r#"
        exclude = "foo" # should be an array
        "#;
        assert!(LycheeTomlLoader.load(toml).is_err());
    }
}