Struct PluginContext 

pub struct PluginContext {
    pub content_dir: PathBuf,
    pub build_dir: PathBuf,
    pub site_dir: PathBuf,
    pub template_dir: PathBuf,
    pub config: Option<SsgConfig>,
    pub cache: Option<PluginCache>,
    pub memory_budget: Option<MemoryBudget>,
    pub html_files: Option<Arc<Vec<PathBuf>>>,
    pub dep_graph: Option<DepGraph>,
    pub dry_run: bool,
}

Context passed to plugin hooks with paths and configuration.

Fields

content_dir: PathBuf

The content source directory.

build_dir: PathBuf

The build/output directory.

site_dir: PathBuf

The final site directory.

template_dir: PathBuf

The template directory.

config: Option<SsgConfig>

Site configuration (base_url, site_name, language, etc.).

cache: Option<PluginCache>

Content-addressed plugin cache for incremental builds.

memory_budget: Option<MemoryBudget>

Memory budget for streaming compilation.

html_files: Option<Arc<Vec<PathBuf>>>

Cached list of HTML files in site_dir, walked once and shared across all plugins to avoid redundant filesystem traversals.

dep_graph: Option<DepGraph>

Page dependency graph for incremental rebuilds.

dry_run: bool

When true, plugins should perform validation passes only and must not write to disk. Set by the ssg check subcommand (issue #527). Plugins that don’t have a meaningful read-only mode may safely ignore this flag.

Implementations

impl PluginContext

pub fn cache_html_files(&mut self)

Populates the cached HTML file list by walking site_dir once. Call this before running after_compile plugins to eliminate redundant directory scans (8+ plugins read the same file list).

Examples

use ssg::plugin::PluginContext;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let mut ctx = PluginContext::new(dir.path(), dir.path(), dir.path(), dir.path());
ctx.cache_html_files();
// Empty dir ⇒ empty cached list.
assert!(ctx.get_html_files().is_empty());

pub fn get_html_files(&self) -> Vec<PathBuf>

Returns the cached HTML file list, or walks the directory if the cache hasn’t been populated.

Examples

use ssg::plugin::PluginContext;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let ctx = PluginContext::new(dir.path(), dir.path(), dir.path(), dir.path());
assert!(ctx.get_html_files().is_empty());

pub fn new( content_dir: &Path, build_dir: &Path, site_dir: &Path, template_dir: &Path, ) -> Self

Creates a new plugin context from directory paths.

Examples

use ssg::plugin::PluginContext;
use std::path::Path;

let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"),    Path::new("templates"),
);
assert_eq!(ctx.content_dir, Path::new("content"));

pub fn with_config( content_dir: &Path, build_dir: &Path, site_dir: &Path, template_dir: &Path, config: SsgConfig, ) -> Self

Creates a new plugin context with site configuration.

Examples

use ssg::cmd::SsgConfig;
use ssg::plugin::PluginContext;
use std::path::Path;

let cfg = SsgConfig::default();
let ctx = PluginContext::with_config(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
    cfg,
);
assert!(ctx.config.is_some());

pub const fn with_dry_run(self, dry_run: bool) -> Self

Sets the dry_run flag and returns the modified context.

Used by the ssg check subcommand (issue #527) to signal to plugins that they should run their validation passes without writing to disk.

Examples

use ssg::plugin::PluginContext;
use std::path::Path;

let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
).with_dry_run(true);
assert!(ctx.dry_run);

Trait Implementations

impl Clone for PluginContext

fn clone(&self) -> PluginContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.