@kaathewise/ssg 0.3.1 → 0.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@kaathewise/ssg",
 	"description": "Bun & JSX static site generator",
-	"version": "0.3.1",
+	"version": "0.4.0",
 	"license": "MPL-2.0",
 	"author": "Andrej Kolčin",
 	"type": "module",
@@ -9,6 +9,7 @@
 		"check": "biome check && tsc --noEmit"
 	},
 	"main": "src/index.ts",
+	"bin": "./src/run.ts",
 	"devDependencies": {
 		"@biomejs/biome": "^2.2.3",
 		"@types/bun": "^1.2.21",

package/src/build.ts

@@ -1,26 +1,24 @@
 import * as fs from "node:fs/promises"
 import * as path from "node:path"
 import { Glob, write } from "bun"
+import type { Config } from "./config"
 import { type Page, renderAll } from "./render"
 
 const glob = new Glob("**/*.{js,jsx,ts,tsx}")
 
-export async function build(pagesDir: string, outDir: string = "dist/") {
-	pagesDir = path.join(process.cwd(), pagesDir)
-	outDir = path.join(process.cwd(), outDir)
-
+export async function build(config: Config) {
 	const pages: Page[] = []
-	for await (const relPath of glob.scan(pagesDir)) {
-		const modulePath = path.join(pagesDir, relPath)
-		const p = await renderAll(modulePath, pagesDir)
+	for await (const relPath of glob.scan(config.pagesDir)) {
+		const modulePath = path.join(config.pagesDir, relPath)
+		const p = await renderAll(modulePath, config.pagesDir)
 		pages.push(...p)
 	}
 
-	await fs.rm(outDir, { recursive: true, force: true })
-	await fs.mkdir(outDir)
+	await fs.rm(config.outputDir, { recursive: true, force: true })
+	await fs.mkdir(config.outputDir)
 
 	for (const page of pages) {
-		const destPath = path.join(outDir, page.path)
+		const destPath = path.join(config.outputDir, page.path)
 		const dir = path.dirname(destPath)
 		if (!(await fs.exists(dir))) {
 			await fs.mkdir(path.dirname(destPath), {

package/src/config.ts

@@ -0,0 +1,33 @@
+import * as path from "node:path"
+
+const OUTPUT_DIR = "dist/"
+const DEFAULT_PORT = 3001
+
+export type Config = {
+	pagesDir: string
+	sourceDir: string
+	assetDir?: string
+	outputDir: string
+	port: number
+}
+
+export function defineConfig(options: {
+	pagesDir: string
+	sourceDir: string
+	assetDir?: string
+	outputDir?: string
+	port?: number
+}) {
+	const config = {
+		pagesDir: path.resolve(options.pagesDir),
+		sourceDir: path.resolve(options.sourceDir),
+		outputDir: path.resolve(options.outputDir ?? OUTPUT_DIR),
+		port: options.port ?? DEFAULT_PORT,
+	} as Config
+
+	if (options.assetDir) {
+		config.assetDir = path.resolve(options.assetDir)
+	}
+
+	return config
+}

package/src/index.ts

@@ -1,3 +1,4 @@
 export { build } from "./build"
+export { type Config, defineConfig } from "./config"
 export { postcssPlugin } from "./css"
-export { Server } from "./server"
+export { serve } from "./server"

package/src/run.ts

@@ -0,0 +1,45 @@
+#!/usr/bin/env bun
+
+import * as fs from "node:fs/promises"
+import * as path from "node:path"
+import { build, type Config, serve } from "./index"
+
+const CONFIG_PATH = "ssg.config.ts"
+const HELP = `Usage: ssg <command>
+
+Commands:
+    build:              build the website
+    dev:                start a hot-reloading development server
+`
+
+const args = process.argv.slice(2)
+
+const configPath = path.resolve(CONFIG_PATH)
+if (!(await fs.exists(configPath))) {
+	console.warn("Configuration file not found")
+	process.exit(10)
+}
+
+const configModule = await import(configPath)
+const config = configModule.default as Config
+
+switch (args[0]) {
+	case "build": {
+		await build(config)
+		break
+	}
+	case "dev": {
+		await serve(config)
+		break
+	}
+	case undefined: {
+		console.log(HELP)
+		break
+	}
+	default: {
+		console.log(
+			`The command must be either 'build' or 'dev', got ${args[0]}`,
+		)
+		process.exit(11)
+	}
+}

package/src/server.ts

@@ -1,82 +1,58 @@
+import * as fs from "node:fs/promises"
 import { watch } from "node:fs/promises"
 import * as path from "node:path"
 import type { ReadableStreamDefaultController } from "node:stream/web"
 import type { MatchedRoute } from "bun"
+import type { Config } from "./config"
 import { render } from "./render"
 
 const EVENT_PATH = "/__ssg_dev_sse"
 
-export class Server {
-	pagesDir: string
-	sourceDir: string
-	assetDir?: string
-	port?: number = 3001
-
-	router: Bun.FileSystemRouter
-
-	constructor(options: {
-		pagesDir: string
-		sourceDir: string
-		assetDir?: string
-		port?: number
-	}) {
-		this.pagesDir = path.join(process.cwd(), options.pagesDir)
-		this.sourceDir = path.join(process.cwd(), options.sourceDir)
-
-		this.router = new Bun.FileSystemRouter({
-			style: "nextjs",
-			dir: options.pagesDir,
-		})
+export async function serve(config: Config): Promise<void> {
+	const clients = new Set<ReadableStreamDefaultController>()
+	const router = new Bun.FileSystemRouter({
+		style: "nextjs",
+		dir: config.pagesDir,
+	})
 
-		this.assetDir ??= options.assetDir
+	Bun.serve({
+		port: config.port,
+		// for SSE
+		idleTimeout: 0,
 
-		this.port ??= options?.port
-	}
+		fetch: async request => {
+			const url = new URL(request.url)
+			if (url.pathname === EVENT_PATH) {
+				return createStream(request, clients)
+			}
 
-	async listen() {
-		const clients = new Set<ReadableStreamDefaultController>()
-
-		Bun.serve({
-			port: this.port,
-			// for SSE
-			idleTimeout: 0,
-
-			fetch: async request => {
-				const url = new URL(request.url)
-				if (url.pathname === EVENT_PATH) {
-					return createStream(request, clients)
-				}
-
-				const route = this.router.match(request.url)
-				if (route) {
-					return createHtml(this.pagesDir, route)
-				}
-
-				if (this.assetDir) {
-					// TODO: .. escapes
-					const assetPath = path.join(
-						this.assetDir,
-						url.pathname.slice(1),
-					)
-
-					return new Response(Bun.file(assetPath))
-				}
-
-				return new Response("Not found", {
-					headers: {
-						"Content-Type": "text/html",
-					},
-				})
-			},
-		})
+			const route = router.match(url.href)
+			if (route) {
+				return createHtml(config.pagesDir, route)
+			}
 
-		const watcher = watch(this.sourceDir, { recursive: true })
-		for await (const _ of watcher) {
-			this.router.reload()
-			clearCache(this.sourceDir)
-			for (const client of clients) {
-				client.enqueue("data: RELOAD\n\n")
+			const asset = await fetchStaticFile(
+				url,
+				config.assetDir,
+			)
+			if (asset) {
+				return asset
 			}
+
+			console.warn(`Path '${url.pathname}' not found`)
+			return new Response("Page or file not found", {
+				status: 404,
+			})
+		},
+	})
+	console.log(`Listening on :${config.port}`)
+
+	const watcher = watch(config.sourceDir, { recursive: true })
+	for await (const _ of watcher) {
+		router.reload()
+		clearCache(config.sourceDir)
+		for (const client of clients) {
+			client.enqueue("data: RELOAD\n\n")
 		}
 	}
 }
@@ -108,6 +84,31 @@ function createStream(
 	})
 }
 
+async function fetchStaticFile(
+	url: URL,
+	assetDir?: string,
+): Promise<Response | null> {
+	if (!assetDir) {
+		return null
+	}
+
+	let assetPath = path.join(assetDir, url.pathname.slice(1))
+	assetPath = path.resolve(assetPath)
+	if (!assetPath.startsWith(assetDir)) {
+		return new Response(
+			"Tried to get a file outside of the asset directory",
+			{ status: 403 },
+		)
+	}
+
+	const exists = await fs.exists(assetPath)
+	if (!exists) {
+		return null
+	}
+
+	return new Response(Bun.file(assetPath))
+}
+
 const RELOAD_SCRIPT = `
 <script type="module">
 	const sse = new EventSource("${EVENT_PATH}");
@@ -141,7 +142,7 @@ async function createHtml(
 		.transform(response)
 }
 
-export function clearCache(prefix: string) {
+function clearCache(prefix: string) {
 	for (const path in import.meta.require.cache) {
 		if (path.startsWith(prefix)) {
 			delete import.meta.require.cache[path]