@choonkeat/md-serve 0.1.0 → 0.2.1

package/README.md

@@ -33,16 +33,24 @@ md-serve -version
   [github-markdown-css](https://github.com/sindresorhus/github-markdown-css).
   Fenced code blocks are syntax-highlighted via
   [chroma](https://github.com/alecthomas/chroma) (200+ languages).
-- Directories show a generated listing with **Name / Size / Modified**
-  columns. If `index.md` / `README.md` / `readme.md` / `index.markdown`
-  is present, it's rendered below the listing GitHub-style. If only
-  `index.html` is present, it's served raw.
-- Source files (`.go`, `.py`, `.json`, `.yaml`, `.toml`, `Dockerfile`,
-  `Makefile`, ...) render as syntax-highlighted HTML with linkable line
-  numbers (`/main.go#L42`). Append `?raw=1` to any URL to bypass and
-  fetch the byte-for-byte original. Files larger than 1 MiB or that
-  look binary skip highlighting and stream raw.
-- Everything else is served byte-for-byte.
+- Directories: if `index.html` is present it's served raw (matches
+  nginx / Apache / Caddy / GitHub Pages, so md-serve can host real
+  static apps). Otherwise, if `index.md` / `README.md` / `readme.md` /
+  `index.markdown` is present, a combined page renders the directory
+  listing on top and the rendered README below GitHub-style. Otherwise
+  a plain generated listing with **Name / Size / Modified** columns.
+- Everything else is served byte-for-byte. That means `.js`, `.css`,
+  `.wasm`, `.json`, images, fonts, and the rest all reach the browser
+  with their normal MIME types — ES module scripts load, fetch() works,
+  the static-app use case Just Works.
+- Source files (`.go`, `.py`, `.yaml`, `.toml`, `Dockerfile`,
+  `Makefile`, ...) can be viewed as syntax-highlighted HTML with
+  linkable line numbers (`/main.go#L42`) by appending `?pretty=1` to
+  the URL. Directory listings already link source files this way, so
+  clicking from a listing lands on the highlighted view while direct
+  URLs / `curl` / `<script src>` get the raw bytes. Files larger than
+  1 MiB, files that look binary, or files chroma can't lex stay raw
+  even with `?pretty=1`.
 - Dotfiles are hidden from listings.
 - Path traversal is blocked: requests are rejected if they resolve
   outside the served root.

package/bin/md-serve.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
+// GENERATED by distribute-go-bin v0.1.0 — do not edit.
 
-import { spawnSync } from "child_process";
+import { spawn, execFileSync } from "child_process";
 import { createRequire } from "module";
 import { existsSync, chmodSync } from "fs";
 import { dirname, join } from "path";
@@ -38,14 +39,40 @@ const binName = process.platform === "win32" ? "md-serve.exe" : "md-serve";
 // npm-platforms/ is not published to npm, so this only takes effect during local dev.
 const localPath = join(__dirname, "..", "npm-platforms", `${platform}-${arch}`, "bin", binName);
 
+function resolveFromRegistry() {
+  try {
+    const pkgDir = dirname(require.resolve(`${pkgName}/package.json`));
+    return join(pkgDir, "bin", binName);
+  } catch {
+    return null;
+  }
+}
+
 let binPath;
 if (existsSync(localPath)) {
   binPath = localPath;
 } else {
-  try {
-    const pkgDir = dirname(require.resolve(`${pkgName}/package.json`));
-    binPath = join(pkgDir, "bin", binName);
-  } catch {
+  binPath = resolveFromRegistry();
+  // optionalDependencies may not be installed in some environments:
+  //   - stale npx cache predating the dep being added
+  //   - `npm install --omit=optional` or `npm ci --omit=optional`
+  //   - cross-platform install caches (e.g. image built on amd64, run on arm64)
+  //   - pnpm / yarn with different optional-dep semantics
+  //   - `npm link` dev workflows
+  // Attempt a one-shot install to recover before giving up.
+  if (!binPath) {
+    try {
+      console.error(`Installing ${pkgName}...`);
+      execFileSync("npm", ["install", "--no-save", pkgName], {
+        stdio: "inherit",
+        cwd: join(__dirname, ".."),
+      });
+      binPath = resolveFromRegistry();
+    } catch {
+      // fall through to the error exit below
+    }
+  }
+  if (!binPath) {
     console.error(
       `Could not find package ${pkgName}.\n` +
         `Make sure it is installed — this usually means your platform is supported\n` +
@@ -62,18 +89,53 @@ if (!existsSync(binPath)) {
   process.exit(1);
 }
 
+// Forward these signals from the dispatcher to the spawned Go binary so that
+// `kill <dispatcher-pid>` does not orphan the child. Node does not propagate
+// signals to children automatically; without these handlers, SIGTERM to this
+// script would terminate the dispatcher and leave the child process running.
+const FORWARDED_SIGNALS = ["SIGTERM", "SIGINT", "SIGHUP", "SIGQUIT"];
+
 function run() {
-  const result = spawnSync(binPath, process.argv.slice(2), {
-    stdio: "inherit",
-  });
+  return new Promise((resolve) => {
+    let child;
+    try {
+      child = spawn(binPath, process.argv.slice(2), { stdio: "inherit" });
+    } catch (error) {
+      resolve({ error });
+      return;
+    }
 
-  if (result.error) {
-    return result;
-  }
-  process.exit(result.status ?? 1);
+    const handlers = {};
+    for (const sig of FORWARDED_SIGNALS) {
+      handlers[sig] = () => {
+        try {
+          child.kill(sig);
+        } catch {
+          // child may have already exited; nothing to do.
+        }
+      };
+      process.on(sig, handlers[sig]);
+    }
+
+    const cleanup = () => {
+      for (const sig of FORWARDED_SIGNALS) {
+        process.off(sig, handlers[sig]);
+      }
+    };
+
+    child.on("error", (error) => {
+      cleanup();
+      resolve({ error });
+    });
+
+    child.on("exit", (code, signal) => {
+      cleanup();
+      resolve({ code, signal });
+    });
+  });
 }
 
-let result = run();
+let result = await run();
 
 // Handle EACCES by chmod +x and retrying
 if (result.error && result.error.code === "EACCES") {
@@ -83,10 +145,17 @@ if (result.error && result.error.code === "EACCES") {
     console.error(`Failed to chmod +x ${binPath}: ${e.message}`);
     process.exit(1);
   }
-  result = run();
+  result = await run();
 }
 
 if (result.error) {
   console.error(`Failed to start md-serve: ${result.error.message}`);
   process.exit(1);
 }
+
+if (result.signal) {
+  // Re-raise the signal the child died from so our own exit status reflects it.
+  process.kill(process.pid, result.signal);
+} else {
+  process.exit(result.code ?? 0);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choonkeat/md-serve",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Tiny static file server that renders Markdown as GitHub-styled HTML",
   "type": "module",
   "bin": {
@@ -19,11 +19,11 @@
   },
   "license": "MIT",
   "optionalDependencies": {
-    "@choonkeat/md-serve-darwin-arm64": "0.1.0",
-    "@choonkeat/md-serve-darwin-x64": "0.1.0",
-    "@choonkeat/md-serve-linux-arm64": "0.1.0",
-    "@choonkeat/md-serve-linux-x64": "0.1.0",
-    "@choonkeat/md-serve-win32-arm64": "0.1.0",
-    "@choonkeat/md-serve-win32-x64": "0.1.0"
+    "@choonkeat/md-serve-darwin-arm64": "0.2.1",
+    "@choonkeat/md-serve-darwin-x64": "0.2.1",
+    "@choonkeat/md-serve-linux-arm64": "0.2.1",
+    "@choonkeat/md-serve-linux-x64": "0.2.1",
+    "@choonkeat/md-serve-win32-arm64": "0.2.1",
+    "@choonkeat/md-serve-win32-x64": "0.2.1"
   }
 }