scraps 3.6.0

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.
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

use crate::cli::path_resolver::PathResolver;
use crate::error::{CliError, ScrapsResult, anyhow::Context};
use crate::usecase::build::model::{
    build_config::BuildConfig, color_scheme::ColorScheme, css::CssMetadata, html::HtmlMetadata,
    list_view_configs::ListViewConfigs, paging::Paging,
};
use chrono_tz::Tz;
use config::Config;
use scraps_libs::lang::LangCode;
use scraps_libs::model::base_url::BaseUrl;
use serde::Deserialize;
use std::path::{Path, PathBuf};
use url::Url;

use super::{base_url::BaseUrlConfig, color_scheme::ColorSchemeConfig, lang::LangCodeConfig};

/// SSG-specific configuration (site generation settings)
#[derive(Debug, Deserialize)]
pub struct SsgConfig {
    pub base_url: BaseUrlConfig,
    pub title: String,
    pub lang_code: Option<LangCodeConfig>,
    pub description: Option<String>,
    pub favicon: Option<Url>,
    pub build_search_index: Option<bool>,
    pub paginate_by: Option<usize>,
    pub color_scheme: Option<ColorSchemeConfig>,
}

impl SsgConfig {
    /// Gets base_url as BaseUrl
    pub fn base_url(&self) -> BaseUrl {
        self.base_url.clone().into_base_url()
    }
}

/// Lint-specific configuration. Each rule lives in its own nested table.
///
/// Rules surface opt-in/opt-out via `enabled` (default `true` when the
/// section is present) and rule-specific parameters as sibling fields. This
/// keeps selection and parameters co-located, so writing `[lint.stale_by_git]`
/// is enough to opt in with defaults.
#[derive(Debug, Deserialize, Default)]
pub struct LintConfig {
    pub stale_by_git: Option<StaleByGitConfig>,
    pub unportable_key: Option<UnportableKeyConfig>,
}

/// Configuration for the `stale_by_git` lint rule.
///
/// `enabled` defaults to `true` when the section is present in `.scraps.toml`,
/// so a bare `[lint.stale_by_git]` opts the rule in. Setting `enabled = false`
/// disables the rule while preserving the threshold for later toggling.
#[derive(Debug, Deserialize)]
pub struct StaleByGitConfig {
    #[serde(default = "default_true")]
    pub enabled: bool,
    pub threshold_days: Option<u64>,
}

/// Configuration for the `unportable_key` lint rule, opted into the same way
/// as `stale_by_git`: a bare `[lint.unportable_key]` enables it.
#[derive(Debug, Deserialize)]
pub struct UnportableKeyConfig {
    #[serde(default = "default_true")]
    pub enabled: bool,
}

fn default_true() -> bool {
    true
}

/// Main configuration struct
#[derive(Debug, Deserialize)]
pub struct ScrapConfig {
    pub output_dir: Option<PathBuf>,
    pub timezone: Option<Tz>,
    pub ssg: Option<SsgConfig>,
    pub lint: Option<LintConfig>,
}

impl ScrapConfig {
    pub fn from_path(project_path: Option<&Path>) -> ScrapsResult<ScrapConfig> {
        let path_resolver = PathResolver::new(project_path)?;
        let config_path = path_resolver.config_path();

        let config = Config::builder()
            .add_source(config::File::from(config_path))
            .build()
            .context(CliError::ConfigLoad)?;

        config
            .try_deserialize::<ScrapConfig>()
            .context(CliError::InvalidConfigFormat)
    }

    /// Requires SSG section to be present (for build/serve commands)
    pub fn require_ssg(&self) -> ScrapsResult<&SsgConfig> {
        self.ssg
            .as_ref()
            .ok_or_else(|| CliError::MissingSsgSection.into())
    }

    /// Gets optional base_url if ssg section is present
    pub fn get_base_url(&self) -> Option<BaseUrl> {
        self.ssg.as_ref().map(|s| s.base_url())
    }

    /// Resolve the settings a build run needs, applying the defaults for every
    /// omitted `[ssg]` key. `base_url` overrides the configured one, which
    /// `serve` needs so links point at the local address it listens on.
    pub fn to_build_config(&self, base_url: Option<BaseUrl>) -> ScrapsResult<BuildConfig> {
        let ssg = self.require_ssg()?;

        let default_lang_code = LangCode::default();
        let lang_code = ssg
            .lang_code
            .as_ref()
            .map(|c| c.as_lang_code())
            .unwrap_or(&default_lang_code);
        let html_metadata =
            HtmlMetadata::new(lang_code, &ssg.title, &ssg.description, &ssg.favicon);

        let default_color_scheme = ColorScheme::OsSetting;
        let css_metadata = CssMetadata::new(
            ssg.color_scheme
                .as_ref()
                .map(|c| c.as_color_scheme())
                .unwrap_or(&default_color_scheme),
        );

        let paging = match ssg.paginate_by {
            None => Paging::Not,
            Some(u) => Paging::By(u),
        };
        let list_view_configs =
            ListViewConfigs::new(&ssg.build_search_index.unwrap_or(true), &paging);

        Ok(BuildConfig {
            base_url: base_url.unwrap_or_else(|| ssg.base_url()),
            timezone: self.timezone.unwrap_or(chrono_tz::UTC),
            html_metadata,
            css_metadata,
            list_view_configs,
        })
    }
}