@brett_lamy/docstream 0.5.7 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brett_lamy/docstream",
-  "version": "0.5.7",
+  "version": "0.6.0",
   "description": "GitBook-aware readonly markdown and AI stream renderer.",
   "publishConfig": {
     "access": "public"

package/src/docs/reference.tsx

@@ -1,5 +1,5 @@
 import { createContext, useContext, useId, useState, type ReactNode } from "react"
-import { ArrowUpRight, AtSign, Globe, Hash } from "lucide-react"
+import { ArrowUpRight, AtSign, FolderGit2, Globe, Hash } from "lucide-react"
 
 import type { CitationDef, ReferenceNode } from "../gitbook/ast"
 
@@ -112,7 +112,7 @@ export function InlineReference({ node }: { node: ReferenceNode }) {
     )
   }
 
-  const Icon = node.kind === "mention" ? AtSign : Hash
+  const Icon = node.kind === "mention" ? AtSign : node.kind === "codebase" ? FolderGit2 : Hash
   return (
     <button
       type="button"

package/src/gitbook/ast.ts

@@ -23,7 +23,7 @@ export interface InlineImageNode {
   link?: string
 }
 
-export type ReferenceKind = "mention" | "tag" | "citation"
+export type ReferenceKind = "mention" | "tag" | "codebase" | "citation"
 
 /**
  * Inline reference chip: `@mention`, `#tag`, or footnote-style citation `[^id]`.

package/src/gitbook/inline.ts

@@ -10,8 +10,13 @@ export const refDefinitions = new Map<string, string>()
 // parseMarkdown and consumed here to resolve [^id] markers.
 export const footnoteDefinitions = new Map<string, { url: string; label?: string }>()
 
-// @mention / #tag body: letter/underscore start, then word chars, dots, dashes.
+// @mention / #tag / $codebase body: letter/underscore start, then word chars, dots,
+// dashes. Codebase ids may also carry `/` (`$org/repo`). A letter start keeps prices
+// like $5 plain text.
 const REFERENCE_BODY_RE = /^[@#]([A-Za-z_][\w.-]*)/
+const CODEBASE_BODY_RE = /^\$([A-Za-z_][\w.\/-]*)/
+const SIGIL_KIND = { "@": "mention", "#": "tag", $: "codebase" } as const
+const KIND_SIGIL = { mention: "@", tag: "#", codebase: "$" } as const
 // Chips are only recognized at start-of-input or after whitespace/open brackets,
 // so brett@replay.io and C# stay plain text.
 const isReferenceBoundary = (prev: string | undefined) =>
@@ -131,14 +136,14 @@ export function parseInline(src: string, marks: Marks = {}): Inline[] {
       continue
     }
 
-    // @mention / #tag chips, only at a word boundary
-    if ((rest[0] === "@" || rest[0] === "#") && isReferenceBoundary(src[i - 1])) {
-      const m = rest.match(REFERENCE_BODY_RE)
+    // @mention / #tag / $codebase chips, only at a word boundary
+    if ((rest[0] === "@" || rest[0] === "#" || rest[0] === "$") && isReferenceBoundary(src[i - 1])) {
+      const m = rest.match(rest[0] === "$" ? CODEBASE_BODY_RE : REFERENCE_BODY_RE)
       if (m) {
-        const id = m[1].replace(/[.-]+$/, "")
+        const id = m[1].replace(/[./-]+$/, "")
         if (id) {
           flush()
-          out.push({ type: "reference", kind: rest[0] === "@" ? "mention" : "tag", id })
+          out.push({ type: "reference", kind: SIGIL_KIND[rest[0] as "@" | "#" | "$"], id })
           i += 1 + id.length
           continue
         }
@@ -200,14 +205,14 @@ export function parseInline(src: string, marks: Marks = {}): Inline[] {
 const escapeText = (t: string) =>
   t
     .replace(/([*_~`[\]\\])/g, "\\$1")
-    // Escape @/# only at a chip boundary so emails/C# survive untouched.
+    // Escape @/#/$ only at a chip boundary so emails/C#/$5 survive untouched.
     // Note: node-local — a boundary formed across adjacent inline nodes
     // (previous node ending in whitespace) is not caught; rare, accepted.
-    .replace(/(^|[\s([{])([@#])(?=[A-Za-z_])/g, "$1\\$2")
+    .replace(/(^|[\s([{])([@#$])(?=[A-Za-z_])/g, "$1\\$2")
 
 export function serializeReference(n: ReferenceNode): string {
   if (n.kind === "citation") return `[^${n.id}]`
-  return `${n.kind === "mention" ? "@" : "#"}${n.id}`
+  return `${KIND_SIGIL[n.kind]}${n.id}`
 }
 
 function serializeImage(n: InlineImageNode): string {

package/src/styles.css

@@ -1073,6 +1073,16 @@
   color: var(--gb-accent-foreground);
 }
 
+.docs-ref-codebase {
+  border: 1px solid rgba(34, 197, 94, 0.45);
+  background: rgba(34, 197, 94, 0.1);
+  color: rgb(74, 222, 128);
+}
+
+.docs-ref-codebase:hover {
+  background: rgba(34, 197, 94, 0.18);
+}
+
 .docs-cite-wrap {
   position: relative;
   display: inline-block;