rspress-plugin-api-extractor 0.13.2 → 0.14.0

package/shiki-transformer.js

@@ -33,7 +33,7 @@
 * @example Basic usage
 * ```ts
 * const crossLinker = new ShikiCrossLinker();
-* crossLinker.reinitialize(routes, kinds, "my-api");
+* const crossLinker = ShikiCrossLinker.fromRoutes(routes, "my-api");
 * crossLinker.setApiScope("my-api");
 *
 * // Cross-link the finalized HAST, after Shiki and Twoslash have run
@@ -46,16 +46,13 @@
 var ShikiCrossLinker = class ShikiCrossLinker {
 	/** API item name to route, for THIS scope. */
 	apiItemRoutes;
-	/** API item name to kind (Class, Interface, …), for THIS scope. */
-	apiItemKinds;
 	/** Parent name to its member names, longest first, for THIS scope. */
 	classMembersMap;
 	/** The scope this linker links for. Read-only after construction. */
 	apiScope;
-	constructor(apiScope, apiItemRoutes, apiItemKinds, classMembersMap) {
+	constructor(apiScope, apiItemRoutes, classMembersMap) {
 		this.apiScope = apiScope;
 		this.apiItemRoutes = apiItemRoutes;
-		this.apiItemKinds = apiItemKinds;
 		this.classMembersMap = classMembersMap;
 	}
 	/**
@@ -74,7 +71,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	* property of the instance, which cannot be pointed at another package's
 	* routes at all.
 	*/
-	static fromRoutes(routes, kinds, apiScope) {
+	static fromRoutes(routes, apiScope) {
 		const classMembersMap = /* @__PURE__ */ new Map();
 		for (const [name] of routes.entries()) {
 			const dotIndex = name.indexOf(".");
@@ -86,10 +83,10 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 			else if (!members.includes(memberName)) members.push(memberName);
 		}
 		for (const members of classMembersMap.values()) members.sort((a, b) => b.length - a.length);
-		return new ShikiCrossLinker(apiScope, new Map(routes), new Map(kinds), classMembersMap);
+		return new ShikiCrossLinker(apiScope, new Map(routes), classMembersMap);
 	}
 	/** A linker that links nothing — for a scope with no documented routes. */
-	static empty = new ShikiCrossLinker("", /* @__PURE__ */ new Map(), /* @__PURE__ */ new Map(), /* @__PURE__ */ new Map());
+	static empty = new ShikiCrossLinker("", /* @__PURE__ */ new Map(), /* @__PURE__ */ new Map());
 	/**
 	* Transform a finalized HAST tree to add cross-links to type references.
 	*
@@ -118,7 +115,6 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	}
 	transformRoot(node) {
 		const apiItemRoutes = this.apiItemRoutes;
-		const apiItemKinds = this.apiItemKinds;
 		const classMembersMap = this.classMembersMap;
 		const scopeStack = [];
 		const preElement = node.children.find((child) => child.type === "element" && child.tagName === "pre");
@@ -148,12 +144,9 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 						const fullMemberName = `${currentScope}.${content}`;
 						const memberRoute = apiItemRoutes.get(fullMemberName);
 						if (memberRoute) {
-							const memberKind = apiItemKinds.get(fullMemberName);
-							const memberSemanticClass = memberKind ? this.getSemanticClass(memberKind) : null;
 							const leadingSpace = rawContent.match(/^\s*/)?.[0] || "";
 							const trailingSpace = rawContent.match(/\s*$/)?.[0] || "";
 							const classNames = ["api-type-link"];
-							if (memberSemanticClass) classNames.push(memberSemanticClass);
 							const newChildren = [];
 							if (leadingSpace) newChildren.push({
 								type: "text",
@@ -209,10 +202,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 			const fullMemberName = `${className}.${methodName}`;
 			const memberRoute = apiItemRoutes.get(fullMemberName);
 			if (!memberRoute) continue;
-			const memberKind = apiItemKinds.get(fullMemberName);
-			const memberSemanticClass = memberKind ? this.getSemanticClass(memberKind) : null;
 			const memberClassNames = ["api-type-link"];
-			if (memberSemanticClass) memberClassNames.push(memberSemanticClass);
 			const textContent = this.extractTextFromTwoslash(twoslashSpan);
 			if (!textContent) continue;
 			this.wrapTwoslashTextInAnchor(twoslashSpan, textContent.trim(), memberRoute, memberClassNames);
@@ -230,11 +220,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 				const content = text.trim();
 				const route = apiItemRoutes.get(content);
 				if (!route) continue;
-				const kind = apiItemKinds.get(content);
-				const semanticClass = kind ? this.getSemanticClass(kind) : null;
-				const classNames = ["api-type-link"];
-				if (semanticClass) classNames.push(semanticClass);
-				this.wrapTwoslashTextInAnchor(twoslashSpan, content, route, classNames);
+				this.wrapTwoslashTextInAnchor(twoslashSpan, content, route, ["api-type-link"]);
 				twoslashSpan.properties = {
 					...twoslashSpan.properties,
 					"data-api-processed": "true"
@@ -244,7 +230,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 			const typePattern = new RegExp(`\\b(${escapedNames.join("|")})\\b`, "g");
 			for (const lineElement of codeElement.children) {
 				if (lineElement.type !== "element" || lineElement.tagName !== "span") continue;
-				this.linkTypeReferencesInLine(lineElement, typePattern, apiItemRoutes, apiItemKinds);
+				this.linkTypeReferencesInLine(lineElement, typePattern, apiItemRoutes);
 			}
 		}
 		return node;
@@ -254,7 +240,6 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	*/
 	transformLine(node) {
 		const apiItemRoutes = this.apiItemRoutes;
-		const apiItemKinds = this.apiItemKinds;
 		const classMembersMap = this.classMembersMap;
 		if (!node.children) return;
 		for (let i = 0; i < node.children.length; i++) {
@@ -290,10 +275,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 			const fullMemberName = `${trimmedContent}.${matchedMember}`;
 			const memberRoute = apiItemRoutes.get(fullMemberName);
 			if (!memberRoute) continue;
-			const memberKind = apiItemKinds.get(fullMemberName);
-			const memberSemanticClass = memberKind ? this.getSemanticClass(memberKind) : null;
 			const memberClassNames = ["api-type-link"];
-			if (memberSemanticClass) memberClassNames.push(memberSemanticClass);
 			if (methodSpan.properties?.class && String(methodSpan.properties.class).includes("twoslash-hover")) this.wrapTwoslashTextInAnchor(methodSpan, methodText.trim(), memberRoute, memberClassNames);
 			else {
 				const textNode = methodSpan.children.find((c) => c.type === "text");
@@ -341,7 +323,6 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	*/
 	transformSpan(node, _line, _col) {
 		const apiItemRoutes = this.apiItemRoutes;
-		const apiItemKinds = this.apiItemKinds;
 		if (node.properties?.["data-api-processed"] === "true") return;
 		const firstChild = node.children?.[0];
 		if (firstChild && firstChild.type === "element" && firstChild.tagName === "a") return;
@@ -352,11 +333,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 			if (!content) return;
 			const route = apiItemRoutes.get(content);
 			if (route) {
-				const kind = apiItemKinds.get(content);
-				const semanticClass = kind ? this.getSemanticClass(kind) : null;
-				const classNames = ["api-type-link", "rp-link"];
-				if (semanticClass) classNames.push(semanticClass);
-				this.wrapTwoslashTextInAnchor(firstChild, content, route, classNames);
+				this.wrapTwoslashTextInAnchor(firstChild, content, route, ["api-type-link", "rp-link"]);
 				node.properties = {
 					...node.properties,
 					"data-api-processed": "true"
@@ -371,12 +348,9 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 		if (!content) return;
 		const route = apiItemRoutes.get(content);
 		if (route) {
-			const kind = apiItemKinds.get(content);
-			const semanticClass = kind ? this.getSemanticClass(kind) : null;
 			const leadingSpace = rawContent.match(/^\s*/)?.[0] || "";
 			const trailingSpace = rawContent.match(/\s*$/)?.[0] || "";
 			const classNames = ["api-type-link", "rp-link"];
-			if (semanticClass) classNames.push(semanticClass);
 			const newChildren = [];
 			if (leadingSpace) newChildren.push({
 				type: "text",
@@ -470,7 +444,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	* Iterates child spans, skipping already-processed and Twoslash-containing spans,
 	* and splits text nodes at type name boundaries.
 	*/
-	linkTypeReferencesInLine(lineElement, typePattern, apiItemRoutes, apiItemKinds) {
+	linkTypeReferencesInLine(lineElement, typePattern, apiItemRoutes) {
 		for (const child of lineElement.children) {
 			if (child.type !== "element" || child.tagName !== "span") continue;
 			if (child.properties?.["data-api-processed"] === "true") continue;
@@ -482,7 +456,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 					newChildren.push(textChild);
 					continue;
 				}
-				const fragments = this.splitTextAtTypeReferences(textChild.value, typePattern, apiItemRoutes, apiItemKinds);
+				const fragments = this.splitTextAtTypeReferences(textChild.value, typePattern, apiItemRoutes);
 				if (fragments.length === 1 && fragments[0].type === "text") newChildren.push(textChild);
 				else {
 					newChildren.push(...fragments);
@@ -502,7 +476,7 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 	* Split a text string at type reference boundaries, returning an array of
 	* text nodes and anchor elements for matched type names.
 	*/
-	splitTextAtTypeReferences(text, typePattern, apiItemRoutes, apiItemKinds) {
+	splitTextAtTypeReferences(text, typePattern, apiItemRoutes) {
 		typePattern.lastIndex = 0;
 		const result = [];
 		let lastIndex = 0;
@@ -514,16 +488,12 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 				type: "text",
 				value: text.slice(lastIndex, match.index)
 			});
-			const kind = apiItemKinds.get(matchedName);
-			const semanticClass = kind ? this.getSemanticClass(kind) : null;
-			const classNames = ["api-type-link"];
-			if (semanticClass) classNames.push(semanticClass);
 			result.push({
 				type: "element",
 				tagName: "a",
 				properties: {
 					href: route,
-					class: classNames.join(" ")
+					class: ["api-type-link"].join(" ")
 				},
 				children: [{
 					type: "text",
@@ -542,15 +512,6 @@ var ShikiCrossLinker = class ShikiCrossLinker {
 		});
 		return result;
 	}
-	/**
-	* Get the semantic CSS class name for an API item kind.
-	*
-	* @deprecated Semantic token colors are now handled by Shiki's theme CSS variables.
-	* This method always returns null - only api-type-link is used for underline styling.
-	*/
-	getSemanticClass(_kind) {
-		return null;
-	}
 };
 
 //#endregion

package/twoslash-transformer.js

@@ -1,10 +1,9 @@
 import { PluginEvent } from "./observability/events.js";
 import { emitSync, syncBuildId } from "./observability/sync-emitter.js";
-import { DEFAULT_COMPILER_OPTIONS } from "./typescript-config.js";
 import { Result } from "effect";
 import { Markdown, Mdast } from "@effected/markdown";
-import { TsEnumCodec } from "@effected/tsconfig-json";
 import { rendererRich, transformerTwoslash } from "@shikijs/twoslash";
+import { DEFAULT_COMPILER_OPTIONS, toProgrammaticCompilerOptions } from "@tsdoctor/vfs";
 import { toHast } from "mdast-util-to-hast";
 
 //#region src/twoslash-transformer.ts
@@ -181,47 +180,6 @@ function renderMarkdownInline(markdown, context) {
 	}];
 }
 /**
-* Singleton manager for the Twoslash transformer, enabling type-aware documentation.
-*
-* The TwoslashManager initializes and manages a Shiki transformer that provides
-* TypeScript IntelliSense features (hover types, error highlighting, completions)
-* in documentation code blocks. It uses a virtual file system (VFS) to provide
-* type definitions without requiring actual file system access.
-*
-* **How it works:**
-* 1. Plugin initializes the manager with a VFS containing all package type definitions
-* 2. Code blocks marked with `twoslash` are processed by the transformer
-* 3. TypeScript language services provide hover information and error checking
-* 4. Results are rendered as HTML with interactive hover popups
-*
-* **VFS Integration:**
-* The VFS is populated by {@link TypeRegistryService} with:
-* - The documented package's own type definitions (from API Extractor)
-* - External package types (fetched via @tsdoctor/registry)
-*
-* **Error Handling:**
-* TypeScript errors in code blocks are captured (not thrown) and:
-* - Counted via Effect Metric (BuildMetrics.twoslashErrors)
-* - Logged inline via console.error
-* - Displayed in the rendered output as error annotations
-*
-* **Relationships:**
-* - Initialized by {@link ApiExtractorPlugin} in the beforeBuild hook
-* - Receives VFS from {@link TypeRegistryService}
-* - The transformer is used by page generators for rendering code blocks
-*
-* @example
-* ```ts
-* const manager = TwoslashManager.getInstance();
-* manager.initialize(vfs, undefined, logger);
-*
-* const transformer = manager.getTransformer();
-* // Use transformer with Shiki highlighter
-* ```
-*
-* @see {@link TypeRegistryService} for VFS generation
-*/
-/**
 * Fingerprint a compiler configuration so environments can be deduped and code
 * blocks routed to the right one. Keys are sorted, so two configurations that
 * differ only in property order share an environment.
@@ -244,9 +202,6 @@ function renderMarkdownInline(markdown, context) {
 * environment, not the raw default), so a synthetic test compiling each
 * resolution path through the real compiler is the only verification there is.
 */
-function toProgrammaticCompilerOptions(options) {
-	return TsEnumCodec.encodeCompilerOptions(options);
-}
 /**
 * Fingerprint a compiler configuration, for keying the environment map.
 *
@@ -463,4 +418,4 @@ function clearTypeRoutes() {
 }
 
 //#endregion
-export { TwoslashEnvironmentRegistry, addTypeRoutes, clearTypeRoutes, toProgrammaticCompilerOptions };
+export { TwoslashEnvironmentRegistry, addTypeRoutes, clearTypeRoutes };