hauchiwa 0.8.2

Incredibly flexible static site generator library with incremental rebuilds and cached image optimization
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

use thiserror::Error;

use crate::{SiteConfig, error::HauchiwaError, loader::GlobRegistryTask, task::Handle};

/// Errors that can occur when compiling Stylesheets.
#[derive(Debug, Error)]
pub enum StyleError {
    /// An I/O error occurred.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// A Sass compilation error occurred.
    #[error("Sass compilation error: {0}")]
    Sass(#[from] Box<grass::Error>),

    /// An internal build error.
    #[error("Build error: {0}")]
    Build(#[from] crate::error::BuildError),
}

/// Represents a compiled CSS file.
#[derive(Debug, Clone)]
pub struct Stylesheet {
    /// The path to the compiled CSS file.
    pub path: camino::Utf8PathBuf,
}

impl<G> SiteConfig<G>
where
    G: Send + Sync + 'static,
{
    /// Compiles Sass/SCSS files to CSS.
    ///
    /// This loader uses the `grass` crate to compile Sass files matching the entry glob.
    /// It returns a registry of compiled CSS files.
    ///
    /// # Arguments
    ///
    /// * `glob_entry`: Glob pattern for the entry stylesheets (e.g., "styles/main.scss").
    /// * `glob_watch`: Glob pattern for files to watch (e.g., "styles/**/*.scss").
    ///
    /// # Returns
    ///
    /// A handle to a registry mapping original file paths to `CSS` objects.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// // Compile main.scss, watching all scss files in the styles directory for changes.
    /// let styles = config.load_css("styles/main.scss", "styles/**/*.scss")?;
    /// ```
    pub fn load_css(
        &mut self,
        glob_entry: &'static str,
        glob_watch: &'static str,
    ) -> Result<Handle<super::Registry<Stylesheet>>, HauchiwaError> {
        Ok(self.add_task_opaque(GlobRegistryTask::new(
            vec![glob_entry],
            vec![glob_watch],
            move |_, rt, file| {
                let data = grass::from_path(&file.path, &grass::Options::default())
                    .map_err(StyleError::Sass)?;

                let path = rt
                    .store(data.as_bytes(), "css")
                    .map_err(StyleError::Build)?;

                Ok((file.path, Stylesheet { path }))
            },
        )?))
    }
}