typstify-core 0.1.5

Core types and configuration for Typstify
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
//! Site configuration management.

use std::{collections::HashMap, path::Path};

use serde::{Deserialize, Serialize};

use crate::error::{CoreError, Result};

/// Main configuration structure for Typstify.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Config {
    /// Site-wide settings.
    pub site: SiteConfig,

    /// Build settings.
    #[serde(default)]
    pub build: BuildConfig,

    /// Search settings.
    #[serde(default)]
    pub search: SearchConfig,

    /// RSS feed settings.
    #[serde(default)]
    pub rss: RssConfig,

    /// Robots.txt settings.
    #[serde(default)]
    pub robots: RobotsConfig,

    /// Taxonomy settings.
    #[serde(default)]
    pub taxonomies: TaxonomyConfig,

    /// Language-specific configurations.
    #[serde(default)]
    pub languages: HashMap<String, LanguageConfig>,

    /// Cached base URL (host + base_path), computed once after construction.
    #[serde(skip)]
    pub cached_base_url: String,
}

/// Site-wide configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SiteConfig {
    /// Site title.
    pub title: String,

    /// Host URL for the site (e.g., "https://example.com").
    /// This is the origin without any path.
    pub host: String,

    /// Base path for subdirectory deployments (e.g., "/typstify").
    /// Empty string for root deployments.
    #[serde(default)]
    pub base_path: String,

    /// Default language code.
    #[serde(default = "default_language")]
    pub default_language: String,

    /// Site description for meta tags.
    #[serde(default)]
    pub description: Option<String>,

    /// Site author name.
    #[serde(default)]
    pub author: Option<String>,
}

/// Configuration for a specific language.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct LanguageConfig {
    /// Display name of the language (e.g., "中文", "日本語").
    #[serde(default)]
    pub name: Option<String>,

    /// Override site title for this language.
    #[serde(default)]
    pub title: Option<String>,

    /// Override site description for this language.
    #[serde(default)]
    pub description: Option<String>,
}

/// Build configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BuildConfig {
    /// Output directory for generated site.
    #[serde(default = "default_output_dir")]
    pub output_dir: String,

    /// Whether to minify HTML output.
    #[serde(default)]
    pub minify: bool,

    /// Syntax highlighting theme name.
    #[serde(default = "default_syntax_theme")]
    pub syntax_theme: String,

    /// Whether to generate drafts.
    #[serde(default)]
    pub drafts: bool,

    /// Whether to sanitize raw HTML in markdown output.
    #[serde(default)]
    pub sanitize_html: bool,
}

/// Search configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchConfig {
    /// Whether search is enabled.
    #[serde(default = "default_true")]
    pub enabled: bool,

    /// Fields to include in search index.
    #[serde(default = "default_index_fields")]
    pub index_fields: Vec<String>,

    /// Chunk size for index splitting (bytes).
    #[serde(default = "default_chunk_size")]
    pub chunk_size: usize,
}

/// RSS feed configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RssConfig {
    /// Whether RSS feed is enabled.
    #[serde(default = "default_true")]
    pub enabled: bool,

    /// Maximum number of items in feed.
    #[serde(default = "default_rss_limit")]
    pub limit: usize,
}

/// Robots.txt configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RobotsConfig {
    /// Whether robots.txt generation is enabled.
    #[serde(default = "default_true")]
    pub enabled: bool,

    /// Disallowed paths.
    #[serde(default)]
    pub disallow: Vec<String>,

    /// Allowed paths.
    #[serde(default)]
    pub allow: Vec<String>,
}

/// Taxonomy configuration.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TaxonomyConfig {
    /// Tags taxonomy settings.
    #[serde(default)]
    pub tags: TaxonomySettings,

    /// Categories taxonomy settings.
    #[serde(default)]
    pub categories: TaxonomySettings,
}

/// Settings for a single taxonomy.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TaxonomySettings {
    /// Number of items per page.
    #[serde(default = "default_paginate")]
    pub paginate: usize,
}

// Default value functions
fn default_language() -> String {
    "en".to_string()
}

fn default_output_dir() -> String {
    "public".to_string()
}

fn default_syntax_theme() -> String {
    "base16-ocean.dark".to_string()
}

fn default_true() -> bool {
    true
}

fn default_index_fields() -> Vec<String> {
    vec!["title".to_string(), "body".to_string(), "tags".to_string()]
}

fn default_chunk_size() -> usize {
    65536 // 64KB
}

fn default_rss_limit() -> usize {
    20
}

fn default_paginate() -> usize {
    10
}

impl Default for BuildConfig {
    fn default() -> Self {
        Self {
            output_dir: default_output_dir(),
            minify: false,
            syntax_theme: default_syntax_theme(),
            drafts: false,
            sanitize_html: false,
        }
    }
}

impl Default for SearchConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            index_fields: default_index_fields(),
            chunk_size: default_chunk_size(),
        }
    }
}

