lychee 0.24.1

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
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

//! `Cargo.toml` configuration loader.
//!
//! This module allows configuring lychee via a `[package.metadata.lychee]` or
//! `[workspace.metadata.lychee]` section in a `Cargo.toml` file.
//!
//! # Tradeoffs
//!
//! While there are crates like `cargo_toml` available for parsing `Cargo.toml`
//! files, we deliberately avoid using them. Such crates bring in heavy dependencies
//! and extensive struct hierarchies to represent the entire Cargo schema (dependencies,
//! targets, profiles, etc.).
//!
//! Instead, we define a lightweight, custom set of structs to extract exactly
//! what we need using `serde` and `toml`.
//!
//! # Example
//!
//! ```toml
//! [package.metadata.lychee]
//! exclude = ["foo", "bar"]
//! max_redirects = 5
//! ```

use super::{ConfigLoader, ConfigMatch};
use crate::config::Config;
use anyhow::{Context, Result};
use serde::Deserialize;

pub(crate) const CARGO_CONFIG_FILE: &str = "Cargo.toml";

/// The lychee config can be defined in either
/// `[package.metadata.lychee]` or `[workspace.metadata.lychee]`.
#[derive(Deserialize)]
struct CargoToml {
    package: Option<CargoSection>,
    workspace: Option<CargoSection>,
}

#[derive(Deserialize)]
struct CargoSection {
    metadata: Option<Metadata>,
}

#[derive(Deserialize)]
struct Metadata {
    lychee: Option<Config>,
}

pub(crate) struct CargoTomlLoader;

impl ConfigLoader for CargoTomlLoader {
    fn filename(&self) -> &str {
        CARGO_CONFIG_FILE
    }

    fn load(&self, contents: &str) -> Result<ConfigMatch> {
        let cargo = toml::from_str::<CargoToml>(contents)
            .with_context(|| "Failed to parse lychee config from Cargo.toml")?;

        // Package metadata fully replaces workspace metadata (instead of merging).
        // That's useful, because it allows users to define a workspace-wide
        // default config and then override it in specific packages.
        let config = [cargo.package, cargo.workspace]
            .into_iter()
            .flatten()
            .find_map(|s| s.metadata.and_then(|m| m.lychee));

        match config {
            Some(config) => Ok(ConfigMatch::Found(Box::new(config))),
            None => Ok(ConfigMatch::NotFound),
        }
    }
}

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

    #[test]
    fn test_load_package_config() {
        let toml = r#"
        [package.metadata.lychee]
        exclude = ["foo"]
        "#;
        let result = CargoTomlLoader.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_workspace_config() {
        let toml = r#"
        [workspace.metadata.lychee]
        exclude = ["bar"]
        "#;
        let result = CargoTomlLoader.load(toml).unwrap();
        match result {
            ConfigMatch::Found(config) => assert_eq!(config.exclude, vec!["bar".to_string()]),
            ConfigMatch::NotFound => panic!("Expected config to be found"),
        }
    }

    #[test]
    fn test_load_package_takes_precedence() {
        let toml = r#"
        [workspace.metadata.lychee]
        exclude = ["bar"]

        [package.metadata.lychee]
        exclude = ["foo"]
        "#;
        let result = CargoTomlLoader.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_no_lychee_config() {
        let toml = r#"
        [package]
        name = "lychee"
        version = "1.0.0"

        [workspace]
        members = ["lychee-bin"]
        "#;
        let result = CargoTomlLoader.load(toml).unwrap();
        match result {
            ConfigMatch::NotFound => (),
            ConfigMatch::Found(_) => panic!("Expected no config to be found"),
        }
    }
}