vitepress-plugin-api-extractor 0.4.18 → 0.4.20

package/ApiExtractor.js

@@ -4,7 +4,7 @@ import { environmentHash, makeTwoslashTransformer } from "./Twoslash.js";
 import { TwoslashCacheStore } from "./TwoslashCache.js";
 import { Effect, Layer, ManagedRuntime } from "effect";
 
-//#region src/ApiExtractor.ts
+// src/ApiExtractor.ts
 const AppLive = Layer.mergeAll(PlatformLive, RegistryLive, TwoslashCacheStore.layer);
 /**
 * Generate the API pages and return what the site's config needs.
@@ -79,5 +79,4 @@ async function apiExtractor(options) {
 	};
 }
 
-//#endregion
 export { apiExtractor };

package/Categories.js

@@ -1,6 +1,6 @@
 import { ApiItemKind } from "@microsoft/api-extractor-model";
 
-//#region src/Categories.ts
+// src/Categories.ts
 /**
 * The default category set: one group per API item kind, with the folder,
 * singular name and sidebar presentation each carries.
@@ -45,5 +45,4 @@ function navCategory(config) {
 	};
 }
 
-//#endregion
 export { DEFAULT_CATEGORIES, navCategory };

package/Generate.js

@@ -11,7 +11,7 @@ import { buildIndexPage, buildNav, buildPage, prepareWorkItems, unscopedName } f
 import { attributionFacts, deriveScriptBody, deriveSiteUrl, headTags, packageContext } from "@tsdoctor/seo";
 import { resolveTypeScriptConfig } from "@tsdoctor/vfs";
 
-//#region src/Generate.ts
+// src/Generate.ts
 /**
 * The generation program: discover the bundle, load the model, build the
 * virtual file system and compiler options, lift every item into a
@@ -232,5 +232,4 @@ function decodeManifest(packageJson) {
 	return PackageManifest.decode(packageJson).pipe(Effect.map((manifest) => manifest), Effect.orElseSucceed(() => void 0));
 }
 
-//#endregion
 export { generate };

package/Registry.js

@@ -4,7 +4,7 @@ import { Cache } from "@effected/store";
 import { AppDirs, Xdg } from "@effected/xdg";
 import { PackageFetcher, PackageSpec, RegistryObserver, TypeCache, TypeRegistry } from "@tsdoctor/registry";
 
-//#region src/Registry.ts
+// src/Registry.ts
 /**
 * External type loading: the `@tsdoctor/registry` stack over the same XDG
 * cache the RSPress plugin uses, and the degrading merge of a documented
@@ -113,5 +113,4 @@ const loadExternalTypes = Effect.fn("Registry.loadExternalTypes")(function* (vfs
 	};
 });
 
-//#endregion
 export { AppDirsLive, PlatformLive, RegistryLive, TSDOCTOR_NAMESPACE, externalPackagesOf, loadExternalTypes };

package/Twoslash.js

@@ -2,7 +2,7 @@ import { DEFAULT_COMPILER_OPTIONS, toProgrammaticCompilerOptions, twoslashEnvHas
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 import ts from "typescript";
 
-//#region src/Twoslash.ts
+// src/Twoslash.ts
 /**
 * Fingerprint the type environment: the declarations plus the compiler that
 * interprets them, so a generation cached by one TypeScript is never served
@@ -39,5 +39,4 @@ function makeTwoslashTransformer(options) {
 	});
 }
 
-//#endregion
 export { environmentHash, makeTwoslashTransformer };

package/TwoslashCache.js

@@ -4,7 +4,7 @@ import { decodeTwoslashCache, encodeTwoslashCache, makeTwoslashCache, twoslashBl
 import { Cache } from "@effected/store";
 import { AppDirs } from "@effected/xdg";
 
-//#region src/TwoslashCache.ts
+// src/TwoslashCache.ts
 /**
 * Persistence for the Twoslash result cache: one gzipped generation per type
 * environment in a sqlite-backed `@effected/store` Cache under the XDG cache
@@ -98,5 +98,4 @@ const StoreLive = Layer.effect(TwoslashCacheStore, Effect.gen(function* () {
 	};
 })).pipe(Layer.provide(CacheLive));
 
-//#endregion
 export { TwoslashCacheStore };

package/emit/frontmatter.js

@@ -1,6 +1,6 @@
 import { emitFrontmatterBlock } from "@tsdoctor/model";
 
-//#region src/emit/frontmatter.ts
+// src/emit/frontmatter.ts
 /**
 * Frontmatter assembly for generated pages: the page title and description
 * plus the neutral `@tsdoctor/seo` head tags rendered into VitePress's
@@ -54,5 +54,4 @@ function emitFrontmatter(input) {
 	return emitFrontmatterBlock(data);
 }
 
-//#endregion
 export { emitFrontmatter, headConfig };

package/emit/markdown.js

@@ -1,7 +1,7 @@
 import { Result } from "effect";
 import { Blockquote, Code, Heading, InlineCode, Link, List, ListItem, Markdown, Paragraph, Root, Strong, Table, TableCell, TableRow, Text } from "@effected/markdown";
 
-//#region src/emit/markdown.ts
+// src/emit/markdown.ts
 /**
 * The fence info string that triggers Twoslash under VitePress's default
 * `explicitTrigger`.
@@ -195,5 +195,4 @@ function emitMarkdownBody(page) {
 	});
 }
 
-//#endregion
 export { TWOSLASH_META, emitMarkdownBody, markdownBlockTree, markdownTree };

package/emit/sidebar.js

@@ -1,4 +1,4 @@
-//#region src/emit/sidebar.ts
+// src/emit/sidebar.ts
 /** One category group as a collapsible sidebar section. */
 function sidebarGroup(group) {
 	const collapsible = group.category.collapsible ?? true;
@@ -33,5 +33,4 @@ function sidebarFor(tree) {
 	return { [`${tree.baseRoute}/`]: sidebarItems(tree) };
 }
 
-//#endregion
 export { sidebarFor, sidebarGroup, sidebarItems };

package/index.d.ts

@@ -9,7 +9,6 @@ import "@effected/xdg";
 import { HeadTag } from "@tsdoctor/seo";
 import { FlowContent, MarkdownStringifyError } from "@effected/markdown";
 import { TwoslashTypesCache } from "@shikijs/twoslash";
-//#region src/Categories.d.ts
 /**
  * A category as this adapter configures it: how items match it, where its
  * pages live, and how its sidebar group presents.
@@ -28,8 +27,6 @@ interface CategoryConfig extends WorkItemCategory {
  * @public
  */
 export declare const DEFAULT_CATEGORIES: Readonly<Record<string, CategoryConfig>>;
-//#endregion
-//#region src/emit/sidebar.d.ts
 /**
  * One VitePress sidebar item — the subset of the default theme's
  * `SidebarItem` this adapter emits. Arrays are mutable because VitePress's
@@ -68,8 +65,6 @@ export declare function sidebarItems(tree: NavTree): SidebarItem[];
  * @public
  */
 export declare function sidebarFor(tree: NavTree): SidebarMulti;
-//#endregion
-//#region src/Registry.d.ts
 /**
  * The XDG namespace every tsdoctor cache lives under — shared with the
  * RSPress plugin so both adapters read one type cache and one Twoslash
@@ -132,8 +127,6 @@ export declare const loadExternalTypes: (vfs: Vfs, packages: readonly ExternalPa
   loaded: string[];
   skipped: string[];
 }, never, TypeRegistry>;
-//#endregion
-//#region src/Generate.d.ts
 /**
  * The input to {@link generate}.
  *
@@ -250,8 +243,6 @@ export declare const generate: (input: GenerateInput) => Effect.Effect<{
  * @public
  */
 type GenerateServices = FileSystem.FileSystem | Path.Path | TypeRegistry;
-//#endregion
-//#region src/TwoslashCache.d.ts
 /**
  * The stats a persisted generation reports, with the environment it was
  * stored under.
@@ -301,8 +292,6 @@ export declare class TwoslashCacheStore extends TwoslashCacheStore_base {
   /** An always-cold in-memory store, for tests. */
   static readonly layerTest: Layer.Layer<TwoslashCacheStore>;
 }
