repoview 0.1.0 → 0.1.4

package/DEVELOPMENT.md

@@ -20,7 +20,7 @@ npm start -- --repo /path/to/repo --port 3000
 
 Useful flags:
 - `--watch` / `--no-watch` (watch is on by default)
-- `--host 0.0.0.0` to access from other devices on the network
+- `--host 127.0.0.1` to bind locally only
 
 ## Routes
 
@@ -67,3 +67,20 @@ Notes:
 npm run lint
 ```
 
+## Release checklist
+
+Before publishing to npm, run a quick smoke test from a clean install context (this catches issues where the server accidentally serves assets from the *repo* instead of the installed package):
+
+```bash
+npm run lint
+npm pack
+
+# install the tarball somewhere else
+tmp=$(mktemp -d)
+cd "$tmp"
+npm init -y
+npm install /path/to/repoview-*.tgz
+
+# serve any repo and verify vendor assets load (no ENOENT)
+node ./node_modules/.bin/repoview --repo /path/to/repo --port 3000
+```

package/README.md

@@ -25,12 +25,18 @@ Then open `http://localhost:3000`.
 
 ## Quick start (npx)
 
-After publishing to npm:
+From anywhere:
 
 ```bash
 npx repoview --repo /path/to/your/repo --port 3000
 ```
 
+By default, `repoview` binds to `0.0.0.0` (LAN-accessible). For localhost-only:
+
+```bash
+npx repoview --repo /path/to/your/repo --host 127.0.0.1 --port 3000
+```
+
 ## Why
 
 - Keep GitHub as a remote, not your developer portal.
@@ -40,7 +46,7 @@ npx repoview --repo /path/to/your/repo --port 3000
 ## Usage
 
 ```bash
-npm start -- --repo /path/to/repo [--host 127.0.0.1] [--port 3000] [--no-watch]
+npm start -- [--repo /path/to/repo] [--host 0.0.0.0] [--port 3000] [--no-watch]
 ```
 
 Common flags:
@@ -66,6 +72,10 @@ npm start -- --repo /path/to/repo --host 0.0.0.0 --port 8890
 - Implementation details: [`DEVELOPMENT.md`](DEVELOPMENT.md)
 - CLI usage: `npm start -- --help`
 
+## Troubleshooting
+
+- Seeing `ENOENT .../node_modules/...` in server logs: upgrade to `repoview@>=0.1.2` (older versions incorrectly looked for vendor assets inside the repo you’re serving).
+
 ## Contributing
 
 - Contributing guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "repoview",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "private": false,
   "type": "module",
   "description": "GitHub-like repo browsing for local Git repositories (Markdown, live reload, broken link scanner).",
