@aklinker1/aframe 0.4.3 → 0.4.5

package/README.md

@@ -83,16 +83,16 @@ bun add -D puppeteer vite
     "aframe": "bun node_modules/@aklinker1/aframe/bin/aframe.ts",
     "dev": "bun --silent aframe",
     "build": "bun --silent aframe build",
-    "preview": "bun --cwd .output --env-file ../.env server-entry.js"
+    "preview": "bun --cwd .output --env-file ../.env server-entry.js",
   },
   "dependencies": {
     "@aklinker1/aframe": "latest",
-    "elysia": "latest"
+    "elysia": "latest",
   },
   "devDependencies": {
     "vite": "latest",
     "puppeteer": "latest",
-  }
+  },
 }
 ```
 
@@ -122,9 +122,7 @@ import welcomeEmailTemplate from "./assets/email-templates/welcome.html" with {
 
 ## Detecting Prerender
 
-When prerendering, the page is loaded with the `?prerendering` query param.
-
-Aframe provides a helper for checking this, `isPrerendering`:
+Aframe provides a helper for checking if the app is being prerendered, `isPrerendering()`:
 
 ```vue
 <!-- ClientOnly.vue -->
@@ -139,3 +137,9 @@ const visible = !isPrerendering();
   <slot v-else name="fallback" />
 </template>
 ```
+
+## Publish Update to NPM
+
+```sh
+bun run release
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aklinker1/aframe",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "packageManager": "bun@1.2.5",
   "type": "module",
   "license": "MIT",
@@ -22,7 +22,8 @@
     "aframe": "bun --silent bin/aframe.ts",
     "dev": "bun aframe demo",
     "build": "bun aframe build demo",
-    "preview": "bun --cwd demo/.output --env-file ../.env server-entry.js"
+    "preview": "bun --cwd demo/.output --env-file ../.env server-entry.js",
+    "release": "bun run scripts/release.ts"
   },
   "dependencies": {},
   "devDependencies": {

package/src/config.ts

@@ -6,7 +6,7 @@ import type { LaunchOptions } from "puppeteer";
 export type UserConfig = {
   vite?: vite.UserConfigExport;
   prerenderedRoutes?: string[];
-  prerenderer?: PrerendererConfig;
+  prerenderer?: PrerendererConfig | false;
 };
 
 export type PrerendererConfig = {
@@ -40,7 +40,7 @@ export type ResolvedConfig = {
   serverPort: number;
   vite: vite.InlineConfig;
   prerenderedRoutes: string[];
-  prerenderer: PrerendererConfig;
+  prerenderer: PrerendererConfig | false;
 };
 
 export function defineConfig(config: UserConfig): UserConfig {

package/src/index.ts

@@ -1,12 +1,12 @@
 import type { BunPlugin } from "bun";
 import { lstatSync } from "node:fs";
-import { mkdir, rm, writeFile } from "node:fs/promises";
+import { mkdir, rm } from "node:fs/promises";
 import { join, relative } from "node:path/posix";
 import * as vite from "vite";
 import { BLUE, BOLD, CYAN, DIM, GREEN, MAGENTA, RESET } from "./color";
 import type { ResolvedConfig } from "./config";
 import { createTimer } from "./timer";
-import { prerenderPages } from "./prerenderer";
+import { prerenderPages, type PrerenderedRoute } from "./prerenderer";
 
 export * from "./config";
 export * from "./dev-server";
@@ -50,15 +50,20 @@ export async function build(config: ResolvedConfig) {
 
   console.log();
 
-  const prerenderTimer = createTimer();
-  console.log(
-    `${BOLD}${CYAN}ℹ${RESET} Prerendering...\n` +
-      config.prerenderedRoutes
-        .map((route) => `  ${DIM}-${RESET} ${CYAN}${route}${RESET}`)
-        .join("\n"),
-  );
-  const prerendered = await prerenderPages(config);
-  console.log(`${GREEN}✔${RESET} Prerendered in ${prerenderTimer()}`);
+  let prerendered: PrerenderedRoute[] = [];
+  if (config.prerenderer !== false) {
+    const prerenderTimer = createTimer();
+    console.log(
+      `${BOLD}${CYAN}ℹ${RESET} Prerendering...\n` +
+        config.prerenderedRoutes
+          .map((route) => `  ${DIM}-${RESET} ${CYAN}${route}${RESET}`)
+          .join("\n"),
+    );
+    prerendered = await prerenderPages(config);
+    console.log(`${GREEN}✔${RESET} Prerendered in ${prerenderTimer()}`);
+  } else {
+    console.log(`${DIM}${BOLD}→${RESET} Pre-rendering disabled`);
+  }
 
   console.log();
 

package/src/prerenderer.ts

@@ -2,7 +2,6 @@ import {} from "node:url";
 import { join } from "node:path";
 import { mkdir, writeFile } from "node:fs/promises";
 import type { Browser } from "puppeteer";
-import { createServer } from "./dev-server";
 import type { ResolvedConfig } from "./config";
 
 export type PrerenderedRoute = {
@@ -13,12 +12,20 @@ export type PrerenderedRoute = {
 export async function prerenderPages(
   config: ResolvedConfig,
 ): Promise<PrerenderedRoute[]> {
+  if (config.prerenderer === false) return [];
+
   const puppeteer = await import("puppeteer");
-  const timeout = config.prerenderer.timeout ?? 30e3;
+  const {
+    timeout = 30e3,
+    launch,
+    waitForSelector,
+    waitForSelectorVisible,
+    waitForTimeout,
+  } = config.prerenderer ?? {};
 
   const server = Bun.spawn({
-    cmd: ["bun", "--env-file", "../.env", "server-entry.js"],
-    cwd: config.serverOutDir,
+    cmd: ["bun", join(config.serverOutDir, "server-entry.js")],
+    cwd: config.rootDir,
     stdio: ["inherit", "inherit", "inherit"],
   });
 
@@ -26,7 +33,7 @@ export async function prerenderPages(
   let browser: Browser | undefined;
 
   try {
-    let args = config.prerenderer.launch?.args ?? [];
+    let args = launch?.args ?? [];
     // Workaround for Linux SUID Sandbox issues.
     if (process.platform === "linux" && !args.includes("--no-sandbox")) {
       args.push("--no-sandbox", "--disable-setuid-sandbox");
@@ -35,7 +42,7 @@ export async function prerenderPages(
     browser = await puppeteer.launch({
       headless: true,
       timeout,
-      ...config.prerenderer.launch,
+      ...launch,
       args,
     });
     for (const route of config.prerenderedRoutes) {
@@ -45,14 +52,12 @@ export async function prerenderPages(
       page.setDefaultTimeout(timeout);
       page.setDefaultNavigationTimeout(timeout);
       await page.goto(url.href);
-      if (config.prerenderer.waitForSelector) {
-        await page.waitForSelector(config.prerenderer.waitForSelector, {
-          visible: config.prerenderer.waitForSelectorVisible,
+      if (waitForSelector) {
+        await page.waitForSelector(waitForSelector, {
+          visible: waitForSelectorVisible,
         });
-      } else if (config.prerenderer.waitForTimeout != null) {
-        await new Promise((res) =>
-          setTimeout(res, config.prerenderer.waitForTimeout),
-        );
+      } else if (waitForTimeout != null) {
+        await new Promise((res) => setTimeout(res, waitForTimeout));
       }
 
       const html = await page.content();