impl Default for RssConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            limit: default_rss_limit(),
        }
    }
}

impl Default for RobotsConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            disallow: Vec::new(),
            allow: Vec::new(),
        }
    }
}

impl Default for TaxonomySettings {
    fn default() -> Self {
        Self {
            paginate: default_paginate(),
        }
    }
}

impl Config {
    /// Compute the cached base URL from host and base_path.
    fn compute_base_url(site: &SiteConfig) -> String {
        let host = site.host.trim_end_matches('/');
        let base_path = site.base_path.trim_end_matches('/');
        format!("{host}{base_path}")
    }

    /// Load configuration from a TOML file.
    pub fn load(path: &Path) -> Result<Self> {
        if !path.exists() {
            return Err(CoreError::config(format!(
                "Configuration file not found: {}",
                path.display()
            )));
        }

        let content = std::fs::read_to_string(path)?;
        let mut config: Config = toml::from_str(&content).map_err(|e| {
            CoreError::config_with_source(
                format!("Failed to parse config file: {}", path.display()),
                e,
            )
        })?;

        config.validate()?;
        config.cached_base_url = Self::compute_base_url(&config.site);
        Ok(config)
    }

    /// Load configuration using the config crate for more flexibility.
    pub fn load_with_env(path: &Path) -> Result<Self> {
        let settings = config::Config::builder()
            .add_source(config::File::from(path))
            .add_source(config::Environment::with_prefix("TYPSTIFY").separator("__"))
            .build()?;

        let mut config: Config = settings.try_deserialize()?;
        config.validate()?;
        config.cached_base_url = Self::compute_base_url(&config.site);
        Ok(config)
    }

    /// Validate the configuration.
    fn validate(&self) -> Result<()> {
        if self.site.title.is_empty() {
            return Err(CoreError::config("site.title cannot be empty"));
        }

        if self.site.host.is_empty() {
            return Err(CoreError::config("site.host cannot be empty"));
        }

        // Ensure host doesn't have trailing slash
        if self.site.host.ends_with('/') {
            tracing::warn!("site.host should not have a trailing slash");
        }

        // Ensure base_path starts with / if not empty
        if !self.site.base_path.is_empty() && !self.site.base_path.starts_with('/') {
            tracing::warn!("site.base_path should start with /");
        }

        Ok(())
    }

    /// Get the full base URL (host + base_path).
    #[must_use]
    pub fn base_url(&self) -> &str {
        &self.cached_base_url
    }

    /// Get the full URL for a path.
    pub fn url_for(&self, path: &str) -> String {
        let base = self.base_url();
        let path = path.trim_start_matches('/');
        format!("{base}/{path}")
    }

    /// Get the base path for URL generation.
    /// Returns the configured base_path, ensuring no trailing slash.
    #[must_use]
    pub fn base_path(&self) -> &str {
        self.site.base_path.trim_end_matches('/')
    }

    /// Check if a language code is configured (either as default or in languages map).
    #[must_use]
    pub fn has_language(&self, lang: &str) -> bool {
        lang == self.site.default_language || self.languages.contains_key(lang)
    }

    /// Get all configured language codes.
    #[must_use]
    pub fn all_languages(&self) -> Vec<&str> {
        let mut langs: Vec<&str> = vec![self.site.default_language.as_str()];
        for lang in self.languages.keys() {
            if lang != &self.site.default_language {
                langs.push(lang.as_str());
            }
        }
        langs
    }

    /// Get language-specific title, falling back to site title.
    #[must_use]
    pub fn title_for_language(&self, lang: &str) -> &str {
        self.languages
            .get(lang)
            .and_then(|lc| lc.title.as_deref())
            .unwrap_or(&self.site.title)
    }

    /// Get language-specific description, falling back to site description.
    #[must_use]
    pub fn description_for_language(&self, lang: &str) -> Option<&str> {
        self.languages
            .get(lang)
            .and_then(|lc| lc.description.as_deref())
            .or(self.site.description.as_deref())
    }

    /// Get display name for a language code.
    #[must_use]
    pub fn language_name<'a>(&'a self, lang: &'a str) -> &'a str {
        self.languages
            .get(lang)
            .and_then(|lc| lc.name.as_deref())
            .unwrap_or(lang)
    }

    /// Construct a Config from its public parts.
    #[must_use]
    pub fn from_parts(
        site: SiteConfig,
        build: BuildConfig,
        search: SearchConfig,
        rss: RssConfig,
        robots: RobotsConfig,
        taxonomies: TaxonomyConfig,
        languages: HashMap<String, LanguageConfig>,
    ) -> Self {
        let cached_base_url = Self::compute_base_url(&site);
        Self {
            site,
            build,
            search,
            rss,
            robots,
            taxonomies,
            languages,
            cached_base_url,
        }
    }
}

#[cfg(test)]
mod tests {
    use std::io::Write;

    use super::*;

