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

//! `package.json` configuration loader.
//!
//! This module allows configuring lychee via a `"lychee"` object inside
//! a `package.json` file, which is standard for Node.js / JavaScript projects.
//!
//! # Example
//!
//! ```json
//! {
//!   "name": "my-project",
//!   "version": "1.0.0",
//!   "lychee": {
//!     "exclude": ["foo", "bar"],
//!     "timeout": 10
//!   }
//! }
//! ```

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

pub(crate) const PACKAGE_JSON_CONFIG_FILE: &str = "package.json";

/// A minimal representation of `package.json` that only parses the `lychee` key
#[derive(Deserialize)]
struct PackageJson {
    lychee: Option<Config>,
}

pub(crate) struct PackageJsonLoader;

impl ConfigLoader for PackageJsonLoader {
    fn filename(&self) -> &str {
        PACKAGE_JSON_CONFIG_FILE
    }

    fn load(&self, contents: &str) -> Result<ConfigMatch> {
        let package_json = serde_json::from_str::<PackageJson>(contents)
            .with_context(|| "Failed to parse lychee config from package.json")?;

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

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

    #[test]
    fn test_load_config() {
        let json = r#"
        {
            "name": "my-project",
            "lychee": {
                "exclude": ["foo"]
            }
        }
        "#;
        let result = PackageJsonLoader.load(json).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 json = r#"
        {
            "name": "my-project",
            "version": "1.0.0"
        }
        "#;
        let result = PackageJsonLoader.load(json).unwrap();
        match result {
            ConfigMatch::NotFound => (),
            ConfigMatch::Found(_) => panic!("Expected no config to be found"),
        }
    }

    #[test]
    fn test_invalid_json() {
        let json = r#"
        {
            "name": "my-project",
            "lychee": {
                "exclude": ["foo",
        "#;
        assert!(PackageJsonLoader.load(json).is_err());
    }
}