typstgen 0.2.0

Compile existing .typ files to PDF with an embedded Typst engine — no external typst binary, config-driven template resolution. Usable as CLI, Rust lib, and Wasm.
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

//! Config-driven template path resolution.
//!
//! typstgen never hardcodes where templates live. Resolution order:
//!   1. `--config <path>` (explicit file, CLI/lib caller)
//!   2. `./typstgen.toml` (project-local)
//!   3. [`Config::default`] fallback paths
//!
//! See docs/PLAN.md for why this exists (docgen only ever shipped the
//! project-local half of its own planned 3-tier resolution strategy).

use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};

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

/// Settings from `typstgen.toml`. Missing keys keep their [`Default`] value.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct Config {
    /// Directories searched (in order) for `#import` resolution. Each import
    /// is looked up in every existing directory; the first match wins.
    /// Entries that do not exist or are not directories are skipped.
    pub template_paths: Vec<PathBuf>,
    /// Additional font directories (native builds only).
    pub font_paths: Vec<PathBuf>,
    /// Scan system fonts. Always forced to `false` on the wasm target,
    /// regardless of this setting — see src/world.rs.
    pub use_system_fonts: bool,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            template_paths: vec![
                PathBuf::from("./templates"),
                PathBuf::from("./.typstgen/templates"),
            ],
            font_paths: vec![],
            use_system_fonts: true,
        }
    }
}

impl Config {
    /// Load config, following the resolution order documented on [`Config`].
    pub fn load(explicit_path: Option<&Path>) -> Result<Self> {
        let candidate = match explicit_path {
            Some(path) => Some(path.to_path_buf()),
            None => {
                let default_path = PathBuf::from("typstgen.toml");
                default_path.exists().then_some(default_path)
            }
        };

        let Some(path) = candidate else {
            return Ok(Self::default());
        };

        let raw = std::fs::read_to_string(&path).map_err(|source| Error::Config {
            path: path.clone(),
            source,
        })?;
        Ok(toml::from_str(&raw)?)
    }

    /// Configured template directories that exist on disk, in order,
    /// canonicalized and without duplicates. May be empty.
    pub fn template_roots(&self) -> Vec<PathBuf> {
        let mut roots = Vec::new();
        for path in &self.template_paths {
            if let Ok(root) = path.canonicalize() {
                if root.is_dir() && !roots.contains(&root) {
                    roots.push(root);
                }
            }
        }
        roots
    }
}