rspress-plugin-api-extractor 0.18.8 → 0.18.9

package/config-helpers.js

@@ -1,11 +1,20 @@
-import { SyncDiscoveryLayer } from "./sync-node-fs.js";
-import fsSync from "node:fs";
+import fs from "node:fs";
 import path from "node:path";
 import { normalizeBaseRoute } from "@tsdoctor/pages";
-import { Effect, Result } from "effect";
+import { Effect, Layer, Path, Result } from "effect";
+import { NodeSyncFileSystem } from "@effected/memfs/node-sync";
 import { discoverBundle } from "@tsdoctor/bundle";
 
 //#region src/config-helpers.ts
+/**
+* The sync environment bundle discovery runs under from the config helpers:
+* `@effected/memfs`'s read-only synchronous `FileSystem` over `node:fs` plus
+* the (already sync) `Path` service. `@effect/platform-node`'s
+* `NodeFileSystem` is promise-backed, so it cannot serve `Effect.runSync`;
+* `NodeSyncFileSystem` matches its errors tag-for-tag and makes every write
+* member a defect, so a new discovery dependency on a write fails loudly.
+*/
+const SyncDiscoveryLayer = Layer.mergeAll(NodeSyncFileSystem.layer, Path.layer);
 const PREFIX = "[rspress-plugin-api-extractor]";
 /**
 * The adapter's strictness gate over `@tsdoctor/bundle`'s layer-0-only
@@ -18,14 +27,14 @@ const PREFIX = "[rspress-plugin-api-extractor]";
 function requirePackageJson(dir) {
 	let stat;
 	try {
-		stat = fsSync.statSync(dir);
+		stat = fs.statSync(dir);
 	} catch {
 		throw new Error(`${PREFIX} api.fromDir: directory not found: ${dir}`);
 	}
 	if (!stat.isDirectory()) throw new Error(`${PREFIX} api.fromDir: not a directory: ${dir}`);
 	let pkg;
 	try {
-		pkg = JSON.parse(fsSync.readFileSync(path.join(dir, "package.json"), "utf8"));
+		pkg = JSON.parse(fs.readFileSync(path.join(dir, "package.json"), "utf8"));
 	} catch {
 		throw new Error(`${PREFIX} api.fromDir: missing or unreadable package.json in ${dir}`);
 	}
@@ -36,8 +45,8 @@ function requirePackageJson(dir) {
 	};
 }
 /**
-* Run `@tsdoctor/bundle`'s `discoverBundle` synchronously (over the sync
-* `FileSystem` bridge — see `sync-node-fs.ts`) and translate its typed
+* Run `@tsdoctor/bundle`'s `discoverBundle` synchronously (over
+* `SyncDiscoveryLayer` above) and translate its typed
 * failures into the plugin's historical error messages.
 */
 function discoverDescriptor(dir, name, version) {
@@ -103,9 +112,9 @@ function fromDir(dir, overrides = {}) {
 	};
 }
 function isModelFolder(dir) {
-	if (!fsSync.existsSync(path.join(dir, "package.json"))) return false;
+	if (!fs.existsSync(path.join(dir, "package.json"))) return false;
 	try {
-		return fsSync.readdirSync(dir).some((f) => f.endsWith(".api.json"));
+		return fs.readdirSync(dir).some((f) => f.endsWith(".api.json"));
 	} catch {
 		return false;
 	}
@@ -124,12 +133,12 @@ function fromParentDir(parentDir, options = {}) {
 	const absParent = path.resolve(cwd ?? process.cwd(), parentDir);
 	let stat;
 	try {
-		stat = fsSync.statSync(absParent);
+		stat = fs.statSync(absParent);
 	} catch {
 		throw new Error(`${PREFIX} apis.fromDir: directory not found: ${absParent}`);
 	}
 	if (!stat.isDirectory()) throw new Error(`${PREFIX} apis.fromDir: not a directory: ${absParent}`);
-	const subdirs = fsSync.readdirSync(absParent, { withFileTypes: true }).filter((e) => e.isDirectory() && !e.name.startsWith(".")).map((e) => e.name).sort();
+	const subdirs = fs.readdirSync(absParent, { withFileTypes: true }).filter((e) => e.isDirectory() && !e.name.startsWith(".")).map((e) => e.name).sort();
 	const configs = [];
 	for (const name of subdirs) {
 		const subdir = path.join(absParent, name);

package/model-loader.js

@@ -1,5 +1,5 @@
 import { isLoadedModel, isVersionConfig } from "./config-utils.js";
-import fsSync from "node:fs";
+import fs from "node:fs";
 import path from "node:path";
 import { Effect } from "effect";
 import { Model } from "@tsdoctor/model";
@@ -10,8 +10,8 @@ import { Model } from "@tsdoctor/model";
 */
 async function loadPackageJsonFromPath(pkgPath) {
 	const resolvedPath = path.resolve(pkgPath.toString());
-	if (!fsSync.existsSync(resolvedPath)) throw new Error(`Package.json file not found: ${resolvedPath}`);
-	const content = fsSync.readFileSync(resolvedPath, "utf-8");
+	if (!fs.existsSync(resolvedPath)) throw new Error(`Package.json file not found: ${resolvedPath}`);
+	const content = fs.readFileSync(resolvedPath, "utf-8");
 	try {
 		return JSON.parse(content);
 	} catch (error) {

package/observability/sinks/trace-sink.js

@@ -1,10 +1,10 @@
-import fsSync from "node:fs";
+import fs from "node:fs";
 import path from "node:path";
 
 //#region src/observability/sinks/trace-sink.ts
 function openTracePath(p) {
-	fsSync.mkdirSync(path.dirname(p), { recursive: true });
-	fsSync.writeFileSync(p, "");
+	fs.mkdirSync(path.dirname(p), { recursive: true });
+	fs.writeFileSync(p, "");
 }
 /**
 * Create a JSONL trace sink, opening the file eagerly at construction.
@@ -21,7 +21,7 @@ function makeTraceSink(tracePath) {
 		minLevel: "trace",
 		capturesPayload: true,
 		handle: (event) => {
-			fsSync.appendFileSync(tracePath, `${JSON.stringify(event)}\n`);
+			fs.appendFileSync(tracePath, `${JSON.stringify(event)}\n`);
 		},
 		flush: () => {}
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rspress-plugin-api-extractor",
-	"version": "0.18.8",
+	"version": "0.18.9",
 	"private": false,
 	"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
 	"keywords": [
@@ -42,6 +42,7 @@
 		"@effected/glob": "^0.9.0",
 		"@effected/jsonc": "^0.14.0",
 		"@effected/markdown": "^0.14.0",
+		"@effected/memfs": "^0.13.0",
 		"@effected/npm": "^0.19.0",
 		"@effected/package-json": "^0.19.1",
 		"@effected/schema-org": "^0.6.0",
@@ -60,7 +61,7 @@
 		"@tsdoctor/pages": "0.3.5",
 		"@tsdoctor/registry": "0.5.3",
 		"@tsdoctor/seo": "0.4.3",
-		"@tsdoctor/snapshot": "0.4.1",
+		"@tsdoctor/snapshot": "0.5.0",
 		"@tsdoctor/vfs": "0.4.1",
 		"@typescript/vfs": "^1.6.5",
 		"clsx": "^2.1.1",

package/plugin.js

@@ -23,7 +23,7 @@ import { clearTwoslashAccess, installTwoslashAccess, twoslashTransformerFor } fr
 import { remarkApiCodeblocks } from "./remark-api-codeblocks.js";
 import { remarkWithApi } from "./remark-with-api.js";
 import { createRequire } from "node:module";
-import fsSync from "node:fs";
+import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -63,7 +63,7 @@ function ApiExtractorPluginImpl(rawOptions) {
 	});
 	const { layer: eventBusLayer, trace: traceSink, issues: issuesSink, render: renderSink, metrics: metricStore } = buildEventBus(obs);
 	const dbPath = path.resolve(process.cwd(), ".api-docs", "snapshot", "api-docs.db");
-	fsSync.mkdirSync(path.dirname(dbPath), { recursive: true });
+	fs.mkdirSync(path.dirname(dbPath), { recursive: true });
 	const appLayers = makeAppLayers({
 		options,
 		obs,
@@ -163,7 +163,7 @@ function ApiExtractorPluginImpl(rawOptions) {
 					versions,
 					defaultVersion: rspressMultiVersion?.default
 				});
-				for (const dp of derivedPaths) fsSync.mkdirSync(dp.outputDir, { recursive: true });
+				for (const dp of derivedPaths) fs.mkdirSync(dp.outputDir, { recursive: true });
 			} else if (options.apis) for (const api of options.apis) {
 				const baseRoute = normalizeBaseRoute(api.baseRoute ?? `/${unscopedName(api.packageName)}`);
 				const derivedPaths = deriveOutputPaths({
@@ -176,7 +176,7 @@ function ApiExtractorPluginImpl(rawOptions) {
 					versions: [],
 					defaultVersion: void 0
 				});
-				for (const dp of derivedPaths) fsSync.mkdirSync(dp.outputDir, { recursive: true });
+				for (const dp of derivedPaths) fs.mkdirSync(dp.outputDir, { recursive: true });
 			}
 			VfsRegistry.clear();
 			clearTwoslashAccess();

package/sync-node-fs.js

@@ -1,80 +0,0 @@
-import fsSync from "node:fs";
-import { ByteSize, Effect, FileSystem, Layer, Option, Path, PlatformError } from "effect";
-
-//#region src/sync-node-fs.ts
-/**
-* A synchronous, read-only `FileSystem` implementation over `node:fs`'s sync
-* API, covering exactly the members `@tsdoctor/bundle`'s discovery walks:
-* `exists`, `stat`, `readFileString`, `readDirectory` and `readLink`.
-*
-* The config helpers (`fromDir`/`fromParentDir`) are a SYNC public API called
-* at rspress.config evaluation time, while bundle discovery is an Effect
-* program over the `FileSystem` service. `@effect/platform-node`'s
-* `NodeFileSystem` is promise-backed, so running discovery under
-* `Effect.runSync` needs this bridge; every other member stays
-* `layerNoop`-denied, which is deliberate — a new discovery dependency on an
-* unimplemented member should fail loudly here, not silently misbehave.
-*/
-const tagOf = (cause) => {
-	const code = cause?.code;
-	if (code === "ENOENT") return "NotFound";
-	if (code === "EACCES" || code === "EPERM") return "PermissionDenied";
-	return "Unknown";
-};
-const fail = (method, pathOrDescriptor, cause) => PlatformError.systemError({
-	_tag: tagOf(cause),
-	module: "FileSystem",
-	method,
-	pathOrDescriptor,
-	cause
-});
-const typeOf = (stats) => {
-	if (stats.isDirectory()) return "Directory";
-	if (stats.isSymbolicLink()) return "SymbolicLink";
-	if (stats.isFile()) return "File";
-	return "Unknown";
-};
-const infoFromStats = (stats) => ({
-	type: typeOf(stats),
-	mtime: Option.some(stats.mtime),
-	atime: Option.some(stats.atime),
-	birthtime: Option.some(stats.birthtime),
-	dev: stats.dev,
-	ino: Option.some(stats.ino),
-	mode: stats.mode,
-	nlink: Option.some(stats.nlink),
-	uid: Option.some(stats.uid),
-	gid: Option.some(stats.gid),
-	rdev: Option.some(stats.rdev),
-	size: ByteSize.bytes(stats.size),
-	blksize: Option.some(ByteSize.bytes(stats.blksize)),
-	blocks: Option.some(stats.blocks)
-});
-const syncFileSystem = FileSystem.layerNoop({
-	exists: (path) => Effect.sync(() => fsSync.existsSync(path)),
-	stat: (path) => Effect.try({
-		try: () => infoFromStats(fsSync.statSync(path)),
-		catch: (cause) => fail("stat", path, cause)
-	}),
-	readFileString: (path) => Effect.try({
-		try: () => fsSync.readFileSync(path, "utf8"),
-		catch: (cause) => fail("readFileString", path, cause)
-	}),
-	readDirectory: (path) => Effect.try({
-		try: () => fsSync.readdirSync(path),
-		catch: (cause) => fail("readDirectory", path, cause)
-	}),
-	readLink: (path) => Effect.try({
-		try: () => fsSync.readlinkSync(path),
-		catch: (cause) => fail("readLink", path, cause)
-	})
-});
-/**
-* The full sync environment bundle discovery runs under from the config
-* helpers: the sync `FileSystem` bridge plus the (already sync) `Path`
-* service.
-*/
-const SyncDiscoveryLayer = Layer.mergeAll(syncFileSystem, Path.layer);
-
-//#endregion
-export { SyncDiscoveryLayer };