sigil-stitch 0.3.1

Type-safe, import-aware, width-aware code generation for multiple languages
Documentation
//! Multi-file project specification.
//!
//! `ProjectSpec` orchestrates rendering multiple `FileSpec`s as a unit,
//! returning an in-memory collection of rendered files or writing them
//! to the filesystem.

use crate::error::SigilStitchError;
use crate::spec::file_spec::FileSpec;

/// A rendered file produced by [`ProjectSpec::render()`]: path and content pair.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RenderedFile {
    /// The file path (as provided to `FileSpec::builder`).
    pub path: String,
    /// The rendered file content.
    pub content: String,
}

/// A multi-file project that renders all files as a unit.
///
/// `ProjectSpec` orchestrates rendering multiple [`FileSpec`]s, returning an
/// in-memory collection of [`RenderedFile`]s or writing them to the filesystem.
/// Each file resolves imports independently.
///
/// # Examples
///
/// ```
/// use sigil_stitch::prelude::*;
/// use sigil_stitch::lang::typescript::TypeScript;
///
/// let models = FileSpec::builder("src/models.ts")
///     .add_type(TypeSpec::builder("User", TypeKind::Interface).build().unwrap())
///     .build().unwrap();
///
/// let index = FileSpec::builder("src/index.ts")
///     .add_code(CodeBlock::of("export {}", ()).unwrap())
///     .build().unwrap();
///
/// let project = ProjectSpec::builder()
///     .add_file(models)
///     .add_file(index)
///     .build();
///
/// let rendered = project.render(80).unwrap();
/// assert_eq!(rendered.len(), 2);
/// ```
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct ProjectSpec {
    pub(crate) files: Vec<FileSpec>,
}

impl ProjectSpec {
    /// Create a new builder for a project specification.
    pub fn builder() -> ProjectSpecBuilder {
        ProjectSpecBuilder { files: Vec::new() }
    }

    /// Render all files and return their paths and contents.
    ///
    /// Each file resolves imports independently. File ordering is preserved.
    /// Fails on the first render error, including the filename in the message.
    pub fn render(&self, width: usize) -> Result<Vec<RenderedFile>, SigilStitchError> {
        let mut rendered = Vec::with_capacity(self.files.len());
        for file in &self.files {
            let content = file.render(width)?;
            rendered.push(RenderedFile {
                path: file.filename().to_string(),
                content,
            });
        }
        Ok(rendered)
    }

    /// Render all files and write them to `base_dir`.
    ///
    /// Creates parent directories as needed. Returns the list of written paths.
    pub fn write_to(
        &self,
        base_dir: &std::path::Path,
        width: usize,
    ) -> Result<Vec<std::path::PathBuf>, SigilStitchError> {
        let rendered = self.render(width)?;

        let mut written = Vec::with_capacity(rendered.len());
        for file in &rendered {
            let full_path = base_dir.join(&file.path);
            if let Some(parent) = full_path.parent() {
                std::fs::create_dir_all(parent).map_err(|source| SigilStitchError::Io {
                    source,
                    context: format!("creating directory for {}", file.path),
                })?;
            }
            std::fs::write(&full_path, &file.content).map_err(|source| SigilStitchError::Io {
                source,
                context: format!("writing file {}", file.path),
            })?;
            written.push(full_path);
        }
        Ok(written)
    }
}

/// Builder for [`ProjectSpec`].
#[derive(Debug)]
pub struct ProjectSpecBuilder {
    files: Vec<FileSpec>,
}

impl ProjectSpecBuilder {
    /// Add a file to the project.
    pub fn add_file(mut self, file: FileSpec) -> Self {
        self.files.push(file);
        self
    }

    /// Build the [`ProjectSpec`].
    pub fn build(self) -> ProjectSpec {
        ProjectSpec { files: self.files }
    }
}