@tooee/view 0.7.3 → 0.9.0

package/src/markdown-links.ts

@@ -0,0 +1,88 @@
+import { statSync } from "node:fs";
+import nodePath from "node:path";
+import { fileURLToPath } from "node:url";
+import { Lexer } from "marked";
+import type { Token, Tokens } from "marked";
+
+export type LinkResolution =
+  | { status: "file"; path: string }
+  | { status: "missing"; path: string }
+  | { status: "directory"; path: string }
+  | { status: "unsupported" };
+
+/** Existing local files only. Fragments are validated, then open at the file top. */
+export const resolveMarkdownLink = function resolveMarkdownLink(
+  href: string,
+  baseDir: string,
+  currentPath?: string,
+): LinkResolution {
+  try {
+    const decoded = decodeURIComponent(href);
+    if (/[\p{Cc}\\]/u.test(decoded)) {
+      return { status: "unsupported" };
+    }
+    const target = href.trim();
+    if (!target || target.startsWith("//")) {
+      return { status: "unsupported" };
+    }
+    const [rawPath] = target.split("#", 1);
+    if (rawPath.includes("?")) {
+      return { status: "unsupported" };
+    }
+    let path: string;
+    if (/^[a-zA-Z][a-zA-Z\d+.-]*:/u.test(rawPath)) {
+      // Check the authority before URL normalizes localhost into an empty host.
+      if (!/^file:\/\/\//iu.test(rawPath)) {
+        return { status: "unsupported" };
+      }
+      const url = new URL(rawPath);
+      if (url.hostname || url.search) {
+        return { status: "unsupported" };
+      }
+      path = fileURLToPath(url);
+    } else {
+      path = rawPath
+        ? nodePath.resolve(baseDir, decodeURIComponent(rawPath))
+        : (currentPath ?? baseDir);
+    }
+    const absolute = nodePath.resolve(path);
+    try {
+      const stat = statSync(absolute);
+      if (stat.isFile()) {
+        return { path: absolute, status: "file" };
+      }
+      return stat.isDirectory()
+        ? { path: absolute, status: "directory" }
+        : { status: "unsupported" };
+    } catch {
+      return { path: absolute, status: "missing" };
+    }
+  } catch {
+    return { status: "unsupported" };
+  }
+};
+
+export interface MarkdownLink {
+  /** Link text as written in the source. */
+  text: string;
+  href: string;
+}
+
+/** Ordinary inline links in source order, skipping images and code spans. */
+const collect = (tokens: Token[], links: MarkdownLink[]): void => {
+  for (const token of tokens) {
+    if (token.type === "link" && "href" in token) {
+      // SAFETY: Marked's Generic token prevents discriminator narrowing.
+      // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- checked Marked link discriminator
+      const { href, text } = token as Tokens.Link;
+      links.push({ href, text });
+    } else if (["strong", "em", "del"].includes(token.type) && "tokens" in token && token.tokens) {
+      collect(token.tokens, links);
+    }
+  }
+};
+export const markdownLinks = function markdownLinks(line: string): MarkdownLink[] {
+  const links: MarkdownLink[] = [];
+  collect(Lexer.lexInline(line), links);
+  return links;
+};

package/src/standalone-router.tsx