-//#endregion
-//#region src/ApiExtractor.d.ts
 /**
  * The options {@link apiExtractor} takes.
  *
@@ -383,8 +372,6 @@ interface ApiExtractorResult {
  * @public
  */
 export declare function apiExtractor(options: ApiExtractorOptions): Promise<ApiExtractorResult>;
-//#endregion
-//#region src/emit/frontmatter.d.ts
 /**
  * One VitePress head entry: a pair for an attribute-only tag, a triple when
  * the tag carries inner HTML.
@@ -418,8 +405,6 @@ interface FrontmatterInput {
  * @public
  */
 export declare function emitFrontmatter(input: FrontmatterInput): string;
-//#endregion
-//#region src/emit/markdown.d.ts
 /**
  * The fence info string that triggers Twoslash under VitePress's default
  * `explicitTrigger`.
@@ -452,8 +437,6 @@ export declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
  * @public
  */
 export declare function emitMarkdownBody(page: Page): Result.Result<string, MarkdownStringifyError>;
-//#endregion
-//#region src/Twoslash.d.ts
 /**
  * Everything one Twoslash transformer needs.
  *
@@ -487,6 +470,5 @@ export declare function environmentHash(vfs: Vfs): string;
  * @public
  */
 export declare function makeTwoslashTransformer(options: TwoslashTransformerOptions): ShikiTransformer;
