Struct LlmPlugin 

pub struct LlmPlugin { /* private fields */ }

Plugin that uses a local LLM to augment content at build time.

Implementations

impl LlmPlugin

pub const fn new(config: LlmConfig) -> Self

Creates a new LlmPlugin with the given configuration.

Examples

use ssg::llm::{LlmConfig, LlmPlugin};
use ssg::plugin::Plugin;

let p = LlmPlugin::new(LlmConfig::default());
assert_eq!(p.name(), "llm");

impl LlmPlugin

pub fn audit_all(content_dir: &Path, target_grade: f64) -> Result<AuditReport>

Audits all Markdown files in a directory for readability.

Returns a structured report with per-file Flesch-Kincaid scores. Does not require an LLM — uses the local ReadabilityAudit engine.

Note: The syllable heuristic is English-only. Non-English content (Bengali, Hindi, Turkish, etc.) produces inflated scores. Use the en/ subdirectory for accurate results on multilingual repos, or filter results by locale.

Examples

use ssg::llm::LlmPlugin;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let report = LlmPlugin::audit_all(dir.path(), 8.0).unwrap();
// Empty dir ⇒ no files audited.
assert_eq!(report.total_files, 0);

pub fn audit_and_fix(content_dir: &Path, config: &LlmConfig) -> Result<usize>

Audits and rewrites failing Markdown files via LLM refinement.

For each file that exceeds target_grade:

1. Extracts the prose body (strips frontmatter)
2. Sends it to the LLM with a simplification prompt
3. If the refined version scores better, writes it back (preserving the original frontmatter)
4. If dry_run, prints the diff without writing

Returns the number of files rewritten.

Examples

use ssg::llm::{LlmConfig, LlmPlugin};
use tempfile::tempdir;

let dir = tempdir().unwrap();
// No Ollama reachable ⇒ returns Ok(0) without writing anything.
let cfg = LlmConfig {
    endpoint: "http://127.0.0.1:1".into(),
    ..LlmConfig::default()
};
assert_eq!(LlmPlugin::audit_and_fix(dir.path(), &cfg).unwrap(), 0);

pub fn audit_and_fix_with_report( content_dir: &Path, config: &LlmConfig, ) -> Result<AiFixReport>

Agentic pipeline: audit → diagnose → fix → verify → report.

Like audit_and_fix() but returns a detailed JSON-serialisable report with before/after scores for each file.

Examples

use ssg::llm::{LlmConfig, LlmPlugin};
use tempfile::tempdir;

let dir = tempdir().unwrap();
let cfg = LlmConfig {
    endpoint: "http://127.0.0.1:1".into(),
    ..LlmConfig::default()
};
let report = LlmPlugin::audit_and_fix_with_report(dir.path(), &cfg).unwrap();
assert_eq!(report.total_fixed, 0);

impl LlmPlugin

pub fn query(&self, prompt: &str) -> Result<String, SsgError>

Typed entry point for invoking the configured local LLM (issue #520, AC4/AC5).

Unlike the in-tree augmentation helpers which swallow errors and fall back to leaving content untouched, query surfaces transport and protocol failures as typed SsgError variants so external callers (CLI commands, integration tests, custom pipelines) can react appropriately.

Examples

use ssg::llm::{LlmConfig, LlmPlugin};

// No Ollama running ⇒ deterministic transport error.
let cfg = LlmConfig {
    endpoint: "http://127.0.0.1:1".into(),
    ..LlmConfig::default()
};
let plugin = LlmPlugin::new(cfg);
assert!(plugin.query("hi").is_err());

Errors

See query_ollama for the exact variants.

Trait Implementations

impl Debug for LlmPlugin

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

Formats the value using the given formatter.

impl Plugin for LlmPlugin

fn name(&self) -> &'static str

Returns the unique name of this plugin.

fn after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Called after site compilation completes.

fn before_compile(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before site compilation begins.

fn transform_html( &self, html: &str, _path: &Path, _ctx: &PluginContext, ) -> Result<String, SsgError>

Per-file HTML transform hook — called once per HTML file during the fused transform pass.

fn has_transform(&self) -> bool

Returns true if this plugin implements transform_html. Override to true to opt in to the fused transform pass.

fn needs_all_files(&self) -> bool

Returns true if this plugin must always observe the full cache.html_files() list — even during --incremental rebuilds that only invalidated a handful of pages.

fn on_serve(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before the development server starts serving files.