use anyhow::{Context, Result};
use std::{fs, path::Path};
pub fn scaffold_project(name: &str) -> Result<()> {
let cwd = std::env::current_dir()?;
scaffold_project_at(name, &cwd)
}
pub fn scaffold_project_at(name: &str, base: &Path) -> Result<()> {
let root = base.join(name);
if root.exists() {
anyhow::bail!("Directory '{name}' already exists");
}
let dirs = [
"",
"content",
"content/blog",
"templates/tera",
"static/css",
"data",
];
for dir in &dirs {
fail::fail_point!("scaffold::create-dir", |_| {
anyhow::bail!("injected: scaffold::create-dir")
});
fs::create_dir_all(root.join(dir))
.with_context(|| format!("Failed to create {name}/{dir}"))?;
}
fail::fail_point!("scaffold::write-config", |_| {
anyhow::bail!("injected: scaffold::write-config")
});
fs::write(
root.join("config.toml"),
format!(
r#"site_name = "{name}"
content_dir = "content"
output_dir = "public"
template_dir = "templates"
base_url = "http://127.0.0.1:8000"
site_title = "{name}"
site_description = "A site built with SSG"
language = "en-GB"
"#
),
)?;
fail::fail_point!("scaffold::write-index", |_| {
anyhow::bail!("injected: scaffold::write-index")
});
fs::write(
root.join("content/index.md"),
format!(
r"---
title: Welcome to {name}
description: A fast, accessible static site built with SSG
layout: index
---
# Welcome
This is your new SSG site. Edit `content/index.md` to get started.
## Features
- Tera templating with inheritance
- WCAG 2.1 AA accessibility by default
- JSON-LD structured data for SEO
- Syntax highlighting for code blocks
- Responsive image optimisation
- Client-side search
"
),
)?;
fail::fail_point!("scaffold::write-about", |_| {
anyhow::bail!("injected: scaffold::write-about")
});
fs::write(
root.join("content/about.md"),
r"---
title: About
description: About this site
layout: page
---
# About
This page was generated by [SSG](https://shokunin.one).
",
)?;
fail::fail_point!("scaffold::write-post", |_| {
anyhow::bail!("injected: scaffold::write-post")
});
fs::write(
root.join("content/blog/first-post.md"),
format!(
r#"---
title: First Post
description: My first blog post
layout: post
date: 2026-01-01
author: {name} Team
tags:
- welcome
- getting-started
categories:
- blog
---
# First Post
Welcome to **{name}**! This is your first blog post.
## Code Example
```rust
fn main() {{
println!("Hello from {name}!");
}}
```
{{{{< tip >}}}}
Edit this file at `content/blog/first-post.md`.
{{{{< /tip >}}}}
"#
),
)?;
fail::fail_point!("scaffold::write-base", |_| {
anyhow::bail!("injected: scaffold::write-base")
});
fs::write(
root.join("templates/tera/base.html"),
r##"<!DOCTYPE html>
<html lang="{{ site.language | default(value='en') }}">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{% block title %}{{ page.title | default(value="Untitled") }}{% if site.title %} — {{ site.title }}{% endif %}{% endblock %}</title>
{% if page.description %}<meta name="description" content="{{ page.description }}">{% endif %}
<link rel="stylesheet" href="/css/style.css">
{% block head_extra %}{% endblock %}
</head>
<body>
<a href="#main-content" class="sr-only">Skip to main content</a>
<header role="banner">
<nav aria-label="Main navigation">
<a href="/">{{ site.name | default(value="Home") }}</a>
<a href="/about.html">About</a>
</nav>
</header>
<main id="main-content" role="main">
{% block content %}{% endblock %}
</main>
<footer role="contentinfo">
<p>© {{ site.name | default(value="") }}. Built with <a href="https://shokunin.one">SSG</a>.</p>
</footer>
</body>
</html>
"##,
)?;
fail::fail_point!("scaffold::write-page-tpl", |_| {
anyhow::bail!("injected: scaffold::write-page-tpl")
});
fs::write(
root.join("templates/tera/page.html"),
r#"{% extends "base.html" %}
{% block content %}{{ page.content | safe }}{% endblock %}
"#,
)?;
fail::fail_point!("scaffold::write-post-tpl", |_| {
anyhow::bail!("injected: scaffold::write-post-tpl")
});
fs::write(
root.join("templates/tera/post.html"),
r#"{% extends "base.html" %}
{% block content %}
<article>
<header>
<h1>{{ page.title | default(value="") }}</h1>
{% if page.date %}<time datetime="{{ page.date }}">{{ page.date }}</time>{% endif %}
{% if page.author %}<span class="author">by {{ page.author }}</span>{% endif %}
{% if page.content %}<span class="reading-time">{{ page.content | reading_time }}</span>{% endif %}
</header>
<div class="post-body">{{ page.content | safe }}</div>
{% if page.tags %}
<footer>
<ul class="tags" aria-label="Tags">
{% for tag in page.tags %}<li><a href="/tags/{{ tag | slugify }}/">{{ tag }}</a></li>{% endfor %}
</ul>
</footer>
{% endif %}
</article>
{% endblock %}
"#,
)?;
fail::fail_point!("scaffold::write-index-tpl", |_| {
anyhow::bail!("injected: scaffold::write-index-tpl")
});
fs::write(
root.join("templates/tera/index.html"),
r#"{% extends "base.html" %}
{% block title %}{{ site.title | default(value="Home") }}{% endblock %}
{% block content %}
<section>{{ page.content | safe }}</section>
{% endblock %}
"#,
)?;
fail::fail_point!("scaffold::write-css", |_| {
anyhow::bail!("injected: scaffold::write-css")
});
fs::write(
root.join("static/css/style.css"),
r#"/* SSG Default Styles */
:root {
--text: #1a1a2e;
--bg: #ffffff;
--accent: #0066cc;
--muted: #6b7280;
--border: #e5e7eb;
--radius: 6px;
}
@media (prefers-color-scheme: dark) {
:root {
--text: #e6edf3;
--bg: #0d1117;
--accent: #58a6ff;
--muted: #8b949e;
--border: #30363d;
}
}
*, *::before, *::after { box-sizing: border-box; }
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
color: var(--text);
background: var(--bg);
line-height: 1.6;
max-width: 48rem;
margin: 0 auto;
padding: 1rem 1.5rem;
}
a { color: var(--accent); }
nav { display: flex; gap: 1rem; padding: 1rem 0; border-bottom: 1px solid var(--border); }
main { padding: 2rem 0; }
footer { border-top: 1px solid var(--border); padding: 1rem 0; color: var(--muted); font-size: 0.875rem; }
pre { background: #f6f8fa; border: 1px solid var(--border); border-radius: var(--radius); padding: 1em; overflow-x: auto; }
@media (prefers-color-scheme: dark) { pre { background: #161b22; } }
code { font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace; font-size: 0.875em; }
.sr-only { position: absolute; width: 1px; height: 1px; overflow: hidden; clip: rect(0,0,0,0); white-space: nowrap; }
.admonition { border-left: 4px solid var(--accent); padding: 0.75rem 1rem; margin: 1rem 0; border-radius: var(--radius); }
.admonition-title { font-weight: 600; margin-bottom: 0.25rem; }
.tags { list-style: none; padding: 0; display: flex; gap: 0.5rem; }
.tags li a { background: var(--border); padding: 0.25rem 0.5rem; border-radius: var(--radius); text-decoration: none; font-size: 0.875rem; }
article time, article .author, article .reading-time { color: var(--muted); font-size: 0.875rem; margin-right: 1rem; }
"#,
)?;
fail::fail_point!("scaffold::write-nav", |_| {
anyhow::bail!("injected: scaffold::write-nav")
});
fs::write(
root.join("data/nav.toml"),
r#"[[links]]
name = "Home"
url = "/"
[[links]]
name = "About"
url = "/about.html"
[[links]]
name = "Blog"
url = "/blog/"
"#,
)?;
println!("Created new project: {name}");
println!(" cd {name}");
println!(" ssg -f config.toml");
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use tempfile::tempdir;
#[test]
fn scaffold_project_at_creates_complete_directory_structure() {
let dir = tempdir().unwrap();
let name = "test-site";
let project = dir.path().join(name);
scaffold_project_at(name, dir.path()).unwrap();
for sub in [
"",
"content",
"content/blog",
"templates/tera",
"static/css",
"data",
] {
assert!(
project.join(sub).exists(),
"subdirectory `{sub}` should have been created"
);
}
}
#[test]
fn scaffold_project_at_writes_all_expected_files() {
let dir = tempdir().unwrap();
let name = "demo";
let project = dir.path().join(name);
scaffold_project_at(name, dir.path()).unwrap();
for file in [
"config.toml",
"content/index.md",
"content/about.md",
"content/blog/first-post.md",
"templates/tera/base.html",
"templates/tera/page.html",
"templates/tera/post.html",
"templates/tera/index.html",
"static/css/style.css",
"data/nav.toml",
] {
assert!(
project.join(file).exists(),
"file `{file}` should have been scaffolded"
);
}
}
#[test]
fn scaffold_project_at_injects_project_name_into_config() {
let dir = tempdir().unwrap();
let name = "my-cool-site";
scaffold_project_at(name, dir.path()).unwrap();
let config =
fs::read_to_string(dir.path().join(name).join("config.toml"))
.unwrap();
assert!(config.contains(&format!(r#"site_name = "{name}""#)));
assert!(config.contains(&format!(r#"site_title = "{name}""#)));
assert!(config.contains(r#"language = "en-GB""#));
}
#[test]
fn scaffold_project_at_injects_project_name_into_index_md() {
let dir = tempdir().unwrap();
let name = "hello";
scaffold_project_at(name, dir.path()).unwrap();
let index =
fs::read_to_string(dir.path().join(name).join("content/index.md"))
.unwrap();
assert!(index.contains(&format!("title: Welcome to {name}")));
assert!(index.contains("layout: index"));
}
#[test]
fn scaffold_project_at_injects_project_name_into_first_post() {
let dir = tempdir().unwrap();
let name = "projectx";
scaffold_project_at(name, dir.path()).unwrap();
let post = fs::read_to_string(
dir.path().join(name).join("content/blog/first-post.md"),
)
.unwrap();
assert!(post.contains(&format!("author: {name} Team")));
assert!(post.contains(&format!("Welcome to **{name}**")));
assert!(post.contains(&format!(r#"println!("Hello from {name}!");"#)));
}
#[test]
fn scaffold_project_at_static_assets_include_dark_mode_block() {
let dir = tempdir().unwrap();
scaffold_project_at("a", dir.path()).unwrap();
let css = fs::read_to_string(
dir.path().join("a").join("static/css/style.css"),
)
.unwrap();
assert!(css.contains("@media (prefers-color-scheme: dark)"));
assert!(css.contains(".sr-only"));
}
#[test]
fn scaffold_project_at_base_template_has_accessibility_landmarks() {
let dir = tempdir().unwrap();
scaffold_project_at("x", dir.path()).unwrap();
let base = fs::read_to_string(
dir.path().join("x").join("templates/tera/base.html"),
)
.unwrap();
assert!(base.contains(r#"role="banner""#));
assert!(base.contains(r#"role="main""#));
assert!(base.contains(r#"role="contentinfo""#));
assert!(base.contains(r#"aria-label="Main navigation""#));
assert!(base.contains(r#"class="sr-only""#));
}
#[test]
fn scaffold_project_at_nav_toml_has_three_default_links() {
let dir = tempdir().unwrap();
scaffold_project_at("y", dir.path()).unwrap();
let nav =
fs::read_to_string(dir.path().join("y").join("data/nav.toml"))
.unwrap();
assert_eq!(nav.matches("[[links]]").count(), 3);
assert!(nav.contains(r#"name = "Home""#));
assert!(nav.contains(r#"name = "About""#));
assert!(nav.contains(r#"name = "Blog""#));
}
#[test]
fn scaffold_project_at_refuses_to_overwrite_existing_directory() {
let dir = tempdir().unwrap();
let name = "existing";
fs::create_dir(dir.path().join(name)).unwrap();
let err = scaffold_project_at(name, dir.path()).unwrap_err();
let msg = format!("{err}");
assert!(
msg.contains("already exists"),
"error should mention `already exists`: {msg}"
);
}
#[test]
fn scaffold_project_at_refuses_to_overwrite_existing_file() {
let dir = tempdir().unwrap();
let name = "blocker";
fs::write(dir.path().join(name), "i exist").unwrap();
assert!(scaffold_project_at(name, dir.path()).is_err());
}
#[test]
fn scaffold_project_uses_current_working_directory() {
let dir = tempdir().unwrap();
let prev = std::env::current_dir().expect("read current dir");
std::env::set_current_dir(&dir).expect("pushd");
let result = scaffold_project("from-cwd");
std::env::set_current_dir(&prev).expect("popd");
result.expect("scaffold should succeed in a fresh cwd");
assert!(dir.path().join("from-cwd").join("config.toml").exists());
}
}