    fn create_test_config() -> String {
        r#"
[site]
title = "Test Site"
host = "https://example.com"
default_language = "en"

[languages.zh]
name = "中文"
title = "测试站点"
description = "一个测试站点"

[build]
output_dir = "dist"
minify = true
syntax_theme = "OneHalfDark"

[search]
enabled = true
chunk_size = 32768

[rss]
limit = 15

[taxonomies.tags]
paginate = 20
"#
        .to_string()
    }

    #[test]
    fn test_load_config() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let mut file = std::fs::File::create(&config_path).expect("create file");
        file.write_all(create_test_config().as_bytes())
            .expect("write");

        let config = Config::load(&config_path).expect("load config");

        assert_eq!(config.site.title, "Test Site");
        assert_eq!(config.site.host, "https://example.com");
        assert_eq!(config.site.default_language, "en");
        assert!(config.has_language("en"));
        assert!(config.has_language("zh"));
        assert!(!config.has_language("ja"));
        assert_eq!(config.title_for_language("zh"), "测试站点");
        assert_eq!(config.title_for_language("en"), "Test Site");
        assert_eq!(config.language_name("zh"), "中文");
        assert_eq!(config.build.output_dir, "dist");
        assert!(config.build.minify);
        assert_eq!(config.build.syntax_theme, "OneHalfDark");
        assert!(config.search.enabled);
        assert_eq!(config.search.chunk_size, 32768);
        assert_eq!(config.rss.limit, 15);
        assert_eq!(config.taxonomies.tags.paginate, 20);
    }

    #[test]
    fn test_config_defaults() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let minimal_config = r#"
[site]
title = "Minimal Site"
host = "https://example.com"
"#;
        std::fs::write(&config_path, minimal_config).expect("write");

        let config = Config::load(&config_path).expect("load config");

        assert_eq!(config.site.default_language, "en");
        assert_eq!(config.build.output_dir, "public");
        assert!(!config.build.minify);
        assert!(config.search.enabled);
        assert_eq!(config.search.chunk_size, 65536);
        assert_eq!(config.rss.limit, 20);
    }

    #[test]
    fn test_config_validation_empty_title() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let config_content = r#"
[site]
title = ""
host = "https://example.com"
"#;
        std::fs::write(&config_path, config_content).expect("write");

        let result = Config::load(&config_path);
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("title cannot be empty")
        );
    }

    #[test]
    fn test_config_not_found() {
        let result = Config::load(Path::new("/nonexistent/config.toml"));
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("not found"));
    }

    #[test]
    fn test_base_path_empty() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let config_content = r#"
[site]
title = "Test"
host = "https://example.com"
"#;
        std::fs::write(&config_path, config_content).expect("write");
        let config = Config::load(&config_path).expect("load");
        assert_eq!(config.base_path(), "");
        assert_eq!(config.base_url(), "https://example.com");
    }

    #[test]
    fn test_base_path_subdirectory() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let config_content = r#"
[site]
title = "Test"
host = "https://longcipher.github.io"
base_path = "/typstify"
"#;
        std::fs::write(&config_path, config_content).expect("write");
        let config = Config::load(&config_path).expect("load");
        assert_eq!(config.base_path(), "/typstify");
        assert_eq!(config.base_url(), "https://longcipher.github.io/typstify");
    }

    #[test]
    fn test_base_path_with_trailing_slash() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let config_content = r#"
[site]
title = "Test"
host = "https://longcipher.github.io/"
base_path = "/typstify/"
"#;
        std::fs::write(&config_path, config_content).expect("write");
        let config = Config::load(&config_path).expect("load");
        assert_eq!(config.base_path(), "/typstify");
        assert_eq!(config.base_url(), "https://longcipher.github.io/typstify");
    }

    #[test]
    fn test_load_with_env_override() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let mut file = std::fs::File::create(&config_path).expect("create file");
        file.write_all(create_test_config().as_bytes())
            .expect("write");

        // Temporarily set env var to override site.title
        // SAFETY: tests run single-threaded; env var is cleaned up after assertion.
        unsafe { std::env::set_var("TYPSTIFY__SITE__TITLE", "Env Override Title") };

        let config = Config::load_with_env(&config_path).expect("load config with env");

        assert_eq!(config.site.title, "Env Override Title");

        // Clean up env var
        unsafe { std::env::remove_var("TYPSTIFY__SITE__TITLE") };
    }

    #[test]
    fn test_url_for() {
        let dir = tempfile::tempdir().expect("create temp dir");
        let config_path = dir.path().join("config.toml");
        let config_content = r#"
[site]
title = "Test"
host = "https://example.com"
base_path = "/blog"
"#;
        std::fs::write(&config_path, config_content).expect("write");
        let config = Config::load(&config_path).expect("load");
        assert_eq!(
            config.url_for("/posts/hello"),
            "https://example.com/blog/posts/hello"
        );
        assert_eq!(
            config.url_for("posts/hello"),
            "https://example.com/blog/posts/hello"
        );
    }
}