Scripts Reference

Introduction

ReeWeb's package.json defines a set of scripts for static site generation, development, and maintenance. This page lists every script with its exact command and purpose.

Development Scripts

How bun dev Works

bun dev uses conc (the concurrently package) to start three processes in parallel:

1. bun prepare:images - generates responsive image variants; runs non-blocking so the server starts instantly (near-instant on warm runs)
2. bun css:watch - the Tailwind CSS watcher, recompiling on every file change
3. bun development - the dev server (scripts/dev.ts), serving templates with live reload

All three run in the same terminal with colour-coded prefixes so their output is easy to distinguish. Open http://localhost:3000 once they are running.

The dev server is documented in detail on the Dev Server page.

SSG Scripts

Responsive Images (prepare:images)

scripts/prepare_images.ts turns full-size originals in assets/images/ into width-stepped WebP + JPEG variants in src/public/images/responsive/ (git-ignored), using Bun's native Bun.Image - no external dependency. It runs before bun ssg (blocking) and concurrently inside dev (non-blocking, so the server starts instantly), and is incremental (mtime-based): warm runs are near-instant, and editing one original rebuilds only that image. Widths and quality live in config/responsive_images.ts. See the Responsive Images recipe for detail.

SSG Options

All SSG scripts accept these options via command-line flags:

bun scripts/ssg.ts [options]

Pass --verbose directly for verbose output:

bun scripts/ssg.ts --public ./src/public --dist ./dist --verbose

The SSG pipeline is documented on the SSG Pipeline page.

CSS Scripts

Note: bun ssg includes the CSS build, image preparation, sitemap generation, and RSS generation for a complete production-ready generation pass.

The Tailwind setup is documented on the Tailwind CSS Setup page.

SEO Scripts

Both should be run after bun ssg - they read from the generated dist/ directory. Neither command hardcodes a site URL; they read the absolute origin from the SITE_URL environment variable (see Configuration), so set SITE_URL in .env or the SSG environment before running them.

Sitemap Options

bun scripts/generate_sitemap.ts [options]

See the Sitemap Generator page for per-page frontmatter options.

RSS Options

bun scripts/generate_rss.ts [options]

See the RSS Generator page for per-post frontmatter options.

Installation

The install task initialises Git, creates .env from .env.example when needed, runs bun install, installs the conc development runner, and fetches ReeWeb's formatter and vendor assets. bun dev and bun ssg prepare images and build CSS when they run.

Formatting

package.json Reference

The scripts above are defined in package.json under the "scripts" key. You can add your own scripts at any time - there's no ReeWeb-specific structure to follow:

{
    "scripts": {
        "dev": "conc -n img,tw,dev -c magenta,yellow,blue \"bun prepare:images\" \"bun css:watch\" \"bun development\"",
        "development": "bun --hot --no-clear-screen scripts/dev.ts",
        "prepare:images": "bun scripts/prepare_images.ts",
        "css:build": "tailwindcss -i ./src/css/style.css -o ./src/public/css/style.css --minify",
        "css:watch": "tailwindcss -i ./src/css/style.css -o ./src/public/css/style.css --watch --verbose",
        "ssg": "bun prepare:images && bun css:build && bun scripts/ssg.ts --public ./src/public --dist ./dist && bun sitemap && bun rss",
        "rss": "bun scripts/generate_rss.ts --public ./src/public --dist ./dist",
        "sitemap": "bun scripts/generate_sitemap.ts --public ./src/public --dist ./dist",
        "format": "reettier",
        "preview": "bun scripts/preview.ts",
        "get:conc": "bun add -g concurrently@10.0.3",
        "get:pre": "bun get:zod && bun get:hljs && bun get:conc && bun get:reettier && bun get:reesql",
        "reeweb:install": "bun scripts/install.ts && bun get:pre"
    }
}