+  "homepage": "https://github.com/h4x3rotab/repoview#readme",
+  "bugs": {
+    "url": "https://github.com/h4x3rotab/repoview/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/h4x3rotab/repoview.git"
+  },
   "license": "MIT",
   "author": "Hang Yin <hangyin@phala.com>",
   "bin": {

package/src/cli.js

@@ -6,17 +6,18 @@ import { startServer } from "./server.js";
 
 function printHelp() {
   // Keep this in sync with README.md
-  process.stdout.write(`repo-viewer
+  process.stdout.write(`repoview
 
 Serve a local Git repository as a GitHub-like website.
 
 Usage:
-  npm start -- --repo /path/to/repo [--host 127.0.0.1] [--port 3000] [--no-watch]
-  node src/cli.js --repo /path/to/repo [--host 127.0.0.1] [--port 3000] [--no-watch]
+  npx repoview [--repo /path/to/repo] [--host 0.0.0.0] [--port 3000] [--no-watch]
+  repoview [--repo /path/to/repo] [--host 0.0.0.0] [--port 3000] [--no-watch]
+  npm start -- [--repo /path/to/repo] [--host 0.0.0.0] [--port 3000] [--no-watch]
 
 Options:
-  --repo <path>     Repository root (default: REPO_ROOT or project dir)
-  --host <host>     Bind address (default: 127.0.0.1)
+  --repo <path>     Repository root (default: REPO_ROOT or current dir)
+  --host <host>     Bind address (default: 0.0.0.0)
   --port <port>     Bind port (default: 3000)
   --watch           Enable live reload (default)
   --no-watch        Disable live reload
@@ -62,11 +63,11 @@ if (port != null && !Number.isFinite(port)) {
 const repoRoot =
   repo ??
   process.env.REPO_ROOT ??
-  path.resolve(__dirname, "..");
+  process.cwd();
 
 await startServer({
   repoRoot,
   port: port || Number(process.env.PORT) || 3000,
-  host: host || process.env.HOST || "127.0.0.1",
+  host: host || process.env.HOST || "0.0.0.0",
   watch,
 });

package/src/markdown.js

@@ -288,7 +288,7 @@ export function createMarkdownRenderer() {
         "input",
       ],
       allowedAttributes: {
-        "*": ["class", "id", "aria-label", "aria-hidden", "role"],
+        "*": ["class", "id", "aria-label", "aria-hidden", "role", "align"],
         a: ["href", "name", "title", "target", "rel", "tabindex"],
         img: ["src", "alt", "title", "width", "height", "loading"],
         input: ["type", "checked", "disabled"],

package/src/server.js

@@ -1,7 +1,9 @@
 import fs from "node:fs/promises";
 import http from "node:http";
+import { createRequire } from "node:module";
 import path from "node:path";
 import { spawn } from "node:child_process";
+import { fileURLToPath } from "node:url";
 import express from "express";
 import chokidar from "chokidar";
 import mime from "mime-types";
@@ -141,6 +143,16 @@ function createReloadHub() {
 }
 
 export async function startServer({ repoRoot, host, port, watch }) {
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  const packageRoot = path.resolve(__dirname, "..");
+  const require = createRequire(import.meta.url);
+
+  const resolvePackageDir = (name) => {
+    const pkgJson = require.resolve(`${name}/package.json`);
+    return path.dirname(pkgJson);
+  };
+
   const repoRootReal = await fs.realpath(repoRoot);
   const repoName = path.basename(repoRootReal);
   const gitInfo = await getGitInfo(repoRootReal);
@@ -153,29 +165,29 @@ export async function startServer({ repoRoot, host, port, watch }) {
   const app = express();
   app.disable("x-powered-by");
 
-  const publicDir = path.join(process.cwd(), "public");
+  const publicDir = path.join(packageRoot, "public");
   app.use("/static", express.static(publicDir, { fallthrough: true }));
   app.use(
     "/static/vendor/github-markdown-css",
-    express.static(path.join(process.cwd(), "node_modules/github-markdown-css"), {
+    express.static(resolvePackageDir("github-markdown-css"), {
       fallthrough: false,
     }),
   );
   app.use(
     "/static/vendor/highlight.js",
-    express.static(path.join(process.cwd(), "node_modules/highlight.js"), {
+    express.static(resolvePackageDir("highlight.js"), {
       fallthrough: false,
     }),
   );
   app.use(
     "/static/vendor/katex",
-    express.static(path.join(process.cwd(), "node_modules/katex/dist"), {
+    express.static(path.join(resolvePackageDir("katex"), "dist"), {
       fallthrough: false,
     }),
   );
   app.use(
     "/static/vendor/mermaid",
-    express.static(path.join(process.cwd(), "node_modules/mermaid/dist"), {
+    express.static(path.join(resolvePackageDir("mermaid"), "dist"), {
       fallthrough: false,
     }),
   );
@@ -481,7 +493,7 @@ export async function startServer({ repoRoot, host, port, watch }) {
   }
 
   // eslint-disable-next-line no-console
-  console.log(`repo-viewer: ${repoRootReal}`);
+  console.log(`repoview: ${repoRootReal}`);
   // eslint-disable-next-line no-console
   console.log(`listening: http://${host}:${port}`);
 }