@@ -0,0 +1,122 @@
+/* oxlint-disable no-use-before-define -- the screen closes over the route initialized before router startup */
+import { useMemo } from "react";
+import type { ReactNode } from "react";
+import { useChooseDialog } from "@tooee/choose";
+import { useCommand } from "@tooee/commands";
+import type { CommandContext } from "@tooee/commands";
+import {
+  createRoute,
+  createRouter,
+  useNavigate,
+  useParams,
+  useRouter,
+  useRouterCommands,
+} from "@tooee/router";
+import type { Codec, RouteDefinition, RouterInstance } from "@tooee/router";
+import path from "node:path";
+import { createFileProvider } from "./default-provider.js";
+import { runLinkHandlers } from "./link-handlers.js";
+import { markdownLinks } from "./markdown-links.js";
+import type { MarkdownLink } from "./markdown-links.js";
+import { getTextContent } from "./types.js";
+import type { ViewLaunchOptions } from "./launch.js";
+import { View } from "./view.js";
+
+const documentParams: Codec<{ path?: string }> = {
+  parse: (value) => {
+    /* oxlint-disable anti-slop/no-runtime-typeof -- route params are decoded at this boundary */
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+      throw new TypeError("Expected document params");
+    }
+    if (!("path" in value) || value.path === undefined) {
+      return {};
+    }
+    if (typeof value.path !== "string" || !path.isAbsolute(value.path)) {
+      throw new TypeError("Expected an absolute document path");
+    }
+    /* oxlint-enable anti-slop/no-runtime-typeof */
+    return { path: value.path };
+  },
+};
+
+interface StandaloneRouter {
+  documentRoute: RouteDefinition<{ path?: string }>;
+  router: RouterInstance;
+}
+
+export const createStandaloneRouter = function createStandaloneRouter(
+  options: ViewLaunchOptions,
+): StandaloneRouter {
+  const DocumentScreen = function DocumentScreen(): ReactNode {
+    useRouterCommands();
+    const { path: documentPath } = useParams(documentRoute);
+    const navigate = useNavigate();
+    const { stack } = useRouter();
+    const chooseLink = useChooseDialog<MarkdownLink>();
+    const provider = useMemo(
+      () =>
+        documentPath === undefined ? options.contentProvider : createFileProvider(documentPath),
+      [documentPath],
+    );
+    const activate = (href: string, command: CommandContext): boolean => {
+      if (options.filePath === undefined) {
+        command.toast?.toast({ level: "info", message: "Links need a source file" });
+        return true;
+      }
+      const currentPath = path.resolve(documentPath ?? options.filePath);
+      return runLinkHandlers(
+        options.linkHandlers ?? [],
+        { baseDir: path.dirname(currentPath), currentPath, href },
+        { command, documentRoute, navigate },
+      );
+    };
+    useCommand({
+      handler: async (context) => {
+        // Source positions are zero-based, unlike the displayed line numbers.
+        const line = context.document?.activeAnchor?.source?.primary?.start.line;
+        const content = context.view?.content;
+        if (line === undefined || content === undefined) {
+          return;
+        }
+        const links = markdownLinks(getTextContent(content).split("\n")[line] ?? "");
+        // One link follows directly; several open a chooser so none is silently preferred.
+        const link =
+          links.length > 1
+            ? await chooseLink.open({
+                items: links,
+                prompt: "Follow link",
+                toItem: (item) => ({ description: item.href, text: item.text }),
+              })
+            : (links[0] ?? null);
+        if (link !== null) {
+          activate(link.href, context);
+        }
+      },
+      hotkey: "enter",
+      id: "view.follow-link",
+      modes: ["cursor"],
+      title: "Follow Markdown link",
+      when: (context) => context.view?.format === "markdown",
+    });
+    return (
+      <View
+        key={`${stack.length}:${documentPath ?? ""}`}
+        actions={options.actions}
+        codeBlockRenderers={options.codeBlockRenderers}
+        contentProvider={provider}
+        onMarkdownLinkActivate={activate}
+        renderers={options.renderers}
+      />
+    );
+  };
+  const documentRoute = createRoute({
+    component: DocumentScreen,
+    id: "view.document",
+    params: documentParams,
+  });
+  const router = createRouter({
+    initial: { routeId: documentRoute.id },
+    routes: [documentRoute],
+  });
+  return { documentRoute, router };
+};

package/src/types.ts

@@ -1,6 +1,7 @@
 import type { ReactNode } from "react";
 import type { ImageFit, ImageRenderProtocol, ImageSource } from "@opentui/core";
 import type { CommandContext } from "@tooee/commands";
+import { formatTableCell } from "@tooee/renderers";
 import type { ColumnDef, SourceLineRow, TableRow } from "@tooee/renderers";
 import type { DocumentController } from "@tooee/shell";
 import type { MarkSet } from "@tooee/marks";
