feat(annotate): support HTML files and URL annotation (#545)

* fix(annotate): sanitize dangerous link protocols in markdown renderer

Block javascript:, data:, and vbscript: URLs in InlineMarkdown link
rendering. Links with dangerous protocols render as plain text instead
of clickable anchors. Uses a blocklist approach so existing links with
custom protocols (obsidian://, vscode://, Windows C:\ paths) continue
to work.

For provenance purposes, this commit was AI assisted.

* feat(annotate): add HTML-to-markdown and URL-to-markdown utilities

- html-to-markdown.ts: Turndown wrapper with GFM table rule, strips
  script/style/noscript tags
- url-to-markdown.ts: Jina Reader (free, returns markdown) with
  fetch+Turndown fallback. Warns on Jina failure, auto-skips Jina for
  local/private URLs (localhost, 192.168.*, 10.*, etc.)
- config.ts: add jina setting and resolveUseJina() with priority chain
  --no-jina flag > PLANNOTATOR_JINA env > config.json > default true

For provenance purposes, this commit was AI assisted.

* feat(annotate): support HTML files and URLs in annotate command

Extend the annotate subcommand to accept .html/.htm local files
(converted via Turndown) and https:// URLs (fetched via Jina Reader
with fetch+Turndown fallback). URL content is fetched terminal-side
before opening the browser.

Add --no-jina global flag to disable Jina Reader per-invocation.
Add 10MB file size guard for local HTML files.

For provenance purposes, this commit was AI assisted.

* feat(annotate): HTML files in folder browser and on-demand conversion

- Widen file browser glob to include .html/.htm alongside markdown
- handleDoc converts HTML files via Turndown on demand when selected
- hasMarkdownFiles accepts optional extensions param for folder validation
- Add sourceInfo field to annotate server API response
- Add _site/, public/, out/, .docusaurus/, .jekyll-cache/,
  storybook-static/ to FILE_BROWSER_EXCLUDED

For provenance purposes, this commit was AI assisted.

* feat(annotate): source attribution badge for HTML/URL annotations

Show a subtle badge in DocBadges displaying the URL hostname or HTML
filename for converted content. Thread sourceInfo from API response
through App → Viewer → DocBadges.

Also update Pi extension to accept HTML-only folders in annotate mode.

For provenance purposes, this commit was AI assisted.

* test: update CLI help text assertion for HTML/URL annotate support

For provenance purposes, this commit was AI assisted.

* fix(annotate): address PR review findings

Security:
- Add project-root containment check for HTML files in /api/doc handler
  using exported isWithinProjectRoot() from resolve-file.ts
- Blocks path traversal via absolute paths or ../ escapes

isLocalUrl fixes:
- Add bracketed IPv6 loopback [::1] detection
- Replace hostname.startsWith('10.') with proper IPv4 regex to avoid
  matching public hostnames like 10.example.com

Revert Pi extension change:
- Pi server doesn't implement HTML file browsing or conversion yet
- Keep Pi folder validation markdown-only until both implementations
  are updated per CLAUDE.md guidelines

Cleanup:
- Remove dead el.children || el.childNodes fallback in table rule
- Extract hostnameOrFallback() helper to @plannotator/shared/project
  replacing duplicated try/catch IIFEs in DocBadges and index.ts

For provenance purposes, this commit was AI assisted.

* feat(annotate): Pi extension HTML annotation parity

Bring the Pi extension to full parity with the Bun server for HTML
annotation support:

- Vendor html-to-markdown and url-to-markdown via vendor.sh
- walkMarkdownFiles now scans .html/.htm alongside markdown
- handleDocRequest converts HTML files on-demand via Turndown with
  isWithinProjectRoot containment check
- serverAnnotate includes sourceInfo in /api/plan response
- index.ts supports URL detection (Jina Reader + fallback), HTML file
  detection with Turndown conversion, folder HTML validation, and 10MB
  file size guard
- openMarkdownAnnotation accepts and threads sourceInfo
- Add turndown as a Pi extension dependency

For provenance purposes, this commit was AI assisted.

* fix(pi): Obsidian vault walks stay markdown-only, add try/catch for HTML

- Add extensions param to walkMarkdownFiles (default: HTML-inclusive)
- Obsidian callers pass /\.mdx?$/i to match Bun server behavior
- Add try/catch around HTML file reads in handleDocRequest

For provenance purposes, this commit was AI assisted.

* fix(annotate): address second review — base-block traversal, metadata IP, dead code

Security:
- Add isWithinProjectRoot check to the base-relative block for HTML
  files in both Bun and Pi /api/doc handlers. Previously HTML files
  served via the base query param bypassed the containment guard.
- Add 169.254.0.0/16 (link-local / cloud metadata) to isLocalUrl
  private IP ranges

Cleanup:
- Remove dead hostname === "[::1]" check (WHATWG URL parser strips
  brackets; hostname === "::1" already handles it)
- Remove dead parent?.childNodes fallback in table cell() function

For provenance purposes, this commit was AI assisted.

* refactor(annotate): replace custom table rules with turndown-plugin-gfm

Drop ~60 lines of hand-rolled GFM table conversion that had a bug
(tables without explicit <thead> produced invalid GFM). Use the
official turndown-plugin-gfm plugin (24KB) which correctly handles
all table patterns plus adds strikethrough and task list support.

For provenance purposes, this commit was AI assisted.

* fix(annotate): handle all CommonMark backslash escapes in InlineMarkdown

Expand the backslash escape regex to cover all CommonMark-defined
escapable characters (. ) - # > + | { } &), not just the subset
the parser uses for formatting. Fixes literal backslashes appearing
in rendered output for Turndown-escaped content like "1\." → "1.".

For provenance purposes, this commit was AI assisted.

* fix(annotate): prevent SSRF via redirect to private/local URLs

Replace redirect: "follow" with redirect: "manual" in fetchViaTurndown
and validate each redirect hop against isLocalUrl. Blocks attacks where
an external URL redirects to cloud metadata endpoints (169.254.169.254)
or other private IPs. Limits redirect chain to 10 hops.

For provenance purposes, this commit was AI assisted.

* chore: update lockfile for turndown-plugin-gfm in Pi extension

bun install needed to resolve turndown-plugin-gfm in the Pi extension
workspace after adding it to apps/pi-extension/package.json.

For provenance purposes, this commit was AI assisted.

* fix(annotate): switch to @joplin/turndown-plugin-gfm, fix TS errors

Replace unmaintained turndown-plugin-gfm (2017, v1.0.2) with the
actively maintained Joplin fork (2025, v1.0.64, 16KB).

Fix TypeScript errors that broke CI:
- Add @ts-expect-error for untyped @joplin/turndown-plugin-gfm import
- Restructure fetchViaTurndown redirect loop to avoid uninitialized
  variable — first fetch before loop, loop only for redirects

For provenance purposes, this commit was AI assisted.

* fix(annotate): use proper declarations.d.ts instead of ts-expect-error

Add declarations.d.ts for @joplin/turndown-plugin-gfm with typed
function signatures, remove the ts-expect-error suppression.

For provenance purposes, this commit was AI assisted.

* fix: explicitly include declarations.d.ts in shared tsconfig

CI's tsc wasn't finding the ambient module declaration with implicit
include. Add explicit include to ensure declarations.d.ts is always
picked up regardless of environment.

For provenance purposes, this commit was AI assisted.

* fix: use ts-expect-error for @joplin/turndown-plugin-gfm types

CI's tsc does not pick up ambient declarations.d.ts files despite
local tsc finding them — likely a module resolution discrepancy
between environments. Revert to @ts-expect-error which passes in
both CI and local typecheck.

For provenance purposes, this commit was AI assisted.

* fix(annotate): body size limit for URL fetches, redirect error, file: protocol

- Add 10MB body size limit to both Jina and fetch+Turndown URL paths,
  matching the local HTML file guard. Streams response body and aborts
  if limit exceeded.
- Distinguish "Too many redirects" from a genuine 3xx response after
  redirect loop exhaustion.
- Add file: to the dangerous protocol blocklist in sanitizeLinkUrl.

For provenance purposes, this commit was AI assisted.

* fix(annotate): HTML folder outside cwd, HTML linked doc navigation

- Remove containment check from base-relative block for HTML files in
  both Bun and Pi /api/doc handlers. Matches markdown behavior so HTML
  files in annotated folders outside cwd are served correctly.
  Standalone block (no base) retains its cwd check as fallback.
- Widen isLocalMd → isLocalDoc to treat .html/.htm links as linked
  documents. Clicking [Next](next.html) in a converted page now opens
  it via /api/doc with Turndown conversion instead of a new browser tab.

For provenance purposes, this commit was AI assisted.

* fix(annotate): full loopback range, drain redirect bodies, document env vars

- Expand loopback check from just 127.0.0.1 to the full 127.0.0.0/8
  range so all loopback addresses skip Jina Reader
- Cancel redirect response body before re-fetching to avoid leaking
  TCP connections back to the pool
- Document PLANNOTATOR_JINA and JINA_API_KEY in CLAUDE.md env var table

For provenance purposes, this commit was AI assisted.

* fix(annotate): IPv6 loopback, readBodyWithLimit fallback, env var docs, comments

- Add [::1] back to isLocalUrl — WHATWG URL hostname getter preserves
  brackets for IPv6 (verified: Bun and Node both return "[::1]").
  Add comment explaining the empirical verification so future reviewers
  don't re-flag.
- Fix readBodyWithLimit null-body fallback to still enforce the 10MB
  limit via text length check instead of silently falling through.
- Document PLANNOTATOR_JINA and JINA_API_KEY in AGENTS.md env var table
  (CLAUDE.md is a symlink to AGENTS.md).
- Add comments to base-relative blocks in both Bun and Pi handleDoc
  explaining the intentional lack of containment check (matches
  pre-existing markdown behavior, base is set server-side).

For provenance purposes, this commit was AI assisted.

* fix(annotate): block IPv4-mapped IPv6 and private IPv6 ranges in isLocalUrl

Add PRIVATE_IPV6 regex matching bracketed IPv6 private/reserved ranges:
- ::ffff: (IPv4-mapped — embeds private IPv4 as hex, e.g. [::ffff:c0a8:1])
- fe80: (link-local)
- fc00::/7 (unique-local, covers fc00:: through fdff::)

Closes the redirect-SSRF bypass where a public URL redirects to a
private address expressed as IPv4-mapped IPv6, e.g.
http://[::ffff:169.254.169.254]/latest/meta-data/

For provenance purposes, this commit was AI assisted.

* fix(annotate): document IPv6 hostname verification, sourceInfo type, annotate flow

- Expand isLocalUrl comment with full empirical verification table
  showing actual hostname getter output for every IPv6 format in both
  Bun and Node — prevents false-positive review findings about brackets
- Add sourceInfo to /api/plan response type in App.tsx for type safety
- Update CLAUDE.md annotate flow diagram to reflect HTML/URL/folder
  input types

For provenance purposes, this commit was AI assisted.

* fix(annotate): escape \(, cancel response bodies on error, doc sourceInfo

- Add ( to backslash escape regex alongside existing ) — Turndown
  emits \( in link-adjacent contexts
- Cancel response body before throwing on !res.ok in both fetchViaJina
  and fetchViaTurndown error paths (redirect loop already did this)
- Document sourceInfo field in AGENTS.md annotate server API table

For provenance purposes, this commit was AI assisted.

* fix(annotate): skip base injection for URL annotations, body cleanup

- Skip dirname(filePath) base injection when filePath is a URL in both
  Bun and Pi annotate servers. dirname on a URL string produces a
  nonsensical filesystem path, causing linked doc clicks to 404.
  URL annotations now let links open normally instead.
- Cancel response body before throwing on content-type mismatch and
  content-length overflow in fetchViaTurndown/readBodyWithLimit.
- Fix double parseInt in readBodyWithLimit content-length check.
- Correct AGENTS.md flow diagram: OpenCode not yet implemented for
  HTML/URL annotation.

For provenance purposes, this commit was AI assisted.

* feat(annotate): OpenCode HTML file and URL annotation support

Add URL detection (Jina Reader + fallback), HTML file detection with
Turndown conversion, 10MB file size guard, and sourceInfo threading
to OpenCode's handleAnnotateCommand. Uses the same shared utilities
as the Bun CLI and Pi extension.

OpenCode uses the Bun server directly (startAnnotateServer from
@plannotator/server/annotate), so no server-side changes needed —
only the command handler routing was missing.

Note: folder annotation mode is not added (OpenCode didn't have it
before this PR for markdown either — separate scope).

For provenance purposes, this commit was AI assisted.

* chore(annotate): update slash command description, align fetch log messages

- OpenCode plannotator-annotate.md description now mentions HTML/URL
- Align fetch progress messages across all three clients: all now show
  "(via Jina Reader)" or "(via fetch+Turndown)" consistently

For provenance purposes, this commit was AI assisted.

* fix(annotate): skip conversion for .md URLs, wikilink HTML targets, cleanup

- URLs ending in .md/.mdx are fetched raw — no Jina, no Turndown.
  Content is already markdown. Removes text/plain from fetchViaTurndown
  content-type whitelist since .md URLs are now short-circuited.
- Wikilink regex widened to preserve .html/.htm targets instead of
  appending .md (e.g. [[page.html]] no longer becomes page.html.md)
- Remove redundant existsSync before statSync in OpenCode handler

For provenance purposes, this commit was AI assisted.

* test(annotate): add htmlToMarkdown conversion tests

Tests cover the core conversion utility that all three clients depend on:
- Basic HTML → markdown (headings, paragraphs, links, code blocks)
- Tables with and without <thead> (the GFM plugin bug that was caught)
- Script/style/noscript stripping
- Strikethrough (GFM)
- Empty HTML handling
- Dangerous links preserved (sanitization is in the renderer, not here)

For provenance purposes, this commit was AI assisted.

* fix(annotate): check content-type before treating .md URLs as raw markdown

URLs ending in .md/.mdx (e.g. GitHub's viewer page for README.md)
may return HTML instead of raw markdown. fetchRawText now checks the
response content-type — if the server returns HTML, returns null so
the caller falls through to Jina/Turndown for proper conversion.

For provenance purposes, this commit was AI assisted.

* fix(annotate): add SSRF redirect protection to fetchRawText

fetchRawText (for .md/.mdx URLs) was using default redirect: "follow"
with no isLocalUrl validation on redirect hops — a .md URL redirecting
to 169.254.169.254 would be followed and credentials returned as
"markdown". Now uses redirect: "manual" with per-hop isLocalUrl checks,
matching fetchViaTurndown's SSRF protection.

For provenance purposes, this commit was AI assisted.
This commit is contained in:
Michael Ramos
2026-04-12 18:56:28 -07:00
committed by GitHub
parent aa73295b8d
commit b780739291
27 changed files with 821 additions and 132 deletions
+11 -5
View File
@@ -104,6 +104,8 @@ claude --plugin-dir ./apps/hook
| `PLANNOTATOR_SHARE` | Set to `disabled` to turn off URL sharing entirely. Default: enabled. |
| `PLANNOTATOR_SHARE_URL` | Custom base URL for share links (self-hosted portal). Default: `https://share.plannotator.ai`. |
| `PLANNOTATOR_PASTE_URL` | Base URL of the paste service API for short URL sharing. Default: `https://plannotator-paste.plannotator.workers.dev`. |
| `PLANNOTATOR_JINA` | Set to `0` / `false` to disable Jina Reader for URL annotation, or `1` / `true` to enable. Default: enabled. Can also be set via `~/.plannotator/config.json` (`{ "jina": false }`) or per-invocation via `--no-jina`. |
| `JINA_API_KEY` | Optional Jina Reader API key for higher rate limits (500 RPM vs 20 RPM unauthenticated). Free keys include 10M tokens. |
| `PLANNOTATOR_VERIFY_ATTESTATION` | **Read by the install scripts only**, not by the runtime binary. Set to `1` / `true` to have `scripts/install.sh` / `install.ps1` / `install.cmd` run `gh attestation verify` on every install. Off by default. Can also be set persistently via `~/.plannotator/config.json` (`{ "verifyAttestation": true }`) or per-invocation via `--verify-attestation`. Requires `gh` installed and authenticated. |
**Legacy:** `SSH_TTY` and `SSH_CONNECTION` are still detected when `PLANNOTATOR_REMOTE` is unset. Set `PLANNOTATOR_REMOTE=1` / `true` to force remote mode or `0` / `false` to force local mode.
@@ -152,16 +154,20 @@ Approve → "LGTM" sent to agent session
## Annotate Flow
```
User runs /plannotator-annotate <file.md> command
User runs /plannotator-annotate <file.md | file.html | https://... | folder/>
↓
Claude Code: plannotator annotate subcommand runs
OpenCode: event handler intercepts command
OpenCode/Pi: event handler intercepts command
↓
Markdown file read from disk
Input type detected:
.md/.mdx → file read from disk
.html/.htm → file read, converted to markdown via Turndown
https:// → fetched via Jina Reader (default) or fetch+Turndown (--no-jina)
folder/ → file browser opened, files converted on demand
↓
Annotate server starts (reuses plan editor HTML with mode:"annotate")
↓
User annotates markdown, provides feedback
User annotates content, provides feedback
↓
Send Annotations → feedback sent to agent session
```
@@ -247,7 +253,7 @@ During normal plan review, an Archive sidebar tab provides the same browsing via
| Endpoint | Method | Purpose |
| --------------------- | ------ | ------------------------------------------ |
| `/api/plan` | GET | Returns `{ plan, origin, mode: "annotate", filePath }` |
| `/api/plan` | GET | Returns `{ plan, origin, mode: "annotate", filePath, sourceInfo? }` |
| `/api/feedback` | POST | Submit annotations (body: feedback, annotations) |
| `/api/image` | GET | Serve image by path query param |
| `/api/upload` | POST | Upload image, returns `{ path, originalName }` |
+1 -1
View File
@@ -19,7 +19,7 @@ describe("CLI top-level help", () => {
expect(output).toContain("plannotator --help");
expect(output).toContain("plannotator [--browser <name>]");
expect(output).toContain("plannotator review [PR_URL]");
expect(output).toContain("plannotator annotate <file.md | folder/>");
expect(output).toContain("plannotator annotate <file.md | file.html | https://... | folder/>");
expect(output).toContain("running 'plannotator' without arguments is for hook integration");
});
});
+2 -2
View File
@@ -15,7 +15,7 @@ export function formatTopLevelHelp(): string {
" plannotator --help",
" plannotator [--browser <name>]",
" plannotator review [PR_URL]",
" plannotator annotate <file.md | folder/>",
" plannotator annotate <file.md | file.html | https://... | folder/> [--no-jina]",
" plannotator last",
" plannotator archive",
" plannotator sessions",
@@ -33,7 +33,7 @@ export function formatInteractiveNoArgClarification(): string {
"",
"For interactive use, try:",
" plannotator review",
" plannotator annotate <file.md>",
" plannotator annotate <file.md | file.html | https://...>",
" plannotator last",
" plannotator archive",
" plannotator sessions",
+61 -13
View File
@@ -64,17 +64,20 @@ import {
handleAnnotateServerReady,
} from "@plannotator/server/annotate";
import { type DiffType, getVcsContext, runVcsDiff, gitRuntime } from "@plannotator/server/vcs";
import { loadConfig, resolveDefaultDiffType } from "@plannotator/shared/config";
import { loadConfig, resolveDefaultDiffType, resolveUseJina } from "@plannotator/shared/config";
import { htmlToMarkdown } from "@plannotator/shared/html-to-markdown";
import { urlToMarkdown } from "@plannotator/shared/url-to-markdown";
import { fetchRef, createWorktree, removeWorktree, ensureObjectAvailable } from "@plannotator/shared/worktree";
import { parsePRUrl, checkPRAuth, fetchPR, getCliName, getCliInstallUrl, getMRLabel, getMRNumberLabel, getDisplayRepo } from "@plannotator/server/pr";
import { writeRemoteShareLink } from "@plannotator/server/share-url";
import { resolveMarkdownFile, hasMarkdownFiles } from "@plannotator/shared/resolve-file";
import { FILE_BROWSER_EXCLUDED } from "@plannotator/shared/reference-common";
import { statSync, rmSync, realpathSync } from "fs";
import { statSync, rmSync, realpathSync, existsSync } from "fs";
import { parseRemoteUrl } from "@plannotator/shared/repo";
import { registerSession, unregisterSession, listSessions } from "@plannotator/server/sessions";
import { openBrowser } from "@plannotator/server/browser";
import { detectProjectName } from "@plannotator/server/project";
import { hostnameOrFallback } from "@plannotator/shared/project";
import { planDenyFeedback } from "@plannotator/shared/feedback-templates";
import { readImprovementHook } from "@plannotator/shared/improvement-hooks";
import type { Origin } from "@plannotator/shared/agents";
@@ -109,6 +112,11 @@ if (browserIdx !== -1 && args[browserIdx + 1]) {
args.splice(browserIdx, 2);
}
// Global flag: --no-jina (disables Jina Reader for URL annotation)
const noJinaIdx = args.indexOf("--no-jina");
const cliNoJina = noJinaIdx !== -1;
if (cliNoJina) args.splice(noJinaIdx, 1);
if (isTopLevelHelpInvocation(args)) {
console.log(formatTopLevelHelp());
process.exit(0);
@@ -451,7 +459,7 @@ if (args[0] === "sessions") {
let filePath = args[1];
if (!filePath) {
console.error("Usage: plannotator annotate <file.md | folder/>");
console.error("Usage: plannotator annotate <file.md | file.html | https://... | folder/> [--no-jina]");
process.exit(1);
}
@@ -468,6 +476,31 @@ if (args[0] === "sessions") {
console.error(`[DEBUG] File path arg: ${filePath}`);
}
let markdown: string;
let absolutePath: string;
let folderPath: string | undefined;
let annotateMode: "annotate" | "annotate-folder" = "annotate";
let sourceInfo: string | undefined;
// --- URL annotation ---
const isUrl = /^https?:\/\//i.test(filePath);
if (isUrl) {
const useJina = resolveUseJina(cliNoJina, loadConfig());
console.error(`Fetching: ${filePath}${useJina ? " (via Jina Reader)" : " (via fetch+Turndown)"}`);
try {
const result = await urlToMarkdown(filePath, { useJina });
markdown = result.markdown;
if (process.env.PLANNOTATOR_DEBUG) {
console.error(`[DEBUG] Fetched via ${result.source} (${markdown.length} chars)`);
}
} catch (err) {
console.error(`Failed to fetch URL: ${err instanceof Error ? err.message : String(err)}`);
process.exit(1);
}
absolutePath = filePath; // Use URL as the "path" for display
sourceInfo = filePath; // Full URL for source attribution
} else {
// Check if the argument is a directory (folder annotation mode)
const resolvedArg = path.resolve(projectRoot, filePath);
let isFolder = false;
@@ -477,15 +510,10 @@ if (args[0] === "sessions") {
// Not a directory, fall through to file resolution
}
let markdown: string;
let absolutePath: string;
let folderPath: string | undefined;
let annotateMode: "annotate" | "annotate-folder" = "annotate";
if (isFolder) {
// Folder annotation mode
if (!hasMarkdownFiles(resolvedArg, FILE_BROWSER_EXCLUDED)) {
console.error(`No markdown files found in ${resolvedArg}`);
// Folder annotation mode (markdown + HTML files)
if (!hasMarkdownFiles(resolvedArg, FILE_BROWSER_EXCLUDED, /\.(mdx?|html?)$/i)) {
console.error(`No markdown or HTML files found in ${resolvedArg}`);
process.exit(1);
}
folderPath = resolvedArg;
@@ -493,8 +521,24 @@ if (args[0] === "sessions") {
markdown = "";
annotateMode = "annotate-folder";
console.error(`Folder: ${resolvedArg}`);
} else if (/\.html?$/i.test(resolvedArg)) {
// HTML file annotation mode — convert to markdown via Turndown
if (!existsSync(resolvedArg)) {
console.error(`File not found: ${filePath}`);
process.exit(1);
}
const htmlFile = Bun.file(resolvedArg);
if (htmlFile.size > 10 * 1024 * 1024) {
console.error(`File too large (${Math.round(htmlFile.size / 1024 / 1024)}MB, max 10MB): ${resolvedArg}`);
process.exit(1);
}
const html = await htmlFile.text();
markdown = htmlToMarkdown(html);
absolutePath = resolvedArg;
sourceInfo = path.basename(resolvedArg);
console.error(`Converted: ${absolutePath}`);
} else {
// Single file annotation mode
// Single markdown file annotation mode
const resolved = resolveMarkdownFile(filePath, projectRoot);
if (resolved.kind === "ambiguous") {
@@ -513,6 +557,7 @@ if (args[0] === "sessions") {
markdown = await Bun.file(absolutePath).text();
console.error(`Resolved: ${absolutePath}`);
}
}
const annotateProject = (await detectProjectName()) ?? "_unknown";
@@ -523,6 +568,7 @@ if (args[0] === "sessions") {
origin: detectedOrigin,
mode: annotateMode,
folderPath,
sourceInfo,
sharingEnabled,
shareBaseUrl,
pasteApiUrl,
@@ -543,7 +589,9 @@ if (args[0] === "sessions") {
mode: "annotate",
project: annotateProject,
startedAt: new Date().toISOString(),
label: folderPath ? `annotate-${path.basename(folderPath)}` : `annotate-${path.basename(absolutePath)}`,
label: folderPath
? `annotate-${path.basename(folderPath)}`
: `annotate-${isUrl ? hostnameOrFallback(absolutePath) : path.basename(absolutePath)}`,
});
// Wait for user feedback
+53 -5
View File
@@ -20,8 +20,12 @@ import {
} from "@plannotator/server/annotate";
import { getGitContext, runGitDiffWithContext } from "@plannotator/server/git";
import { parsePRUrl, checkPRAuth, fetchPR, getCliName, getMRLabel, getMRNumberLabel, getDisplayRepo } from "@plannotator/server/pr";
import { loadConfig, resolveDefaultDiffType } from "@plannotator/shared/config";
import { loadConfig, resolveDefaultDiffType, resolveUseJina } from "@plannotator/shared/config";
import { resolveMarkdownFile } from "@plannotator/shared/resolve-file";
import { htmlToMarkdown } from "@plannotator/shared/html-to-markdown";
import { urlToMarkdown } from "@plannotator/shared/url-to-markdown";
import { statSync } from "fs";
import path from "path";
/** Shared dependencies injected by the plugin */
export interface CommandDeps {
@@ -149,13 +153,54 @@ export async function handleAnnotateCommand(
const filePath = event.properties?.arguments || event.arguments || "";
if (!filePath) {
client.app.log({ level: "error", message: "Usage: /plannotator-annotate <file.md>" });
client.app.log({ level: "error", message: "Usage: /plannotator-annotate <file.md | file.html | https://...>" });
return;
}
client.app.log({ level: "info", message: `Opening annotation UI for ${filePath}...` });
let markdown: string;
let absolutePath: string;
let sourceInfo: string | undefined;
// --- URL annotation ---
const isUrl = /^https?:\/\//i.test(filePath);
if (isUrl) {
const useJina = resolveUseJina(false, loadConfig());
client.app.log({ level: "info", message: `Fetching: ${filePath}${useJina ? " (via Jina Reader)" : " (via fetch+Turndown)"}...` });
try {
const result = await urlToMarkdown(filePath, { useJina });
markdown = result.markdown;
} catch (err) {
client.app.log({ level: "error", message: `Failed to fetch URL: ${err instanceof Error ? err.message : String(err)}` });
return;
}
absolutePath = filePath;
sourceInfo = filePath;
} else {
const projectRoot = process.cwd();
const resolvedArg = path.resolve(projectRoot, filePath);
if (/\.html?$/i.test(resolvedArg)) {
// HTML file annotation — convert to markdown via Turndown
let fileSize: number;
try {
fileSize = statSync(resolvedArg).size;
} catch {
client.app.log({ level: "error", message: `File not found: ${filePath}` });
return;
}
if (fileSize > 10 * 1024 * 1024) {
client.app.log({ level: "error", message: `File too large (${Math.round(fileSize / 1024 / 1024)}MB, max 10MB)` });
return;
}
const html = await Bun.file(resolvedArg).text();
markdown = htmlToMarkdown(html);
absolutePath = resolvedArg;
sourceInfo = path.basename(resolvedArg);
client.app.log({ level: "info", message: `Converted: ${absolutePath}` });
} else {
// Markdown file annotation
client.app.log({ level: "info", message: `Opening annotation UI for ${filePath}...` });
const resolved = await resolveMarkdownFile(filePath, projectRoot);
if (resolved.kind === "ambiguous") {
@@ -170,14 +215,17 @@ export async function handleAnnotateCommand(
return;
}
const absolutePath = resolved.path;
absolutePath = resolved.path;
client.app.log({ level: "info", message: `Resolved: ${absolutePath}` });
const markdown = await Bun.file(absolutePath).text();
markdown = await Bun.file(absolutePath).text();
}
}
const server = await startAnnotateServer({
markdown,
filePath: absolutePath,
origin: "opencode",
sourceInfo,
sharingEnabled: await getSharingEnabled(),
shareBaseUrl: getShareBaseUrl(),
htmlContent,
@@ -1,5 +1,5 @@
---
description: Open interactive annotation UI for a markdown file
description: Open interactive annotation UI for a markdown file, HTML file, or URL
---
The Plannotator Annotate UI has been triggered. Opening the annotation UI...
+44 -12
View File
@@ -19,7 +19,7 @@
*/
import { existsSync, readFileSync, statSync } from "node:fs";
import { resolve } from "node:path";
import { resolve, basename } from "node:path";
import type { ThinkingLevel } from "@mariozechner/pi-agent-core";
import { Type } from "@mariozechner/pi-ai";
import type {
@@ -36,6 +36,9 @@ import {
import { planDenyFeedback } from "./generated/feedback-templates.js";
import { hasMarkdownFiles } from "./generated/resolve-file.js";
import { FILE_BROWSER_EXCLUDED } from "./generated/reference-common.js";
import { htmlToMarkdown } from "./generated/html-to-markdown.js";
import { urlToMarkdown } from "./generated/url-to-markdown.js";
import { loadConfig, resolveUseJina } from "./generated/config.js";
import {
getLastAssistantMessageText,
hasPlanBrowserHtml,
@@ -380,7 +383,7 @@ export default function plannotator(pi: ExtensionAPI): void {
handler: async (args, ctx) => {
const filePath = args?.trim();
if (!filePath) {
ctx.ui.notify("Usage: /plannotator-annotate <file.md | folder/>", "error");
ctx.ui.notify("Usage: /plannotator-annotate <file.md | file.html | https://... | folder/>", "error");
return;
}
if (!hasPlanBrowserHtml()) {
@@ -391,14 +394,35 @@ export default function plannotator(pi: ExtensionAPI): void {
return;
}
const absolutePath = resolve(ctx.cwd, filePath);
let markdown: string;
let absolutePath: string;
let folderPath: string | undefined;
let mode: "annotate" | "annotate-folder" | undefined;
let sourceInfo: string | undefined;
let isFolder = false;
// --- URL annotation ---
const isUrl = /^https?:\/\//i.test(filePath);
if (isUrl) {
const useJina = resolveUseJina(false, loadConfig());
ctx.ui.notify(`Fetching: ${filePath}${useJina ? " (via Jina Reader)" : " (via fetch+Turndown)"}...`, "info");
try {
const result = await urlToMarkdown(filePath, { useJina });
markdown = result.markdown;
} catch (err) {
ctx.ui.notify(`Failed to fetch URL: ${err instanceof Error ? err.message : String(err)}`, "error");
return;
}
absolutePath = filePath;
sourceInfo = filePath;
} else {
absolutePath = resolve(ctx.cwd, filePath);
if (!existsSync(absolutePath)) {
ctx.ui.notify(`File not found: ${absolutePath}`, "error");
return;
}
// Check if the argument is a directory (folder annotation mode)
let isFolder = false;
try {
isFolder = statSync(absolutePath).isDirectory();
} catch {
@@ -406,26 +430,34 @@ export default function plannotator(pi: ExtensionAPI): void {
return;
}
let markdown: string;
let folderPath: string | undefined;
let mode: "annotate" | "annotate-folder" | undefined;
if (isFolder) {
if (!hasMarkdownFiles(absolutePath, FILE_BROWSER_EXCLUDED)) {
ctx.ui.notify(`No markdown files found in ${absolutePath}`, "error");
if (!hasMarkdownFiles(absolutePath, FILE_BROWSER_EXCLUDED, /\.(mdx?|html?)$/i)) {
ctx.ui.notify(`No markdown or HTML files found in ${absolutePath}`, "error");
return;
}
markdown = "";
folderPath = absolutePath;
mode = "annotate-folder";
ctx.ui.notify(`Opening annotation UI for folder ${filePath}...`, "info");
} else if (/\.html?$/i.test(absolutePath)) {
// HTML file annotation — convert to markdown via Turndown
const fileSize = statSync(absolutePath).size;
if (fileSize > 10 * 1024 * 1024) {
ctx.ui.notify(`File too large (${Math.round(fileSize / 1024 / 1024)}MB, max 10MB)`, "error");
return;
}
const html = readFileSync(absolutePath, "utf-8");
markdown = htmlToMarkdown(html);
sourceInfo = basename(absolutePath);
ctx.ui.notify(`Opening annotation UI for ${filePath}...`, "info");
} else {
markdown = readFileSync(absolutePath, "utf-8");
ctx.ui.notify(`Opening annotation UI for ${filePath}...`, "info");
}
}
try {
const result = await openMarkdownAnnotation(ctx, absolutePath, markdown, mode ?? "annotate", folderPath);
const result = await openMarkdownAnnotation(ctx, absolutePath, markdown, mode ?? "annotate", folderPath, sourceInfo);
if (result.exit) {
ctx.ui.notify("Annotation session closed.", "info");
} else if (result.feedback) {
+4
View File
@@ -38,6 +38,10 @@
"build": "cp ../hook/dist/index.html plannotator.html && cp ../hook/dist/review.html review-editor.html && rm -rf skills && cp -r ../skills skills && bash vendor.sh",
"prepublishOnly": "cd ../.. && bun run build:pi"
},
"dependencies": {
"turndown": "^7.2.4",
"@joplin/turndown-plugin-gfm": "^1.0.64"
},
"peerDependencies": {
"@mariozechner/pi-coding-agent": ">=0.53.0"
}
+2
View File
@@ -368,6 +368,7 @@ export async function openMarkdownAnnotation(
markdown: string,
mode: AnnotateMode,
folderPath?: string,
sourceInfo?: string,
): Promise<{ feedback: string; exit?: boolean }> {
if (!ctx.hasUI || !planHtmlContent) {
throw new Error("Plannotator annotation browser is unavailable in this session.");
@@ -391,6 +392,7 @@ export async function openMarkdownAnnotation(
origin: "pi",
mode,
folderPath,
sourceInfo,
htmlContent: planHtmlContent,
sharingEnabled: process.env.PLANNOTATOR_SHARE !== "disabled",
shareBaseUrl: process.env.PLANNOTATOR_SHARE_URL || undefined,
+34 -10
View File
@@ -22,12 +22,13 @@ import {
FILE_BROWSER_EXCLUDED,
} from "../generated/reference-common.js";
import { detectObsidianVaults } from "../generated/integrations-common.js";
import { resolveMarkdownFile } from "../generated/resolve-file.js";
import { resolveMarkdownFile, isWithinProjectRoot } from "../generated/resolve-file.js";
import { htmlToMarkdown } from "../generated/html-to-markdown.js";
type Res = ServerResponse;
/** Recursively walk a directory collecting markdown files, skipping ignored dirs. */
function walkMarkdownFiles(dir: string, root: string, results: string[]): void {
/** Recursively walk a directory collecting files by extension, skipping ignored dirs. */
function walkMarkdownFiles(dir: string, root: string, results: string[], extensions: RegExp = /\.(mdx?|html?)$/i): void {
let entries: Dirent[];
try {
entries = readdirSync(dir, { withFileTypes: true }) as Dirent[];
@@ -37,8 +38,8 @@ function walkMarkdownFiles(dir: string, root: string, results: string[]): void {
for (const entry of entries) {
if (entry.isDirectory()) {
if (FILE_BROWSER_EXCLUDED.includes(entry.name + "/")) continue;
walkMarkdownFiles(join(dir, entry.name), root, results);
} else if (entry.isFile() && /\.mdx?$/i.test(entry.name)) {
walkMarkdownFiles(join(dir, entry.name), root, results, extensions);
} else if (entry.isFile() && extensions.test(entry.name)) {
const relative = join(dir, entry.name)
.slice(root.length + 1)
.replace(/\\/g, "/");
@@ -55,17 +56,22 @@ export function handleDocRequest(res: Res, url: URL): void {
return;
}
// Try resolving relative to base directory first (used by annotate mode)
// Try resolving relative to base directory first (used by annotate mode).
// No isWithinProjectRoot check here — intentional, matches pre-existing
// markdown behavior. The base param is set server-side by the annotate
// server (see serverAnnotate.ts /api/doc route). The standalone HTML
// block below (no base) retains its cwd-based containment check.
const base = url.searchParams.get("base");
if (
base &&
!requestedPath.startsWith("/") &&
/\.mdx?$/i.test(requestedPath)
/\.(mdx?|html?)$/i.test(requestedPath)
) {
const fromBase = resolvePath(base, requestedPath);
try {
if (existsSync(fromBase)) {
const markdown = readFileSync(fromBase, "utf-8");
const raw = readFileSync(fromBase, "utf-8");
const markdown = /\.html?$/i.test(requestedPath) ? htmlToMarkdown(raw) : raw;
json(res, { markdown, filepath: fromBase });
return;
}
@@ -74,7 +80,25 @@ export function handleDocRequest(res: Res, url: URL): void {
}
}
// HTML files: resolve directly (not via resolveMarkdownFile which only handles .md/.mdx)
const projectRoot = process.cwd();
if (/\.html?$/i.test(requestedPath)) {
const resolvedHtml = resolvePath(base || projectRoot, requestedPath);
if (!isWithinProjectRoot(resolvedHtml, projectRoot)) {
json(res, { error: "Access denied: path is outside project root" }, 403);
return;
}
try {
if (existsSync(resolvedHtml)) {
const html = readFileSync(resolvedHtml, "utf-8");
json(res, { markdown: htmlToMarkdown(html), filepath: resolvedHtml });
return;
}
} catch { /* fall through to 404 */ }
json(res, { error: `File not found: ${requestedPath}` }, 404);
return;
}
const result = resolveMarkdownFile(requestedPath, projectRoot);
if (result.kind === "ambiguous") {
@@ -119,7 +143,7 @@ export function handleObsidianFilesRequest(res: Res, url: URL): void {
}
try {
const files: string[] = [];
walkMarkdownFiles(resolvedVault, resolvedVault, files);
walkMarkdownFiles(resolvedVault, resolvedVault, files, /\.mdx?$/i);
files.sort();
json(res, { tree: buildFileTree(files) });
} catch {
@@ -144,7 +168,7 @@ export function handleObsidianDocRequest(res: Res, url: URL): void {
// Bare filename search within vault
if (!existsSync(resolvedFile) && !filePath.includes("/")) {
const files: string[] = [];
walkMarkdownFiles(resolvedVault, resolvedVault, files);
walkMarkdownFiles(resolvedVault, resolvedVault, files, /\.mdx?$/i);
const matches = files.filter(
(f) => f.split("/").pop()!.toLowerCase() === filePath.toLowerCase(),
);
+5 -2
View File
@@ -42,6 +42,7 @@ export async function startAnnotateServer(options: {
sharingEnabled?: boolean;
shareBaseUrl?: string;
pasteApiUrl?: string;
sourceInfo?: string;
}): Promise<AnnotateServerResult> {
const gitUser = detectGitUser();
const sharingEnabled =
@@ -83,6 +84,7 @@ export async function startAnnotateServer(options: {
origin: options.origin ?? "pi",
mode: options.mode || "annotate",
filePath: options.filePath,
sourceInfo: options.sourceInfo,
sharingEnabled,
shareBaseUrl,
pasteApiUrl,
@@ -109,8 +111,9 @@ export async function startAnnotateServer(options: {
} else if (url.pathname === "/api/draft") {
await handleDraftRequest(req, res, draftKey);
} else if (url.pathname === "/api/doc" && req.method === "GET") {
// Inject source file's directory as base for relative path resolution
if (!url.searchParams.has("base") && options.filePath) {
// Inject source file's directory as base for relative path resolution.
// Skip for URL annotations — there's no local directory to resolve against.
if (!url.searchParams.has("base") && options.filePath && !/^https?:\/\//i.test(options.filePath)) {
url.searchParams.set("base", dirname(resolvePath(options.filePath)));
}
handleDocRequest(res, url);
+1 -1
View File
@@ -6,7 +6,7 @@ cd "$(dirname "$0")"
mkdir -p generated generated/ai/providers
for f in feedback-templates review-core storage draft project pr-provider pr-github pr-gitlab checklist integrations-common repo reference-common favicon resolve-file config external-annotation agent-jobs worktree; do
for f in feedback-templates review-core storage draft project pr-provider pr-github pr-gitlab checklist integrations-common repo reference-common favicon resolve-file config external-annotation agent-jobs worktree html-to-markdown url-to-markdown; do
src="../../packages/shared/$f.ts"
printf '// @generated — DO NOT EDIT. Source: packages/shared/%s.ts\n' "$f" | cat - "$src" > "generated/$f.ts"
done
+20 -3
View File
@@ -17,6 +17,7 @@
"devDependencies": {
"@types/dompurify": "^3.2.0",
"@types/node": "^25.5.0",
"@types/turndown": "^5.0.6",
"bun-types": "^1.3.11",
},
},
@@ -63,7 +64,7 @@
},
"apps/opencode-plugin": {
"name": "@plannotator/opencode",
"version": "0.17.7",
"version": "0.17.9",
"dependencies": {
"@opencode-ai/plugin": "^1.1.10",
},
@@ -85,7 +86,11 @@
},
"apps/pi-extension": {
"name": "@plannotator/pi-extension",
"version": "0.17.7",
"version": "0.17.9",
"dependencies": {
"@joplin/turndown-plugin-gfm": "^1.0.64",
"turndown": "^7.2.4",
},
"peerDependencies": {
"@mariozechner/pi-coding-agent": ">=0.53.0",
},
@@ -171,7 +176,7 @@
},
"packages/server": {
"name": "@plannotator/server",
"version": "0.17.7",
"version": "0.17.9",
"dependencies": {
"@plannotator/ai": "workspace:*",
"@plannotator/shared": "workspace:*",
@@ -183,6 +188,10 @@
"packages/shared": {
"name": "@plannotator/shared",
"version": "0.0.1",
"dependencies": {
"@joplin/turndown-plugin-gfm": "^1.0.64",
"turndown": "^7.2.4",
},
},
"packages/ui": {
"name": "@plannotator/ui",
@@ -516,6 +525,8 @@
"@isaacs/cliui": ["@isaacs/cliui@9.0.0", "", {}, "sha512-AokJm4tuBHillT+FpMtxQ60n8ObyXBatq7jD2/JA9dxbDDokKQm8KMht5ibGzLVU9IJDIKK4TPKgMHEYMn3lMg=="],
"@joplin/turndown-plugin-gfm": ["@joplin/turndown-plugin-gfm@1.0.64", "", {}, "sha512-8GJ7f9OenE3zkSVII5B6qzIkvgF7C/a20gaASEjM6jWPLPJFFQ2nQ3Ou/kXH1mPUTs9dC9VYs8QXVPvZabKXBQ=="],
"@jridgewell/gen-mapping": ["@jridgewell/gen-mapping@0.3.13", "", { "dependencies": { "@jridgewell/sourcemap-codec": "^1.5.0", "@jridgewell/trace-mapping": "^0.3.24" } }, "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA=="],
"@jridgewell/remapping": ["@jridgewell/remapping@2.3.5", "", { "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.24" } }, "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ=="],
@@ -564,6 +575,8 @@
"@mistralai/mistralai": ["@mistralai/mistralai@1.10.0", "", { "dependencies": { "zod": "^3.20.0", "zod-to-json-schema": "^3.24.1" } }, "sha512-tdIgWs4Le8vpvPiUEWne6tK0qbVc+jMenujnvTqOjogrJUsCSQhus0tHTU1avDDh5//Rq2dFgP9mWRAdIEoBqg=="],
"@mixmark-io/domino": ["@mixmark-io/domino@2.2.0", "", {}, "sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw=="],
"@modelcontextprotocol/sdk": ["@modelcontextprotocol/sdk@1.28.0", "", { "dependencies": { "@hono/node-server": "^1.19.9", "ajv": "^8.17.1", "ajv-formats": "^3.0.1", "content-type": "^1.0.5", "cors": "^2.8.5", "cross-spawn": "^7.0.5", "eventsource": "^3.0.2", "eventsource-parser": "^3.0.0", "express": "^5.2.1", "express-rate-limit": "^8.2.1", "hono": "^4.11.4", "jose": "^6.1.3", "json-schema-typed": "^8.0.2", "pkce-challenge": "^5.0.0", "raw-body": "^3.0.0", "zod": "^3.25 || ^4.0", "zod-to-json-schema": "^3.25.1" }, "peerDependencies": { "@cfworker/json-schema": "^4.1.1" }, "optionalPeers": ["@cfworker/json-schema"] }, "sha512-gmloF+i+flI8ouQK7MWW4mOwuMh4RePBuPFAEPC6+pdqyWOUMDOixb6qZ69owLJpz6XmyllCouc4t8YWO+E2Nw=="],
"@nodelib/fs.scandir": ["@nodelib/fs.scandir@2.1.5", "", { "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g=="],
@@ -1010,6 +1023,8 @@
"@types/trusted-types": ["@types/trusted-types@2.0.7", "", {}, "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw=="],
"@types/turndown": ["@types/turndown@5.0.6", "", {}, "sha512-ru00MoyeeouE5BX4gRL+6m/BsDfbRayOskWqUvh7CLGW+UXxHQItqALa38kKnOiZPqJrtzJUgAC2+F0rL1S4Pg=="],
"@types/unist": ["@types/unist@3.0.3", "", {}, "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q=="],
"@types/vscode": ["@types/vscode@1.109.0", "", {}, "sha512-0Pf95rnwEIwDbmXGC08r0B4TQhAbsHQ5UyTIgVgoieDe4cOnf92usuR5dEczb6bTKEp7ziZH4TV1TRGPPCExtw=="],
@@ -2350,6 +2365,8 @@
"tunnel-agent": ["tunnel-agent@0.6.0", "", { "dependencies": { "safe-buffer": "^5.0.1" } }, "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w=="],
"turndown": ["turndown@7.2.4", "", { "dependencies": { "@mixmark-io/domino": "^2.2.0" } }, "sha512-I8yFsfRzmzK0WV1pNNOA4A7y4RDfFxPRxb3t+e3ui14qSGOxGtiSP6GjeX+Y6CHb7HYaFj7ECUD7VE5kQMZWGQ=="],
"type-fest": ["type-fest@4.41.0", "", {}, "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA=="],
"type-is": ["type-is@2.0.1", "", { "dependencies": { "content-type": "^1.0.5", "media-typer": "^1.1.0", "mime-types": "^3.0.0" } }, "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw=="],
+1
View File
@@ -45,6 +45,7 @@
"devDependencies": {
"@types/dompurify": "^3.2.0",
"@types/node": "^25.5.0",
"@types/turndown": "^5.0.6",
"bun-types": "^1.3.11"
}
}
+4 -1
View File
@@ -134,6 +134,7 @@ const App: React.FC = () => {
const [globalAttachments, setGlobalAttachments] = useState<ImageAttachment[]>([]);
const [annotateMode, setAnnotateMode] = useState(false);
const [annotateSource, setAnnotateSource] = useState<'file' | 'message' | 'folder' | null>(null);
const [sourceInfo, setSourceInfo] = useState<string | undefined>();
const [sourceFilePath, setSourceFilePath] = useState<string | undefined>();
const [imageBaseDir, setImageBaseDir] = useState<string | undefined>(undefined);
const [isLoading, setIsLoading] = useState(true);
@@ -525,7 +526,7 @@ const App: React.FC = () => {
if (!res.ok) throw new Error('Not in API mode');
return res.json();
})
.then((data: { plan: string; origin?: Origin; mode?: 'annotate' | 'annotate-last' | 'annotate-folder' | 'archive'; filePath?: string; sharingEnabled?: boolean; shareBaseUrl?: string; pasteApiUrl?: string; repoInfo?: { display: string; branch?: string }; previousPlan?: string | null; versionInfo?: { version: number; totalVersions: number; project: string }; archivePlans?: ArchivedPlan[]; projectRoot?: string; isWSL?: boolean; serverConfig?: { displayName?: string; gitUser?: string } }) => {
.then((data: { plan: string; origin?: Origin; mode?: 'annotate' | 'annotate-last' | 'annotate-folder' | 'archive'; filePath?: string; sourceInfo?: string; sharingEnabled?: boolean; shareBaseUrl?: string; pasteApiUrl?: string; repoInfo?: { display: string; branch?: string }; previousPlan?: string | null; versionInfo?: { version: number; totalVersions: number; project: string }; archivePlans?: ArchivedPlan[]; projectRoot?: string; isWSL?: boolean; serverConfig?: { displayName?: string; gitUser?: string } }) => {
// Initialize config store with server-provided values (config file > cookie > default)
configStore.init(data.serverConfig);
// gitUser drives the "Use git name" button in Settings; stays undefined (button hidden) when unavailable
@@ -553,6 +554,7 @@ const App: React.FC = () => {
if (data.mode && data.mode !== 'archive') {
setAnnotateSource(data.mode === 'annotate-last' ? 'message' : data.mode === 'annotate-folder' ? 'folder' : 'file');
}
setSourceInfo(data.sourceInfo ?? undefined);
if (data.filePath) {
setImageBaseDir(data.mode === 'annotate-folder' ? data.filePath : data.filePath.replace(/\/[^/]+$/, ''));
if (data.mode === 'annotate') {
@@ -1625,6 +1627,7 @@ const App: React.FC = () => {
imageBaseDir={imageBaseDir}
copyLabel={annotateSource === 'message' ? 'Copy message' : annotateSource === 'file' || annotateSource === 'folder' ? 'Copy file' : undefined}
archiveInfo={archive.currentInfo}
sourceInfo={sourceInfo}
onToggleCheckbox={checkbox.toggle}
checkboxOverrides={checkbox.overrides}
actionsLabelMode={actionsLabelMode}
+7 -2
View File
@@ -48,6 +48,8 @@ export interface AnnotateServerOptions {
shareBaseUrl?: string;
/** Base URL of the paste service API for short URL sharing */
pasteApiUrl?: string;
/** Source attribution: original URL or filename (e.g. "https://..." or "index.html") */
sourceInfo?: string;
/** Called when server starts with the URL, remote status, and port */
onReady?: (url: string, isRemote: boolean, port: number) => void;
}
@@ -92,6 +94,7 @@ export async function startAnnotateServer(
origin,
mode = "annotate",
folderPath,
sourceInfo,
sharingEnabled = true,
shareBaseUrl,
pasteApiUrl,
@@ -140,6 +143,7 @@ export async function startAnnotateServer(
origin,
mode,
filePath,
sourceInfo,
sharingEnabled,
shareBaseUrl,
pasteApiUrl,
@@ -172,9 +176,10 @@ export async function startAnnotateServer(
}
// API: Serve a linked markdown document
// Inject source file's directory as base for relative path resolution
// Inject source file's directory as base for relative path resolution.
// Skip base injection for URL annotations — there's no local directory to resolve against.
if (url.pathname === "/api/doc" && req.method === "GET") {
if (!url.searchParams.has("base")) {
if (!url.searchParams.has("base") && !/^https?:\/\//i.test(filePath)) {
const docUrl = new URL(req.url);
docUrl.searchParams.set("base", dirname(filePath));
return handleDoc(new Request(docUrl.toString()));
+28 -5
View File
@@ -9,7 +9,8 @@ import { existsSync, statSync } from "fs";
import { resolve } from "path";
import { buildFileTree, FILE_BROWSER_EXCLUDED } from "@plannotator/shared/reference-common";
import { detectObsidianVaults } from "./integrations";
import { resolveMarkdownFile } from "@plannotator/shared/resolve-file";
import { resolveMarkdownFile, isWithinProjectRoot } from "@plannotator/shared/resolve-file";
import { htmlToMarkdown } from "@plannotator/shared/html-to-markdown";
// --- Route handlers ---
@@ -22,18 +23,23 @@ export async function handleDoc(req: Request): Promise<Response> {
}
// If a base directory is provided, try resolving relative to it first
// (used by annotate mode to resolve paths relative to the source file)
// (used by annotate mode to resolve paths relative to the source file).
// No isWithinProjectRoot check here — intentional, matches pre-existing
// markdown behavior. The base param is set server-side by the annotate
// server (see annotate.ts /api/doc route). The standalone HTML block
// below (no base) retains its cwd-based containment check.
const base = url.searchParams.get("base");
if (
base &&
!requestedPath.startsWith("/") &&
/\.mdx?$/i.test(requestedPath)
/\.(mdx?|html?)$/i.test(requestedPath)
) {
const fromBase = resolve(base, requestedPath);
try {
const file = Bun.file(fromBase);
if (await file.exists()) {
const markdown = await file.text();
const raw = await file.text();
const markdown = /\.html?$/i.test(requestedPath) ? htmlToMarkdown(raw) : raw;
return Response.json({ markdown, filepath: fromBase });
}
} catch {
@@ -41,7 +47,24 @@ export async function handleDoc(req: Request): Promise<Response> {
}
}
// HTML files: resolve directly (not via resolveMarkdownFile which only handles .md/.mdx)
const projectRoot = process.cwd();
if (/\.html?$/i.test(requestedPath)) {
const resolvedHtml = resolve(base || projectRoot, requestedPath);
if (!isWithinProjectRoot(resolvedHtml, projectRoot)) {
return Response.json({ error: "Access denied: path is outside project root" }, { status: 403 });
}
try {
const file = Bun.file(resolvedHtml);
if (await file.exists()) {
const html = await file.text();
const markdown = htmlToMarkdown(html);
return Response.json({ markdown, filepath: resolvedHtml });
}
} catch { /* fall through */ }
return Response.json({ error: `File not found: ${requestedPath}` }, { status: 404 });
}
const result = resolveMarkdownFile(requestedPath, projectRoot);
if (result.kind === "ambiguous") {
@@ -203,7 +226,7 @@ export async function handleFileBrowserFiles(req: Request): Promise<Response> {
}
try {
const glob = new Bun.Glob("**/*.{md,mdx}");
const glob = new Bun.Glob("**/*.{md,mdx,html,htm}");
const files: string[] = [];
for await (const match of glob.scan({
cwd: resolvedDir,
+30
View File
@@ -45,6 +45,13 @@ export interface PlannotatorConfig {
* (`gh auth login`). OS-level opt-in only — no UI surface. Default: false.
*/
verifyAttestation?: boolean;
/**
* Enable Jina Reader for URL-to-markdown conversion during annotation.
* When true (default), `plannotator annotate <url>` routes through
* r.jina.ai for better JS-rendered page support and reader-mode extraction.
* Set to false to always use plain fetch + Turndown.
*/
jina?: boolean;
}
const CONFIG_DIR = join(homedir(), ".plannotator");
@@ -125,3 +132,26 @@ export function resolveDefaultDiffType(cfg?: PlannotatorConfig): DefaultDiffType
const v = cfg?.diffOptions?.defaultDiffType;
return v === 'uncommitted' || v === 'unstaged' || v === 'staged' ? v : 'unstaged';
}
/**
* Resolve whether to use Jina Reader for URL annotation.
*
* Priority (highest wins):
* --no-jina CLI flag → PLANNOTATOR_JINA env var → config.jina → default true
*/
export function resolveUseJina(cliNoJina: boolean, config: PlannotatorConfig): boolean {
// CLI flag has highest priority
if (cliNoJina) return false;
// Environment variable
const envVal = process.env.PLANNOTATOR_JINA;
if (envVal !== undefined) {
return envVal === "1" || envVal.toLowerCase() === "true";
}
// Config file
if (config.jina !== undefined) return config.jina;
// Default: enabled
return true;
}
+62
View File
@@ -0,0 +1,62 @@
import { describe, expect, test } from "bun:test";
import { htmlToMarkdown } from "./html-to-markdown";
describe("htmlToMarkdown", () => {
test("converts basic HTML to markdown", () => {
const md = htmlToMarkdown("<h1>Hello</h1><p>World</p>");
expect(md).toContain("# Hello");
expect(md).toContain("World");
});
test("converts tables with explicit thead", () => {
const html = "<table><thead><tr><th>A</th><th>B</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>";
const md = htmlToMarkdown(html);
expect(md).toContain("| A");
expect(md).toContain("| ---");
expect(md).toContain("| 1");
});
test("converts tables WITHOUT thead (common HTML pattern)", () => {
const html = "<table><tr><th>Name</th><th>Value</th></tr><tr><td>foo</td><td>bar</td></tr></table>";
const md = htmlToMarkdown(html);
expect(md).toContain("| Name");
expect(md).toContain("| ---");
expect(md).toContain("| foo");
});
test("strips script, style, and noscript tags", () => {
const html = '<p>Visible</p><script>alert("xss")</script><style>.x{}</style><noscript>Hidden</noscript>';
const md = htmlToMarkdown(html);
expect(md).toContain("Visible");
expect(md).not.toContain("alert");
expect(md).not.toContain(".x{}");
expect(md).not.toContain("Hidden");
});
test("converts strikethrough (GFM)", () => {
const md = htmlToMarkdown("<p>This is <del>deleted</del> text</p>");
expect(md).toContain("~deleted~");
});
test("preserves code blocks as fenced markdown", () => {
const md = htmlToMarkdown('<pre><code>const x = 1;</code></pre>');
expect(md).toContain("```");
expect(md).toContain("const x = 1;");
});
test("converts links", () => {
const md = htmlToMarkdown('<a href="https://example.com">Click</a>');
expect(md).toContain("[Click](https://example.com)");
});
test("preserves dangerous link hrefs (sanitization is in the renderer, not here)", () => {
const md = htmlToMarkdown('<a href="javascript:alert(1)">XSS</a>');
// Turndown preserves the link — the UI renderer blocks it
expect(md).toContain("javascript:");
});
test("handles empty HTML gracefully", () => {
expect(htmlToMarkdown("")).toBe("");
expect(htmlToMarkdown("<html><body></body></html>")).toBe("");
});
});
+32
View File
@@ -0,0 +1,32 @@
/**
* HTML-to-Markdown conversion via Turndown.
*
* Shared between the CLI (single HTML file / URL) and the server
* (on-demand conversion for HTML files in folder mode).
*/
import TurndownService from "turndown";
// @ts-expect-error — @joplin/turndown-plugin-gfm ships JS only, no .d.ts (see declarations.d.ts for local types)
import { gfm } from "@joplin/turndown-plugin-gfm";
const td = new TurndownService({
headingStyle: "atx",
codeBlockStyle: "fenced",
bulletListMarker: "-",
});
td.use(gfm);
// Strip <style> and <script> tags entirely (Turndown keeps unrecognised
// tags as blank by default, but their text content can leak through).
td.remove(["style", "script", "noscript"]);
/**
* Convert an HTML string to Markdown.
*
* Uses a module-level TurndownService singleton (stateless, safe to reuse).
* GFM tables, strikethrough, and task lists are supported via turndown-plugin-gfm.
*/
export function htmlToMarkdown(html: string): string {
return td.turndown(html);
}
+7 -1
View File
@@ -23,6 +23,12 @@
"./agent-jobs": "./agent-jobs.ts",
"./config": "./config.ts",
"./improvement-hooks": "./improvement-hooks.ts",
"./worktree": "./worktree.ts"
"./worktree": "./worktree.ts",
"./html-to-markdown": "./html-to-markdown.ts",
"./url-to-markdown": "./url-to-markdown.ts"
},
"dependencies": {
"@joplin/turndown-plugin-gfm": "^1.0.64",
"turndown": "^7.2.4"
}
}
+11
View File
@@ -58,3 +58,14 @@ export function extractDirName(path: string): string | null {
return sanitizeTag(name);
}
/**
* Extract hostname from a URL string, or return the original string on failure.
*/
export function hostnameOrFallback(url: string): string {
try {
return new URL(url).hostname;
} catch {
return url;
}
}
+6
View File
@@ -21,6 +21,12 @@ export const FILE_BROWSER_EXCLUDED = [
".parcel-cache/",
".webpack/",
".expo/",
"_site/",
"public/",
".jekyll-cache/",
"out/",
".docusaurus/",
"storybook-static/",
];
export interface VaultNode {
+9 -4
View File
@@ -46,7 +46,7 @@ function normalizeComparablePath(input: string): string {
return stripTrailingSlashes(normalizeSeparators(resolve(input)));
}
function isWithinProjectRoot(candidate: string, projectRoot: string): boolean {
export function isWithinProjectRoot(candidate: string, projectRoot: string): boolean {
const normalizedCandidate = normalizeComparablePath(candidate);
const normalizedProjectRoot = normalizeComparablePath(projectRoot);
return (
@@ -272,13 +272,18 @@ export function resolveMarkdownFile(
}
/**
* Check if a directory contains at least one markdown file.
* Check if a directory contains at least one file matching the given extensions.
* Used to validate folder annotation targets.
*
* @param dirPath - Directory to search
* @param excludedDirs - Directory names to skip (with trailing slash, e.g. "node_modules/")
* @param extensions - Regex to match file extensions (default: markdown only)
*/
export function hasMarkdownFiles(dirPath: string, excludedDirs: string[] = IGNORED_DIRS): boolean {
export function hasMarkdownFiles(
dirPath: string,
excludedDirs: string[] = IGNORED_DIRS,
extensions: RegExp = /\.mdx?$/i,
): boolean {
function walk(dir: string): boolean {
let entries;
try {
@@ -290,7 +295,7 @@ export function hasMarkdownFiles(dirPath: string, excludedDirs: string[] = IGNOR
if (entry.isDirectory()) {
if (excludedDirs.some((d) => d === entry.name + "/")) continue;
if (walk(join(dir, entry.name))) return true;
} else if (entry.isFile() && /\.mdx?$/i.test(entry.name)) {
} else if (entry.isFile() && extensions.test(entry.name)) {
return true;
}
}
+285
View File
@@ -0,0 +1,285 @@
/**
* URL-to-Markdown conversion.
*
* Fetches a URL via Jina Reader (default) or plain fetch + Turndown,
* returning clean markdown for the annotation pipeline.
*/
import { htmlToMarkdown } from "./html-to-markdown";
export interface UrlToMarkdownOptions {
/** Whether to use Jina Reader (true) or plain fetch+Turndown (false). */
useJina: boolean;
}
export interface UrlToMarkdownResult {
markdown: string;
source: "jina" | "fetch+turndown" | "fetch-raw";
}
const FETCH_TIMEOUT_MS = 30_000;
const MAX_BODY_BYTES = 10 * 1024 * 1024; // 10 MB — matches local HTML file guard
/**
* Skip Jina for local/private URLs — fetch them directly instead.
*
* IMPORTANT — IPv6 hostname format (verified empirically in Bun 1.3.11 and Node 22):
* The WHATWG URL `hostname` getter returns IPv6 addresses WITH brackets.
* This is why PRIVATE_IPV6 uses `^\[` — it matches the actual runtime output.
*
* Verified outputs (both Bun and Node return identical results):
* new URL("http://[::1]:3000/").hostname → "[::1]"
* new URL("http://[fe80::1]/").hostname → "[fe80::1]"
* new URL("http://[fc00::1]/").hostname → "[fc00::1]"
* new URL("http://[fd12::1]/").hostname → "[fd12::1]"
* new URL("http://[::ffff:192.168.0.1]/").hostname → "[::ffff:c0a8:1]"
* new URL("http://[::ffff:169.254.169.254]/").hostname → "[::ffff:a9fe:a9fe]"
*
* The unbracketed "::1" check (line below) covers the edge case defensively.
*/
const PRIVATE_IPV4 = /^(10\.\d{1,3}|192\.168|172\.(1[6-9]|2\d|3[01])|169\.254)\.\d{1,3}\.\d{1,3}$/;
// Bracketed IPv6 private/reserved prefixes (matches WHATWG URL hostname getter output).
// fc00::/7 covers fc00:: through fdff::, so match [fc or [fd prefix.
const PRIVATE_IPV6 = /^\[(::1|::ffff:|fe80:|fc[0-9a-f]{2}:|fd[0-9a-f]{2}:)/i;
function isLocalUrl(url: string): boolean {
try {
const { hostname } = new URL(url);
if (
hostname === "localhost" ||
hostname === "::1" ||
hostname === "[::1]" ||
hostname === "0.0.0.0" ||
hostname.endsWith(".local") ||
/^127\./.test(hostname) ||
PRIVATE_IPV4.test(hostname)
) {
return true;
}
// IPv6 private ranges: link-local (fe80::), unique-local (fc00::/fd00::),
// and IPv4-mapped (::ffff:) which embeds private IPv4 in hex notation
if (PRIVATE_IPV6.test(hostname)) return true;
return false;
} catch {
return false;
}
}
/**
* Fetch a URL and return its content as markdown.
*
* When `useJina` is true, attempts Jina Reader first (returns markdown
* directly, handles JS-rendered pages). On failure, warns to stderr
* and falls back to plain fetch + Turndown.
*/
export async function urlToMarkdown(
url: string,
options: UrlToMarkdownOptions,
): Promise<UrlToMarkdownResult> {
// URLs pointing to markdown files — fetch raw if the server returns plain text.
// If the server returns HTML (e.g. GitHub's .md viewer), fall through to Jina/Turndown.
const urlPath = url.split("?")[0].split("#")[0];
if (/\.mdx?$/i.test(urlPath)) {
const text = await fetchRawText(url);
if (text !== null) {
return { markdown: text, source: "fetch-raw" };
}
// Server returned HTML for this .md URL — fall through to normal conversion
}
if (options.useJina && !isLocalUrl(url)) {
try {
const markdown = await fetchViaJina(url);
return { markdown, source: "jina" };
} catch (err) {
process.stderr.write(
`[plannotator] Warning: Jina Reader failed (${err instanceof Error ? err.message : String(err)}), falling back to direct fetch...\n`,
);
}
}
const markdown = await fetchViaTurndown(url);
return { markdown, source: "fetch+turndown" };
}
/** Read response body with a size limit. Throws if the body exceeds MAX_BODY_BYTES. */
async function readBodyWithLimit(res: Response): Promise<string> {
const contentLength = res.headers.get("content-length");
if (contentLength) {
const bytes = parseInt(contentLength, 10);
if (bytes > MAX_BODY_BYTES) {
res.body?.cancel();
throw new Error(`Response too large (${Math.round(bytes / 1024 / 1024)}MB, max 10MB)`);
}
}
const reader = res.body?.getReader();
if (!reader) {
// Null body is rare (e.g. manually constructed Response). Still enforce
// the size limit via the text result length as a best-effort fallback.
const text = await res.text();
if (text.length > MAX_BODY_BYTES) {
throw new Error(`Response too large (>${Math.round(MAX_BODY_BYTES / 1024 / 1024)}MB, max 10MB)`);
}
return text;
}
const chunks: Uint8Array[] = [];
let totalBytes = 0;
while (true) {
const { done, value } = await reader.read();
if (done) break;
totalBytes += value.byteLength;
if (totalBytes > MAX_BODY_BYTES) {
reader.cancel();
throw new Error(`Response too large (>${Math.round(MAX_BODY_BYTES / 1024 / 1024)}MB, max 10MB)`);
}
chunks.push(value);
}
return new TextDecoder().decode(Buffer.concat(chunks));
}
/**
* Fetch a URL as raw text — for .md/.mdx URLs that are already markdown.
* Returns null if the server returns HTML (e.g. GitHub's viewer page for
* a .md file), signaling the caller to fall through to Jina/Turndown.
*
* Uses redirect: "manual" with isLocalUrl validation on each hop —
* same SSRF protection as fetchViaTurndown.
*/
async function fetchRawText(url: string): Promise<string | null> {
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS);
const headers = { "User-Agent": "Mozilla/5.0 (compatible; Plannotator/1.0; +https://plannotator.ai)" };
try {
let currentUrl = url;
let res = await fetch(currentUrl, { headers, redirect: "manual", signal: controller.signal });
for (let i = 0; i < MAX_REDIRECTS && REDIRECT_STATUSES.has(res.status); i++) {
const location = res.headers.get("location");
if (!location) break;
currentUrl = new URL(location, currentUrl).href;
if (isLocalUrl(currentUrl)) {
throw new Error(`Redirect to private/local URL blocked: ${currentUrl}`);
}
res.body?.cancel();
res = await fetch(currentUrl, { headers, redirect: "manual", signal: controller.signal });
}
if (REDIRECT_STATUSES.has(res.status)) {
res.body?.cancel();
throw new Error("Too many redirects");
}
if (!res.ok) {
res.body?.cancel();
throw new Error(`HTTP ${res.status} ${res.statusText}`);
}
// If server returns HTML (e.g. GitHub's .md viewer), signal caller to
// fall through to Jina/Turndown instead of using raw content
const ct = res.headers.get("content-type") || "";
if (ct.includes("text/html") || ct.includes("application/xhtml+xml")) {
res.body?.cancel();
return null;
}
return await readBodyWithLimit(res);
} catch (err) {
if (err instanceof Error && err.name === "AbortError") {
throw new Error(`Timed out fetching ${url}`);
}
throw err;
} finally {
clearTimeout(timer);
}
}
/** Fetch via Jina Reader — returns markdown directly. */
async function fetchViaJina(url: string): Promise<string> {
// Strip fragment (never sent to server) and encode for Jina's path-based API
const cleanUrl = url.split("#")[0];
const jinaUrl = `https://r.jina.ai/${cleanUrl}`;
const headers: Record<string, string> = {
Accept: "text/plain",
};
const apiKey = process.env.JINA_API_KEY;
if (apiKey) {
headers.Authorization = `Bearer ${apiKey}`;
}
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS);
try {
const res = await fetch(jinaUrl, { headers, signal: controller.signal });
if (!res.ok) {
res.body?.cancel();
throw new Error(`HTTP ${res.status} ${res.statusText}`);
}
return await readBodyWithLimit(res);
} catch (err) {
if (err instanceof Error && err.name === "AbortError") {
throw new Error("timed out");
}
throw err;
} finally {
clearTimeout(timer);
}
}
const MAX_REDIRECTS = 10;
const REDIRECT_STATUSES = new Set([301, 302, 303, 307, 308]);
/** Fetch raw HTML and convert via Turndown. Follows redirects manually to validate each hop. */
async function fetchViaTurndown(url: string): Promise<string> {
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS);
const headers = {
"User-Agent":
"Mozilla/5.0 (compatible; Plannotator/1.0; +https://plannotator.ai)",
Accept: "text/html,application/xhtml+xml",
};
try {
let currentUrl = url;
let res = await fetch(currentUrl, { headers, redirect: "manual", signal: controller.signal });
for (let i = 0; i < MAX_REDIRECTS && REDIRECT_STATUSES.has(res.status); i++) {
const location = res.headers.get("location");
if (!location) break;
currentUrl = new URL(location, currentUrl).href;
if (isLocalUrl(currentUrl)) {
throw new Error(`Redirect to private/local URL blocked: ${currentUrl}`);
}
res.body?.cancel();
res = await fetch(currentUrl, { headers, redirect: "manual", signal: controller.signal });
}
if (REDIRECT_STATUSES.has(res.status)) {
res.body?.cancel();
throw new Error("Too many redirects");
}
if (!res.ok) {
res.body?.cancel();
throw new Error(`HTTP ${res.status} ${res.statusText}`);
}
const contentType = res.headers.get("content-type") || "";
if (
!contentType.includes("text/html") &&
!contentType.includes("application/xhtml+xml")
) {
res.body?.cancel();
throw new Error(
`Not an HTML page (content-type: ${contentType})`,
);
}
const html = await readBodyWithLimit(res);
return htmlToMarkdown(html);
} catch (err) {
if (err instanceof Error && err.name === "AbortError") {
throw new Error(`Timed out fetching ${url}`);
}
throw err;
} finally {
clearTimeout(timer);
}
}
+16 -1
View File
@@ -13,6 +13,7 @@
import React from 'react';
import { PlanDiffBadge } from './plan-diff/PlanDiffBadge';
import type { PlanDiffStats } from '../utils/planDiffEngine';
import { hostnameOrFallback } from '@plannotator/shared/project';
export interface DocBadgesProps {
layout: 'column' | 'row';
@@ -24,6 +25,8 @@ export interface DocBadgesProps {
showDemoBadge?: boolean;
archiveInfo?: { status: 'approved' | 'denied' | 'unknown'; timestamp: string; title: string } | null;
linkedDocInfo?: { filepath: string; onBack: () => void; label?: string; backLabel?: string } | null;
/** Source attribution for HTML/URL annotations (e.g. "https://..." or "index.html") */
sourceInfo?: string;
}
export const DocBadges: React.FC<DocBadgesProps> = ({
@@ -36,6 +39,7 @@ export const DocBadges: React.FC<DocBadgesProps> = ({
showDemoBadge,
archiveInfo,
linkedDocInfo,
sourceInfo,
}) => {
const isRow = layout === 'row';
@@ -44,7 +48,7 @@ export const DocBadges: React.FC<DocBadgesProps> = ({
// will truly produce visible output to avoid an empty wrapper div.
const anything = isRow
? (!linkedDocInfo && ((hasPreviousVersion && planDiffStats) || archiveInfo))
: repoInfo || hasPreviousVersion || showDemoBadge || linkedDocInfo || archiveInfo;
: repoInfo || hasPreviousVersion || showDemoBadge || linkedDocInfo || archiveInfo || sourceInfo;
if (!anything) return null;
// Row layout: single horizontal line. Column layout: stacked rows.
@@ -79,6 +83,17 @@ export const DocBadges: React.FC<DocBadgesProps> = ({
</div>
)}
{sourceInfo && !linkedDocInfo && !isRow && (
<span
className="px-1.5 py-0.5 bg-muted/30 rounded truncate max-w-[200px]"
title={sourceInfo}
>
{/^https?:\/\//i.test(sourceInfo)
? hostnameOrFallback(sourceInfo)
: sourceInfo}
</span>
)}
{onPlanDiffToggle && !linkedDocInfo && (
<PlanDiffBadge
stats={planDiffStats ?? null}
+31 -10
View File
@@ -77,6 +77,8 @@ interface ViewerProps {
*/
actionsLabelMode?: ActionsLabelMode;
archiveInfo?: { status: 'approved' | 'denied' | 'unknown'; timestamp: string; title: string } | null;
/** Source attribution for HTML/URL annotations (e.g. URL or filename) */
sourceInfo?: string;
// Checkbox toggle props
onToggleCheckbox?: (blockId: string, checked: boolean) => void;
checkboxOverrides?: Map<string, boolean>;
@@ -149,6 +151,7 @@ export const Viewer = forwardRef<ViewerHandle, ViewerProps>(({
copyLabel,
actionsLabelMode = 'full',
archiveInfo,
sourceInfo,
onToggleCheckbox,
checkboxOverrides,
}, ref) => {
@@ -449,7 +452,7 @@ export const Viewer = forwardRef<ViewerHandle, ViewerProps>(({
style={{ WebkitTouchCallout: 'none' } as React.CSSProperties}
>
{/* Repo info + plan diff badge + demo badge + linked doc badge + archive badge - top left */}
{(repoInfo || hasPreviousVersion || showDemoBadge || linkedDocInfo || archiveInfo) && (
{(repoInfo || hasPreviousVersion || showDemoBadge || linkedDocInfo || archiveInfo || sourceInfo) && (
<div data-print-hide className="absolute top-3 left-3 md:top-4 md:left-5">
<DocBadges
layout="column"
@@ -461,6 +464,7 @@ export const Viewer = forwardRef<ViewerHandle, ViewerProps>(({
showDemoBadge={showDemoBadge}
archiveInfo={archiveInfo}
linkedDocInfo={linkedDocInfo}
sourceInfo={sourceInfo}
/>
</div>
)}
@@ -729,6 +733,13 @@ const ImageLightbox: React.FC<{ src: string; alt: string; onClose: () => void }>
);
};
/** Block dangerous link protocols (javascript:, data:, vbscript:, file:). Returns null for blocked URLs. */
const DANGEROUS_PROTOCOL = /^\s*(javascript|data|vbscript|file)\s*:/i;
function sanitizeLinkUrl(url: string): string | null {
if (DANGEROUS_PROTOCOL.test(url)) return null;
return url;
}
/**
* Renders inline markdown: **bold**, *italic*, _italic_, `code`, [links](url)
*/
@@ -739,8 +750,8 @@ const InlineMarkdown: React.FC<{ text: string; onOpenLinkedDoc?: (path: string)
let previousChar = '';
while (remaining.length > 0) {
// Backslash escaping: \* \_ \` \[ \~ etc. — emit literal char, hide backslash
let match = remaining.match(/^\\([*_`\[\]~!\\])/);
// Backslash escaping: \. \* \_ \` \[ \~ etc. — emit literal char, hide backslash
let match = remaining.match(/^\\([\\*_`\[\]~!.()\-#>+|{}&])/);
if (match) {
parts.push(match[1]);
remaining = remaining.slice(2);
@@ -830,7 +841,7 @@ const InlineMarkdown: React.FC<{ text: string; onOpenLinkedDoc?: (path: string)
if (match) {
const target = match[1].trim();
const display = match[2]?.trim() || target;
const targetPath = /\.mdx?$/i.test(target) ? target : `${target}.md`;
const targetPath = /\.(mdx?|html?)$/i.test(target) ? target : `${target}.md`;
if (onOpenLinkedDoc) {
parts.push(
@@ -886,15 +897,25 @@ const InlineMarkdown: React.FC<{ text: string; onOpenLinkedDoc?: (path: string)
if (match) {
const linkText = match[1];
const linkUrl = match[2];
const isLocalMd = /\.md(x?)$/i.test(linkUrl) &&
const safeLinkUrl = sanitizeLinkUrl(linkUrl);
// Dangerous protocol stripped — render as plain text, not a dead link
if (safeLinkUrl === null) {
parts.push(<span key={key++}>{linkText}</span>);
remaining = remaining.slice(match[0].length);
previousChar = match[0][match[0].length - 1] || previousChar;
continue;
}
const isLocalDoc = /\.(mdx?|html?)$/i.test(linkUrl) &&
!linkUrl.startsWith('http://') &&
!linkUrl.startsWith('https://');
if (isLocalMd && onOpenLinkedDoc) {
if (isLocalDoc && onOpenLinkedDoc) {
parts.push(
<a
key={key++}
href={linkUrl}
href={safeLinkUrl}
onClick={(e) => {
e.preventDefault();
onOpenLinkedDoc(linkUrl);
@@ -908,12 +929,12 @@ const InlineMarkdown: React.FC<{ text: string; onOpenLinkedDoc?: (path: string)
</svg>
</a>
);
} else if (isLocalMd) {
} else if (isLocalDoc) {
// No handler — render as plain link (e.g., in shared/portal views)
parts.push(
<a
key={key++}
href={linkUrl}
href={safeLinkUrl}
className="text-primary underline underline-offset-2 hover:text-primary/80"
>
{linkText}
@@ -923,7 +944,7 @@ const InlineMarkdown: React.FC<{ text: string; onOpenLinkedDoc?: (path: string)
parts.push(
<a
key={key++}
href={linkUrl}
href={safeLinkUrl}
target="_blank"
rel="noopener noreferrer"
className="text-primary underline underline-offset-2 hover:text-primary/80"