typwriter 0.14.27

A Rust library for compiling, formatting, and watching Typst documents, with PDF metadata and permission management.
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

use std::{fs::read_to_string, path::PathBuf};

use typstyle_core::{Config, Typstyle};

/// Parameters for a formatting operation.
///
/// See also [`format()`].
#[derive(Debug, Clone, Default)]
pub struct FormatParams {
    /// Path to the input Typst file.
    pub input: PathBuf,

    /// The width of the output.
    pub column: usize,

    /// The number of spaces to use for a tab character.
    pub tab_spaces: usize,
}

/// Formats a Typst file with [Enter-tainer/typstyle](https://github.com/Enter-tainer/typstyle/).
///
/// # Arguments
///
/// - `params` - [`FormatParams`] struct.
///
/// # Returns
///
/// String containing the formatted Typst file.
///
/// # Example
///
/// Following is an example of how to use the `format` function:
///
/// ```rust
/// let params = typwriter::FormatParams {
///     input: std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
///         .join("examples")
///         .join("sample.typ"),
///     column: 80,
///     tab_spaces: 2,
/// };
///
/// println!("{}", typwriter::format(&params).map_or_else(|why| why.to_string(), |s| s));
/// ```
pub fn format(params: &FormatParams) -> Result<String, Box<dyn std::error::Error>> {
    let config = Config::new()
        .with_width(params.column)
        .with_tab_spaces(params.tab_spaces);
    let result = Typstyle::new(config)
        .format_text(&read_to_string(&params.input)?)
        .render()
        .map_err(|why| why.to_string())?;
    Ok(result)
}