@@ -18,6 +19,7 @@ export type Content =
 export type ContentFormat = Content["format"];
 
 /** Handles an inline Markdown link with the View's live command context. */
+// oxlint-disable-next-line anti-slop/no-unknown-returns -- public callback contract preserves the renderer's exact-true link-consumption result and permits legacy return values
 export type MarkdownLinkActivateHandler = (href: string, context: CommandContext) => unknown;
 
 interface BaseContent {
@@ -152,40 +154,6 @@ export const isCustomContent = function isCustomContent(
   return !BUILTIN_FORMATS.has(content.format);
 };
 
-const stringifyCell = function stringifyCell(value: unknown): string {
-  if (value === null || value === undefined) {
-    return "";
-  }
-  if (typeof value === "string") {
-    return value;
-  }
-  if (typeof value === "number" || typeof value === "boolean") {
-    return String(value);
-  }
-  if (typeof value === "string") {
-    return value;
-  }
-  if (
-    typeof value === "number" ||
-    typeof value === "bigint" ||
-    typeof value === "boolean" ||
-    typeof value === "symbol"
-  ) {
-    return value.toString();
-  }
-  if (value === null || value === undefined) {
-    return String(value);
-  }
-  if (typeof value === "function") {
-    return Function.prototype.toString.call(value);
-  }
-  try {
-    return JSON.stringify(value);
-  } catch {
-    return Array.isArray(value) ? value.join(",") : Object.prototype.toString.call(value);
-  }
-};
-
 export const getTextContent = function getTextContent(content: AnyContent): string {
   if (content.getTextContent) {
     return content.getTextContent();
@@ -209,6 +177,7 @@ export const getTextContent = function getTextContent(content: AnyContent): stri
       return content.text;
     }
     case "image": {
+      // oxlint-disable-next-line anti-slop/no-runtime-typeof -- ImageSource is OpenTUI's public string-or-binary union; only its string and URL variants have text content
       if (typeof content.src === "string") {
         return content.src;
       }
@@ -217,7 +186,7 @@ export const getTextContent = function getTextContent(content: AnyContent): stri
     case "table": {
       const headers = content.columns.map((column) => column.header ?? column.key);
       const rowLines = content.rows.map((row) =>
-        content.columns.map((column) => stringifyCell(row[column.key])).join("\t"),
+        content.columns.map((column) => formatTableCell(row[column.key])).join("\t"),
       );
       return [headers.join("\t"), ...rowLines].join("\n");
     }

package/src/view.tsx

@@ -16,6 +16,7 @@ import {
   DiffSubview,
   CustomSubview,
 } from "./components/subviews/index.js";
+import type { ReactNode } from "react";
 
 interface ViewProps {
   contentProvider: ContentProvider;
@@ -36,7 +37,7 @@ export const View = function View({
   renderers,
   codeBlockRenderers,
   onMarkdownLinkActivate,
-}: ViewProps): React.ReactNode {
+}: ViewProps): ReactNode {
   const { theme } = useTheme();
   const { content, streaming, error, providerMarks, reload } = useContentLoader(contentProvider);
 

package/dist/hooks/index.d.ts

@@ -1,5 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export { createViewCommandContext, useProvideViewCommandContext, } from "./use-view-command-context.js";
-export type { CreateViewCommandContextOptions, ProvideViewCommandContextOptions, ViewCommandContext, } from "./use-view-command-context.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,+BAA+B,EAC/B,gCAAgC,EAChC,kBAAkB,GACnB,MAAM,+BAA+B,CAAC"}

package/dist/hooks/index.js

@@ -1,4 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export { createViewCommandContext, useProvideViewCommandContext, } from "./use-view-command-context.js";
-//# sourceMappingURL=index.js.map

package/dist/hooks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC"}

package/src/hooks/index.ts

@@ -1,11 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export {
-  createViewCommandContext,
-  useProvideViewCommandContext,
-} from "./use-view-command-context.js";
-export type {
-  CreateViewCommandContextOptions,
-  ProvideViewCommandContextOptions,
-  ViewCommandContext,
-} from "./use-view-command-context.js";