-//#endregion
 export type { ApiExtractorOptions, ApiExtractorResult, CategoryConfig, ExternalPackage, ExternalTypesReport, FrontmatterInput, GenerateInput, GenerateResult, GenerateServices, HeadConfig, SidebarItem, SidebarMulti, TwoslashCacheReport, TwoslashCacheStoreShape, TwoslashTransformerOptions };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vitepress-plugin-api-extractor",
-	"version": "0.4.18",
+	"version": "0.4.20",
 	"private": false,
 	"description": "VitePress adapter for generating API documentation from TypeScript API Extractor models: markdown pages over the @tsdoctor/pages IR, a sidebar from its navigation tree, and Twoslash type-checking over the same virtual file system the RSPress plugin resolves.",
 	"keywords": [
@@ -37,33 +37,33 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@effect/platform-node": "^4.0.5",
-		"@effected/github": "^0.21.0",
-		"@effected/glob": "^0.13.0",
-		"@effected/images": "^0.4.0",
-		"@effected/jsonc": "^0.18.0",
-		"@effected/markdown": "^0.19.0",
-		"@effected/npm": "^0.23.0",
-		"@effected/package-json": "^0.23.0",
-		"@effected/schema-org": "^0.10.0",
-		"@effected/semver": "^0.14.0",
-		"@effected/spdx": "^0.15.0",
-		"@effected/store": "^0.16.0",
-		"@effected/tsconfig-json": "^0.16.0",
-		"@effected/walker": "^0.18.0",
-		"@effected/xdg": "^0.12.0",
-		"@effected/yaml": "^0.22.0",
+		"@effect/platform-node": "^4.0.6",
+		"@effected/github": "^0.24.0",
+		"@effected/glob": "^0.14.0",
+		"@effected/images": "^0.6.1",
+		"@effected/jsonc": "^0.20.0",
+		"@effected/markdown": "^0.22.0",
+		"@effected/npm": "^0.26.1",
+		"@effected/package-json": "^0.25.1",
+		"@effected/schema-org": "^0.11.0",
+		"@effected/semver": "^0.17.0",
+		"@effected/spdx": "^0.16.0",
+		"@effected/store": "^0.18.0",
+		"@effected/tsconfig-json": "^0.17.1",
+		"@effected/walker": "^0.19.0",
+		"@effected/xdg": "^0.14.1",
+		"@effected/yaml": "^0.25.0",
 		"@microsoft/api-extractor-model": "7.33.12",
 		"@shikijs/twoslash": "^4.5.0",
 		"@shikijs/vitepress-twoslash": "^4.4.3",
-		"@tsdoctor/bundle": "0.6.5",
-		"@tsdoctor/manifest": "0.2.9",
-		"@tsdoctor/model": "0.8.11",
-		"@tsdoctor/pages": "0.3.12",
-		"@tsdoctor/registry": "0.5.9",
-		"@tsdoctor/seo": "0.4.9",
-		"@tsdoctor/vfs": "0.4.7",
-		"effect": "^4.0.5",
+		"@tsdoctor/bundle": "0.6.7",
+		"@tsdoctor/manifest": "0.2.10",
+		"@tsdoctor/model": "0.8.13",
+		"@tsdoctor/pages": "0.3.14",
+		"@tsdoctor/registry": "0.5.11",
+		"@tsdoctor/seo": "0.4.11",
+		"@tsdoctor/vfs": "0.4.8",
+		"effect": "^4.0.6",
 		"shiki": "^4.5.0",
 		"typescript": "^6.0.3"
 	},