@youtyan/code-viewer 0.1.7 → 0.1.9

package/README.md

@@ -1,9 +1,19 @@
 # code-viewer
 
-Local browser-based git diff viewer.
+Local browser-based code and git diff viewer.
 
 Requires [Bun](https://bun.sh/) on your `PATH`.
 
+## Features
+
+- Browse repository files and folders in a persistent sidebar.
+- View git diffs with unified or split layout, lazy loading, and viewed-file state.
+- Open files directly from the repository or diff view, including large generated files.
+- Preview Markdown with a table of contents, task lists, Mermaid diagrams, and Shiki code highlighting.
+- Preview browser-safe media and show metadata for binary files that cannot be rendered.
+- Open repository folders in the OS file manager from localhost-only actions.
+- Upload files into worktree folders when upload is explicitly enabled.
+
 ## Usage
 
 ```sh
@@ -27,6 +37,43 @@ code-viewer --cwd /path/to/repo --staged
 
 Pass `--open` only when you want the browser opened automatically.
 
+## Repository View
+
+Open the root URL to browse the repository tree. Folder pages keep the sidebar
+visible, and file pages show a preview when the browser can safely render the
+file. Unsupported binary files show a clear unavailable state with file
+metadata instead of dumping bytes as text.
+
+Markdown files use a dedicated preview tab. Relative links and images are
+resolved inside the repository, code blocks are highlighted with Shiki, and
+Mermaid diagrams are rendered lazily in the browser.
+
+Very large text files use a virtualized source viewer. Only visible rows are
+rendered, and the page includes controls to copy the full file or reopen it in
+the full non-virtual view.
+
+## Uploads
+
+File uploads are disabled by default. Enable them only for trusted local
+worktrees:
+
+```sh
+code-viewer --cwd /path/to/repo --allow-upload
+```
+
+Or place `.code-viewer.json` at the repository root:
+
+```json
+{
+  "upload": {
+    "enabled": true
+  }
+}
+```
+
+Uploads are accepted only for the worktree target. Git tree views remain
+read-only.
+
 ## Development
 
 ```sh
@@ -36,10 +83,17 @@ bun run preview --cwd /path/to/repo
 ```
 
 `bun run preview` is the development runner. It rebuilds the browser bundle
-when `web-src/app.ts` changes, restarts the preview server when
+when browser source files change, restarts the preview server when
 `web-src/server/*.ts` changes, and keeps the URL stable on
 `http://127.0.0.1:64160/` unless you pass `--port <port>`.
 
+Before releasing:
+
+```sh
+bun run verify
+npm pack --dry-run
+```
+
 ## License
 
 MIT. Third-party licenses for bundled browser assets are included under

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@youtyan/code-viewer",
-  "version": "0.1.7",
-  "description": "Local browser-based git diff viewer",
+  "version": "0.1.9",
+  "description": "Local browser-based code and git diff viewer",
   "type": "module",
   "bin": {
     "code-viewer": "web-src/server/preview.ts",
@@ -28,14 +28,14 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "bun build --target=browser --format=iife --outfile=web/app.js web-src/app.ts",
+    "build": "bun build --target=browser --format=iife --outfile=web/app.js web-src/app.ts && bun build --target=browser --format=esm --outfile=web/mermaid.js web-src/mermaid-entry.ts && bun build --target=browser --format=esm --outfile=web/shiki.js web-src/shiki-entry.ts",
     "check": "tsc --noEmit",
-    "check:bundle": "bun build --target=browser --format=iife --outfile=/tmp/code-viewer-app.js web-src/app.ts && cmp /tmp/code-viewer-app.js web/app.js",
+    "check:bundle": "bun build --target=browser --format=iife --outfile=/tmp/code-viewer-app.js web-src/app.ts && cmp /tmp/code-viewer-app.js web/app.js && bun build --target=browser --format=esm --outfile=/tmp/code-viewer-mermaid.js web-src/mermaid-entry.ts && cmp /tmp/code-viewer-mermaid.js web/mermaid.js && bun build --target=browser --format=esm --outfile=/tmp/code-viewer-shiki.js web-src/shiki-entry.ts && cmp /tmp/code-viewer-shiki.js web/shiki.js",
     "dev": "bun run web-src/server/dev.ts",
     "preview": "bun run web-src/server/dev.ts",
     "preview:raw": "bun run web-src/server/preview.ts",
     "test": "bun test",
-    "verify": "bun run check && bun run build && bun run check:bundle && bun run test && node --check web/app.js",
+    "verify": "bun run check && bun run build && bun run check:bundle && bun run test && node --check web/app.js && node --check web/mermaid.js && node --check web/shiki.js",
     "pack:dry": "npm pack --dry-run",
     "prepublishOnly": "bun run verify"
   },
@@ -52,5 +52,13 @@
   },
   "engines": {
     "bun": ">=1.0.0"
+  },
+  "dependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.1",
+    "markdown-it-anchor": "^9.2.0",
+    "markdown-it-footnote": "^4.0.0",
+    "mermaid": "^11.14.0",
+    "shiki": "^4.0.2"
   }
 }