(feature): disable autoreload

.envrc

@@ -1 +1,5 @@
+# https://github.com/nix-community/nix-direnv
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
+fi
 use flake

.github/workflows/deploy.yml

@@ -12,6 +12,8 @@ jobs:
 
       - uses: HatsuneMiku3939/direnv-action@v1
 
+      - run: nix flake check
+
       - run: bun install
 
       - run: tsc

.github/workflows/test.yml

@@ -14,6 +14,8 @@ jobs:
 
       - uses: HatsuneMiku3939/direnv-action@v1
 
+      - run: nix flake check
+
       - run: bun install
 
       - run: tsc

README.md

@@ -28,8 +28,6 @@ Bun.serve({
 
 ## Options
 
-### `eventPath` and `scriptPath`
-
 You can specify URL paths used for server-sent events and live reloader script.
 
 ```ts
@@ -46,14 +44,20 @@ Bun.serve({
       // Live reload script path
       // default: "/__dev__/reload.js"
       scriptPath: "/__reload.js",
+
+      // Wether to enable auto reload.
+      // If false, you need to manually call `reloadClients` function to reload clients.
+      // default: true
+      autoReload: false
     },
   ),
 });
 ```
 
 ## Manually reload clients
 
-You can manually reload clients (refresh tabs) by calling `reloadClients` function.
+You can manually reload clients (refresh tabs) by calling `reloadClients` function,
+in addition to auto reload feature.
 
 ```ts
 import { withHtmlLiveReload, reloadClients } from "bun-html-live-reload";

index.ts

@@ -1,8 +1,10 @@
 declare global {
   var clients: Set<ReadableStreamDefaultController> | undefined;
+  var autoReload: boolean | undefined;
 }
 
 globalThis.clients ??= new Set<ReadableStreamDefaultController>();
+globalThis.autoReload = globalThis.autoReload ?? true;
 
 export function reloadClients(): void {
   if (globalThis.clients !== undefined) {
@@ -12,7 +14,9 @@ export function reloadClients(): void {
   }
 }
 
-reloadClients();
+if (globalThis.autoReload) {
+  reloadClients();
+}
 
 export type LiveReloadOptions = {
   /**
@@ -43,8 +47,12 @@ export function withHtmlLiveReload(
   options?: {
     eventPath?: string;
     scriptPath?: string;
+    autoReload?: false;
   },
 ): Fetch {
+  if (options?.autoReload === false) {
+    globalThis.autoReload = false;
+  }
   return async (req): Promise<Response> => {
     if (req.method !== "GET") {
       return handler(req);

no-autoreload.test.ts

@@ -0,0 +1,52 @@
+import { afterEach, expect, test } from "bun:test";
+import { copyFileSync, mkdtempSync } from "node:fs";
+import { chromium } from "playwright";
+
+const serverCodeInit = `
+import { withHtmlLiveReload } from "./bun-html-live-reload.ts";
+
+Bun.serve({
+  fetch: withHtmlLiveReload(async () => {
+    return new Response("<div>Init</div>", {
+      headers: { "Content-Type": "text/html" },
+    }, { autoReload: false });
+  }),
+});
+`;
+
+let close: () => Promise<void> | undefined;
+
+afterEach(async () => {
+  await close?.();
+});
+
+test("can disable auto reload", async () => {
+  const systemTmp = process.env["TMPDIR"] ?? "/tmp";
+  const tmpdir = mkdtempSync(`${systemTmp}/bun-`);
+  const serverPath = `${tmpdir}/server.ts`;
+  const libPath = `${tmpdir}/bun-html-live-reload.ts`;
+
+  await Bun.write(serverPath, serverCodeInit);
+
+  copyFileSync(`${import.meta.dir}/index.ts`, libPath);
+
+  const child = Bun.spawn(["bun", "--hot", serverPath], { stderr: "ignore" });
+
+  const browser = await chromium.launch();
+
+  close = async (): Promise<void> => {
+    child?.kill();
+    await browser.close();
+  };
+
+  const context = await browser.newContext();
+  const page = await context.newPage();
+  await page.goto("http://localhost:3000");
+
+  expect(await page.innerText("div")).toBe("Init");
+
+  await Bun.write(serverPath, serverCodeInit);
+  await page.waitForEvent("framenavigated");
+
+  expect(await page.innerText("div")).toBe("Init");
+});

package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-html-live-reload",
   "description": "HTML live reload for Bun",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "module": "index.ts",
   "type": "module",
   "author": "aabccd021",