cspell-io 9.6.4 → 9.8.0

package/dist/index.d.ts

@@ -171,7 +171,8 @@ interface DirEntry {
 declare function compareStats(left: Stats, right: Stats): number;
 //#endregion
 //#region src/models/disposable.d.ts
-interface Disposable {
+type DisposableEx = LegacyDisposable & Disposable;
+interface LegacyDisposable {
   dispose(): void;
 }
 //#endregion
@@ -291,7 +292,41 @@ declare class CSpellIONode implements CSpellIO {
 }
 declare function getDefaultCSpellIO(): CSpellIO;
 //#endregion
-//#region src/VFileSystem.d.ts
+//#region src/common/BufferEncoding.d.ts
+type TextEncodingExtra = "utf-16be" | "utf-16le" | "utf16be" | "utf16le";
+type BufferEncodingExt = BufferEncoding | TextEncodingExtra;
+//#endregion
+//#region src/node/file/fileWriter.d.ts
+declare function writeToFile(filename: string, data: string | Iterable<string> | AsyncIterable<string>, encoding?: BufferEncoding): Promise<void>;
+declare function writeToFileIterable(filename: string, data: Iterable<string> | AsyncIterable<string>, encoding?: BufferEncodingExt): Promise<void>;
+//#endregion
+//#region src/file/file.d.ts
+declare function readFileText(filename: string | URL, encoding?: BufferEncoding): Promise<string>;
+declare function readFileTextSync(filename: string | URL, encoding?: BufferEncoding): string;
+declare function getStat(filenameOrUri: string): Promise<Stats | Error>;
+declare function getStatSync(filenameOrUri: string): Stats | Error;
+//#endregion
+//#region src/types.d.ts
+type TArrayBufferView<T extends ArrayBuffer = ArrayBuffer> = ArrayBufferView<T>;
+//#endregion
+//#region src/node/dataUrl.d.ts
+/**
+* Generates a string of the following format:
+*
+* `data:[mediaType][;charset=<encoding>[;base64],<data>`
+*
+* - `encoding` - defaults to `utf8` for text data
+* @param data
+* @param mediaType - The mediaType is a [MIME](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) type string
+* @param attributes - Additional attributes
+*/
+declare function encodeDataUrl(data: string | TArrayBufferView | Uint8Array<ArrayBuffer>, mediaType: string, attributes?: Iterable<readonly [string, string]> | undefined): string;
+declare function toDataUrl(data: string | TArrayBufferView, mediaType: string, attributes?: Iterable<[string, string]> | undefined): URL;
+//#endregion
+//#region src/VirtualFS/constants.d.ts
+declare const CSPELL_VFS_PROTOCOL: "cspell-vfs:";
+//#endregion
+//#region src/VirtualFS/VFileSystem.d.ts
 type UrlOrReference = URL | FileReference;
 declare enum FSCapabilityFlags {
   None = 0,
@@ -346,12 +381,12 @@ interface VFileSystemCore {
   * The capabilities can be more restrictive than the general capabilities of the provider.
   * @param url - the url to try
   */
-  getCapabilities(url: URL): FSCapabilities;
+  getCapabilities(url: URL): Readonly<FSCapabilities>;
   /**
   * Information about the provider.
   * It is up to the provider to define what information is available.
   */
-  providerInfo: FileSystemProviderInfo;
+  providerInfo: Readonly<FileSystemProviderInfo>;
   /**
   * Indicates that a provider was found for the url.
   */
@@ -387,10 +422,10 @@ interface VFindUpURLOptions {
 }
 type VFindUpPredicate = (dir: URL) => URL | undefined | Promise<URL | undefined>;
 //#endregion
-//#region src/VirtualFS.d.ts
+//#region src/VirtualFS/VirtualFS.d.ts
 type NextProvider = (url: URL) => VProviderFileSystem | undefined;
-interface VirtualFS extends Disposable {
-  registerFileSystemProvider(provider: VFileSystemProvider, ...providers: VFileSystemProvider[]): Disposable;
+interface VirtualFS extends DisposableEx {
+  registerFileSystemProvider(provider: VFileSystemProvider, ...providers: VFileSystemProvider[]): DisposableEx;
   /**
   * Get the fs for a given url.
   */
@@ -417,7 +452,7 @@ interface OptionAbort {
   signal?: AbortSignal;
 }
 type VProviderFileSystemReadFileOptions = OptionAbort;
-interface VProviderFileSystem extends Disposable {
+interface VProviderFileSystem extends DisposableEx {
   readFile(url: UrlOrReference, options?: VProviderFileSystemReadFileOptions): Promise<FileResource>;
   writeFile(file: FileResource): Promise<FileReference>;
   /**
@@ -433,14 +468,14 @@ interface VProviderFileSystem extends Disposable {
   */
   capabilities: FSCapabilityFlags;
   /**
-  * Get the capabilities for a URL. Make it possible for a provider to support more capabilities for a given url.
+  * Get the capabilities for a URL. Makes it possible for a provider to support more capabilities for a given url.
   * These capabilities should be more restrictive than the general capabilities.
   * @param url - the url to try
   * @returns the capabilities for the url.
   */
   getCapabilities?: (url: URL) => FSCapabilities;
 }
-interface VFileSystemProvider extends Partial<Disposable> {
+interface VFileSystemProvider extends Partial<DisposableEx> {
   /** Name of the Provider */
   name: string;
   /**
@@ -451,41 +486,10 @@ interface VFileSystemProvider extends Partial<Disposable> {
   getFileSystem(url: URL, next: NextProvider): VProviderFileSystem | undefined;
 }
 //#endregion
-//#region src/CVirtualFS.d.ts
+//#region src/VirtualFS/CVirtualFS.d.ts
 declare function createVirtualFS(cspellIO?: CSpellIO): VirtualFS;
 declare function getDefaultVirtualFs(): VirtualFS;
 //#endregion
-//#region src/common/BufferEncoding.d.ts
-type TextEncodingExtra = "utf-16be" | "utf-16le" | "utf16be" | "utf16le";
-type BufferEncodingExt = BufferEncoding | TextEncodingExtra;
-//#endregion
-//#region src/node/file/fileWriter.d.ts
-declare function writeToFile(filename: string, data: string | Iterable<string> | AsyncIterable<string>, encoding?: BufferEncoding): Promise<void>;
-declare function writeToFileIterable(filename: string, data: Iterable<string> | AsyncIterable<string>, encoding?: BufferEncodingExt): Promise<void>;
-//#endregion
-//#region src/file/file.d.ts
-declare function readFileText(filename: string | URL, encoding?: BufferEncoding): Promise<string>;
-declare function readFileTextSync(filename: string | URL, encoding?: BufferEncoding): string;
-declare function getStat(filenameOrUri: string): Promise<Stats | Error>;
-declare function getStatSync(filenameOrUri: string): Stats | Error;
-//#endregion
-//#region src/types.d.ts
-type TArrayBufferView<T extends ArrayBuffer = ArrayBuffer> = ArrayBufferView<T>;
-//#endregion
-//#region src/node/dataUrl.d.ts
-/**
-* Generates a string of the following format:
-*
-* `data:[mediaType][;charset=<encoding>[;base64],<data>`
-*
-* - `encoding` - defaults to `utf8` for text data
-* @param data
-* @param mediaType - The mediaType is a [MIME](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) type string
-* @param attributes - Additional attributes
-*/
-declare function encodeDataUrl(data: string | TArrayBufferView | Uint8Array<ArrayBuffer>, mediaType: string, attributes?: Iterable<readonly [string, string]> | undefined): string;
-declare function toDataUrl(data: string | TArrayBufferView, mediaType: string, attributes?: Iterable<[string, string]> | undefined): URL;
-//#endregion
 //#region src/VirtualFS/redirectProvider.d.ts
 interface RedirectOptions {
   /**
@@ -516,5 +520,5 @@ interface RedirectOptions {
 */
 declare function createRedirectProvider(name: string, publicRoot: URL, privateRoot: URL, options?: RedirectOptions): VFileSystemProvider;
 //#endregion
-export { type BufferEncoding, CFileReference, CFileResource, type CSpellIO, CSpellIONode, FSCapabilityFlags, type FileReference, type FileResource, type Stats, type TextEncoding, type TextFileResource, type VFileSystem, type VFileSystemCore, type VFileSystemProvider, FileType as VFileType, type VFindEntryType, type VFindUpPredicate, type VFindUpURLOptions, type VProviderFileSystem, type VfsDirEntry, type VfsStat, type VirtualFS, toArray as asyncIterableToArray, compareStats, createRedirectProvider, fromFileResource as createTextFileResource, createVirtualFS, encodeDataUrl, getDefaultCSpellIO, getDefaultVirtualFs, getStat, getStatSync, isFileURL, isUrlLike, readFileText, readFileTextSync, renameFileReference, renameFileResource, toDataUrl, toFileURL, toURL, urlBasename, urlDirname, urlOrReferenceToUrl, writeToFile, writeToFileIterable, writeToFileIterable as writeToFileIterableP };
+export { type BufferEncoding, CFileReference, CFileResource, CSPELL_VFS_PROTOCOL, type CSpellIO, CSpellIONode, FSCapabilityFlags, type FileReference, type FileResource, type Stats, type TextEncoding, type TextFileResource, type VFileSystem, type VFileSystemCore, type VFileSystemProvider, FileType as VFileType, type VFindEntryType, type VFindUpPredicate, type VFindUpURLOptions, type VProviderFileSystem, type VfsDirEntry, type VfsStat, type VirtualFS, toArray as asyncIterableToArray, compareStats, createRedirectProvider, fromFileResource as createTextFileResource, createVirtualFS, encodeDataUrl, getDefaultCSpellIO, getDefaultVirtualFs, getStat, getStatSync, isFileURL, isUrlLike, readFileText, readFileTextSync, renameFileReference, renameFileResource, toDataUrl, toFileURL, toURL, urlBasename, urlDirname, urlOrReferenceToUrl, writeToFile, writeToFileIterable, writeToFileIterable as writeToFileIterableP };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -9,7 +9,6 @@ import { fileURLToPath } from "node:url";
 import { promisify } from "node:util";
 import * as Stream from "node:stream";
 import assert from "node:assert";
-
 //#region src/async/asyncIterable.ts
 /**
 * Reads an entire iterable and converts it into a promise.
@@ -20,7 +19,6 @@ async function toArray(asyncIterable) {
 	for await (const item of asyncIterable) data.push(item);
 	return data;
 }
-
 //#endregion
 //#region src/common/CFileReference.ts
 var CFileReference = class CFileReference {
@@ -85,7 +83,6 @@ function toFileResourceRequest(file, encoding, signal) {
 		signal
 	};
 }
-
 //#endregion
 //#region src/errors/errors.ts
 var ErrorNotImplemented = class extends Error {
@@ -100,13 +97,11 @@ var AssertionError = class extends Error {
 		this.message = message;
 	}
 };
-
 //#endregion
 //#region src/errors/assert.ts
 function assert$1(value, message) {
 	if (!value) throw new AssertionError(message ?? "Assertion failed");
 }
-
 //#endregion
 //#region src/common/arrayBuffers.ts
 function toUint8Array(data) {
@@ -127,7 +122,6 @@ function swap16(data) {
 function swapBytes(data) {
 	return swap16(copyArrayBufferView(data));
 }
-
 //#endregion
 //#region src/common/encode-decode.ts
 const BOM_BE = 65279;
@@ -243,7 +237,6 @@ async function decompress(data, method = "gzip") {
 	}
 	return result;
 }
-
 //#endregion
 //#region src/common/CFileResource.ts
 var CFileResource = class CFileResource {
@@ -330,7 +323,6 @@ function renameFileResource(fileResource, url) {
 		url
 	});
 }
-
 //#endregion
 //#region src/common/stat.ts
 /**
@@ -345,13 +337,11 @@ function compareStats(left, right) {
 	const diff = left.size - right.size || left.mtimeMs - right.mtimeMs;
 	return diff < 0 ? -1 : diff > 0 ? 1 : 0;
 }
-
 //#endregion
 //#region src/common/urlOrReferenceToUrl.ts
 function urlOrReferenceToUrl(urlOrReference) {
 	return urlOrReference instanceof URL ? urlOrReference : urlOrReference.url;
 }
-
 //#endregion
 //#region src/CSpellIO.ts
 function toReadFileOptions(options) {
@@ -359,7 +349,6 @@ function toReadFileOptions(options) {
 	if (typeof options === "string") return { encoding: options };
 	return options;
 }
-
 //#endregion
 //#region src/errors/error.ts
 function toError$1(e) {
@@ -367,7 +356,6 @@ function toError$1(e) {
 	if (typeof e === "object" && e && "message" in e && typeof e.message === "string") return new Error(e.message, { cause: e });
 	return new Error(e && e.toString());
 }
-
 //#endregion
 //#region src/models/Stats.ts
 let FileType = /* @__PURE__ */ function(FileType) {
@@ -389,7 +377,6 @@ let FileType = /* @__PURE__ */ function(FileType) {
 	FileType[FileType["SymbolicLink"] = 64] = "SymbolicLink";
 	return FileType;
 }({});
-
 //#endregion
 //#region src/node/dataUrl.ts
 /**
@@ -463,12 +450,10 @@ function guessMimeType(filename) {
 		encoding: "utf-8"
 	};
 }
-
 //#endregion
 //#region src/node/file/_fetch.ts
 /** alias of global.fetch, useful for mocking */
 const _fetch = globalThis.fetch;
-
 //#endregion
 //#region src/node/file/FetchError.ts
 var FetchUrlError = class FetchUrlError extends Error {
@@ -511,7 +496,6 @@ function toFetchUrlError(err, url) {
 function toError(err) {
 	return err instanceof Error ? err : new Error("Unknown Error", { cause: err });
 }
-
 //#endregion
 //#region src/node/file/fetch.ts
 async function fetchHead(request) {
@@ -536,7 +520,6 @@ async function fetchURL(url, signal) {
 function toURL$1(url) {
 	return typeof url === "string" ? new URL(url) : url;
 }
-
 //#endregion
 //#region src/node/file/stat.ts
 async function getStatHttp(url) {
@@ -549,39 +532,13 @@ async function getStatHttp(url) {
 		eTag
 	};
 }
-
-//#endregion
-//#region src/requests/RequestFsReadFile.ts
-const RequestType$4 = "fs:readFile";
-const RequestFsReadFile = requestFactory(RequestType$4);
-
-//#endregion
-//#region src/requests/RequestFsReadFileSync.ts
-const RequestType$3 = "fs:readFileSync";
-const RequestFsReadFileTextSync = requestFactory(RequestType$3);
-
-//#endregion
-//#region src/requests/RequestFsStat.ts
-const RequestTypeStat = "fs:stat";
-const RequestFsStat = requestFactory(RequestTypeStat);
-const RequestTypeStatSync = "fs:statSync";
-const RequestFsStatSync = requestFactory(RequestTypeStatSync);
-
-//#endregion
-//#region src/requests/RequestFsWriteFile.ts
-const RequestType$2 = "fs:writeFile";
-const RequestFsWriteFile = requestFactory(RequestType$2);
-
-//#endregion
-//#region src/requests/RequestZlibInflate.ts
-const RequestType$1 = "zlib:inflate";
-const RequestZlibInflate = requestFactory(RequestType$1);
-
-//#endregion
-//#region src/requests/RequestFsReadDirectory.ts
-const RequestType = "fs:readDir";
-const RequestFsReadDirectory = requestFactory(RequestType);
-
+const RequestFsReadFile = requestFactory("fs:readFile");
+const RequestFsReadFileTextSync = requestFactory("fs:readFileSync");
+const RequestFsStat = requestFactory("fs:stat");
+const RequestFsStatSync = requestFactory("fs:statSync");
+const RequestFsWriteFile = requestFactory("fs:writeFile");
+const RequestZlibInflate = requestFactory("zlib:inflate");
+const RequestFsReadDirectory = requestFactory("fs:readDir");
 //#endregion
 //#region src/handlers/node/file.ts
 const isGzFileRegExp = /\.gz($|[?#])/;
@@ -784,7 +741,6 @@ function toFileType(statLike) {
 	const t = statLike.isFile() ? FileType.File : statLike.isDirectory() ? FileType.Directory : FileType.Unknown;
 	return statLike.isSymbolicLink() ? t | FileType.SymbolicLink : t;
 }
-
 //#endregion
 //#region src/CSpellIONode.ts
 let defaultCSpellIONode = void 0;
@@ -858,11 +814,62 @@ function getDefaultCSpellIO() {
 	defaultCSpellIONode = cspellIO;
 	return cspellIO;
 }
-
 //#endregion
-//#region src/VirtualFS.ts
-const debug = false;
-
+//#region src/common/transformers.ts
+function encoderTransformer(iterable, encoding) {
+	return isAsyncIterable(iterable) ? encoderAsyncIterable(iterable, encoding) : encoderIterable(iterable, encoding);
+}
+function* encoderIterable(iterable, encoding) {
+	let useBom = true;
+	for (const chunk of iterable) {
+		yield encodeString$1(chunk, encoding, useBom);
+		useBom = false;
+	}
+}
+async function* encoderAsyncIterable(iterable, encoding) {
+	let useBom = true;
+	for await (const chunk of iterable) {
+		yield encodeString$1(chunk, encoding, useBom);
+		useBom = false;
+	}
+}
+function isAsyncIterable(v) {
+	return v && typeof v === "object" && !!v[Symbol.asyncIterator];
+}
+//#endregion
+//#region src/node/file/fileWriter.ts
+const pipeline = promisify(Stream.pipeline);
+function writeToFile(filename, data, encoding) {
+	return writeToFileIterable(filename, typeof data === "string" ? [data] : data, encoding);
+}
+function writeToFileIterable(filename, data, encoding) {
+	return pipeline(Stream.Readable.from(encoderTransformer(data, encoding)), /\.gz$/.test(filename) ? zlib.createGzip() : new Stream.PassThrough(), fs.createWriteStream(filename));
+}
+//#endregion
+//#region src/file/file.ts
+async function readFileText(filename, encoding) {
+	return (await getDefaultCSpellIO().readFile(filename, encoding)).getText();
+}
+function readFileTextSync(filename, encoding) {
+	return getDefaultCSpellIO().readFileSync(filename, encoding).getText();
+}
+async function getStat(filenameOrUri) {
+	try {
+		return await getDefaultCSpellIO().getStat(filenameOrUri);
+	} catch (e) {
+		return toError$1(e);
+	}
+}
+function getStatSync(filenameOrUri) {
+	try {
+		return getDefaultCSpellIO().getStatSync(filenameOrUri);
+	} catch (e) {
+		return toError$1(e);
+	}
+}
+//#endregion
+//#region src/VirtualFS/constants.ts
+const CSPELL_VFS_PROTOCOL = "cspell-vfs:";
 //#endregion
 //#region src/VirtualFS/findUpFromUrl.ts
 async function findUpFromUrl(name, from, options) {
@@ -897,7 +904,6 @@ function makePredicate(fs, name, entryType) {
 		}
 	};
 }
-
 //#endregion
 //#region src/VirtualFS/CVFileSystem.ts
 var CVFileSystem = class {
@@ -928,9 +934,41 @@ var CVFileSystem = class {
 		});
 	}
 };
-
 //#endregion
-//#region src/VFileSystem.ts
+//#region src/VirtualFS/errors.ts
+var VFSError = class extends Error {
+	url;
+	code;
+	constructor(message, options) {
+		super(message, { cause: options?.cause });
+		this.name = "VFSError";
+		this.url = options?.url instanceof URL ? options.url.href : options?.url;
+		this.code = options?.code;
+	}
+};
+var VFSNotSupported = class extends VFSError {
+	constructor(methodName, url) {
+		super(`Method ${methodName} is not supported for ${url.href}`, { url });
+	}
+};
+var VFSNotFoundError = class extends VFSError {
+	constructor(url, options) {
+		super(`Not found: ${url.href}`, {
+			...options,
+			url,
+			code: options?.code ?? "ENOENT"
+		});
+	}
+};
+var VFSErrorUnsupportedRequest = class extends VFSError {
+	constructor(request, url, parameters) {
+		super(`Unsupported request: ${request}`, { url });
+		this.request = request;
+		this.parameters = parameters;
+	}
+};
+//#endregion
+//#region src/VirtualFS/VFileSystem.ts
 let FSCapabilityFlags = /* @__PURE__ */ function(FSCapabilityFlags) {
 	FSCapabilityFlags[FSCapabilityFlags["None"] = 0] = "None";
 	FSCapabilityFlags[FSCapabilityFlags["Stat"] = 1] = "Stat";
@@ -942,7 +980,166 @@ let FSCapabilityFlags = /* @__PURE__ */ function(FSCapabilityFlags) {
 	FSCapabilityFlags[FSCapabilityFlags["ReadWriteDir"] = 24] = "ReadWriteDir";
 	return FSCapabilityFlags;
 }({});
-
+//#endregion
+//#region src/VirtualFS/MemVfsProvider.ts
+var MemFileSystemProvider = class {
+	name;
+	protocol;
+	#vfs;
+	/**
+	* @param name - the name of the provider, used for debugging and logging.
+	* @param protocol - the protocol (end with a :), examples: `vfs:`, `cspell-vfs:`
+	*/
+	constructor(name, protocol) {
+		this.name = name;
+		this.protocol = protocol;
+		this.#vfs = new MemVFileSystem(name, protocol);
+	}
+	getFileSystem(url) {
+		if (url.protocol !== this.protocol) return;
+		return this.#vfs;
+	}
+	get memFS() {
+		return this.#vfs;
+	}
+	dispose() {
+		this.#vfs.dispose();
+	}
+	[Symbol.dispose]() {
+		this.dispose();
+	}
+};
+var MemVFileSystem = class {
+	name;
+	protocol;
+	capabilities = FSCapabilityFlags.ReadWrite | FSCapabilityFlags.Stat;
+	#files = /* @__PURE__ */ new Map();
+	constructor(name, protocol) {
+		this.name = name;
+		this.protocol = protocol;
+		this.providerInfo = { name };
+		this.#files = /* @__PURE__ */ new Map();
+	}
+	/**
+	* Read a file.
+	* @param url - URL to read
+	* @param options - options for reading the file.
+	* @returns A FileResource, the content will not be decoded. Use `.getText()` to get the decoded text.
+	*/
+	async readFile(url, _options) {
+		return this.#getEntryOrThrow(url).file;
+	}
+	/**
+	* Write a file
+	* @param file - the file to write
+	*/
+	async writeFile(file) {
+		const stats = {
+			size: file.content.length,
+			mtimeMs: performance.now(),
+			fileType: FileType.File
+		};
+		const u = urlOrReferenceToUrl(file);
+		this.#files.set(u.href, {
+			file,
+			stats
+		});
+		return { url: file.url };
+	}
+	/**
+	* Get the stats for a url.
+	* @param url - Url to fetch stats for.
+	*/
+	stat(url) {
+		return this.#getEntryOrThrow(url).stats;
+	}
+	#getEntryOrThrow(url) {
+		const u = urlOrReferenceToUrl(url);
+		const found = this.#files.get(u.href);
+		if (!found) throw new VFSNotFoundError(u);
+		return found;
+	}
+	/**
+	* Read the directory entries for a url.
+	* The url should end with `/` to indicate a directory.
+	* @param url - the url to read the directory entries for.
+	*/
+	async readDirectory(url) {
+		throw new VFSNotSupported("readDirectory", url);
+	}
+	/**
+	* Information about the provider.
+	* It is up to the provider to define what information is available.
+	*/
+	providerInfo;
+	dispose() {
+		this.#files.clear();
+	}
+	[Symbol.dispose]() {
+		this.dispose();
+	}
+};
+//#endregion
+//#region src/VirtualFS/capabilities.ts
+var CFsCapabilities = class {
+	constructor(flags) {
+		this.flags = flags;
+	}
+	get readFile() {
+		return !!(this.flags & FSCapabilityFlags.Read);
+	}
+	get writeFile() {
+		return !!(this.flags & FSCapabilityFlags.Write);
+	}
+	get readDirectory() {
+		return !!(this.flags & FSCapabilityFlags.ReadDir);
+	}
+	get writeDirectory() {
+		return !!(this.flags & FSCapabilityFlags.WriteDir);
+	}
+	get stat() {
+		return !!(this.flags & FSCapabilityFlags.Stat);
+	}
+};
+function fsCapabilities(flags) {
+	return new CFsCapabilities(flags);
+}
+//#endregion
+//#region src/VirtualFS/CFileType.ts
+var CFileType = class {
+	constructor(fileType) {
+		this.fileType = fileType;
+	}
+	isFile() {
+		return this.fileType === FileType.File;
+	}
+	isDirectory() {
+		return this.fileType === FileType.Directory;
+	}
+	isUnknown() {
+		return !this.fileType;
+	}
+	isSymbolicLink() {
+		return !!(this.fileType & FileType.SymbolicLink);
+	}
+};
+//#endregion
+//#region src/VirtualFS/CVfsStat.ts
+var CVfsStat = class extends CFileType {
+	constructor(stat) {
+		super(stat.fileType || FileType.Unknown);
+		this.stat = stat;
+	}
+	get size() {
+		return this.stat.size;
+	}
+	get mtimeMs() {
+		return this.stat.mtimeMs;
+	}
+	get eTag() {
+		return this.stat.eTag;
+	}
+};
 //#endregion
 //#region src/VirtualFS/WrappedProviderFs.ts
 function cspellIOToFsProvider(cspellIO) {
@@ -959,17 +1156,19 @@ function cspellIOToFsProvider(cspellIO) {
 		"http:",
 		"https:"
 	]);
+	const dispose = () => void 0;
 	const fs = {
 		providerInfo: { name },
 		stat: (url) => cspellIO.getStat(url),
 		readFile: (url, options) => cspellIO.readFile(url, options),
 		readDirectory: (url) => cspellIO.readDirectory(url),
 		writeFile: (file) => cspellIO.writeFile(file.url, file.content),
-		dispose: () => void 0,
+		dispose,
 		capabilities,
 		getCapabilities(url) {
 			return fsCapabilities(capMap[url.protocol] || FSCapabilityFlags.None);
-		}
+		},
+		[Symbol.dispose]: dispose
 	};
 	return {
 		name,
@@ -982,43 +1181,6 @@ function wrapError(e) {
 	if (e instanceof VFSError) return e;
 	return e;
 }
-var VFSError = class extends Error {
-	constructor(message, options) {
-		super(message, options);
-	}
-};
-var VFSErrorUnsupportedRequest = class extends VFSError {
-	url;
-	constructor(request, url, parameters) {
-		super(`Unsupported request: ${request}`);
-		this.request = request;
-		this.parameters = parameters;
-		this.url = url?.toString();
-	}
-};
-var CFsCapabilities = class {
-	constructor(flags) {
-		this.flags = flags;
-	}
-	get readFile() {
-		return !!(this.flags & FSCapabilityFlags.Read);
-	}
-	get writeFile() {
-		return !!(this.flags & FSCapabilityFlags.Write);
-	}
-	get readDirectory() {
-		return !!(this.flags & FSCapabilityFlags.ReadDir);
-	}
-	get writeDirectory() {
-		return !!(this.flags & FSCapabilityFlags.WriteDir);
-	}
-	get stat() {
-		return !!(this.flags & FSCapabilityFlags.Stat);
-	}
-};
-function fsCapabilities(flags) {
-	return new CFsCapabilities(flags);
-}
 var WrappedProviderFs = class WrappedProviderFs {
 	hasProvider;
 	capabilities;
@@ -1109,38 +1271,6 @@ var WrappedProviderFs = class WrappedProviderFs {
 function checkCapabilityOrThrow(fs, capabilities, flag, name, url) {
 	if (!(capabilities & flag)) throw new VFSErrorUnsupportedRequest(name, url);
 }
-var CFileType = class {
-	constructor(fileType) {
-		this.fileType = fileType;
-	}
-	isFile() {
-		return this.fileType === FileType.File;
-	}
-	isDirectory() {
-		return this.fileType === FileType.Directory;
-	}
-	isUnknown() {
-		return !this.fileType;
-	}
-	isSymbolicLink() {
-		return !!(this.fileType & FileType.SymbolicLink);
-	}
-};
-var CVfsStat = class extends CFileType {
-	constructor(stat) {
-		super(stat.fileType || FileType.Unknown);
-		this.stat = stat;
-	}
-	get size() {
-		return this.stat.size;
-	}
-	get mtimeMs() {
-		return this.stat.mtimeMs;
-	}
-	get eTag() {
-		return this.stat.eTag;
-	}
-};
 var CVfsDirEntry = class extends CFileType {
 	_url;
 	constructor(entry) {
@@ -1166,14 +1296,22 @@ var CVfsDirEntry = class extends CFileType {
 		};
 	}
 };
-function chopUrl(url) {
+/**
+* Chop URL at node_modules to make it more readable in logs. If the URL contains `node_modules`, the
+* chopped URL will include the part before `node_modules`, followed by `…`, and then the last 3 parts
+* of the URL. If the URL does not contain `node_modules`, the original URL href will be returned.
+* @param url - the URL to chop.
+* @returns string - the chopped URL, if the URL contains node_modules, otherwise the original URL href.
+*/
+function chopUrlAtNodeModules(url) {
 	if (!url) return "";
 	const href = url.href;
 	const parts = href.split("/");
 	const n = parts.indexOf("node_modules");
 	if (n > 0) {
-		const tail = parts.slice(Math.max(parts.length - 3, n + 1));
-		return parts.slice(0, n + 1).join("/") + "/…/" + tail.join("/");
+		const tail = parts.slice(n + 1);
+		if (tail.length <= 3) return href;
+		return parts.slice(0, n + 1).join("/") + "/…/" + tail.slice(-3).join("/");
 	}
 	return href;
 }
@@ -1183,16 +1321,15 @@ function rPad(str, len, ch = " ") {
 function toOptions(val) {
 	return typeof val === "string" ? { encoding: val } : val;
 }
-
 //#endregion
-//#region src/CVirtualFS.ts
+//#region src/VirtualFS/CVirtualFS.ts
 var CVirtualFS = class {
 	providers = /* @__PURE__ */ new Set();
 	cachedFs = /* @__PURE__ */ new Map();
 	revCacheFs = /* @__PURE__ */ new Map();
 	fsc;
 	fs;
-	loggingEnabled = debug;
+	loggingEnabled = false;
 	constructor() {
 		this.fsc = fsPassThroughCore((url) => this._getFS(url));
 		this.fs = new CVFileSystem(this.fsc);
@@ -1206,19 +1343,23 @@ var CVirtualFS = class {
 			const id = event.traceID.toFixed(13).replaceAll(/\d{4}(?=\d)/g, "$&.");
 			const msg = event.message ? `\n\t\t${event.message}` : "";
 			const method = rPad(`${event.method}-${event.event}`, 16);
-			this.log(`${method} ID:${id} ts:${event.ts.toFixed(13)} ${chopUrl(event.url)}${msg}`);
+			this.log(`${method} ID:${id} ts:${event.ts.toFixed(13)} ${chopUrlAtNodeModules(event.url)}${msg}`);
 		}
 	};
 	registerFileSystemProvider(...providers) {
 		providers.forEach((provider) => this.providers.add(provider));
 		this.reset();
-		return { dispose: () => {
+		const dispose = () => {
 			for (const provider of providers) {
 				for (const key of this.revCacheFs.get(provider) || []) this.cachedFs.delete(key);
 				this.providers.delete(provider);
 			}
 			this.reset();
-		} };
+		};
+		return {
+			dispose,
+			[Symbol.dispose]: dispose
+		};
 	}
 	getFS(url) {
 		return new CVFileSystem(this._getFS(url));
@@ -1269,6 +1410,9 @@ var CVirtualFS = class {
 			provider.dispose?.();
 		} catch {}
 	}
+	[Symbol.dispose]() {
+		this.dispose();
+	}
 };
 function fsPassThroughCore(fs) {
 	function gfs(ur, name) {
@@ -1294,6 +1438,7 @@ function createVirtualFS(cspellIO) {
 	const cspell = cspellIO || getDefaultCSpellIO();
 	const vfs = new CVirtualFS();
 	vfs.registerFileSystemProvider(cspellIOToFsProvider(cspell));
+	vfs.registerFileSystemProvider(new MemFileSystemProvider(CSPELL_VFS_PROTOCOL + "default", CSPELL_VFS_PROTOCOL));
 	return vfs;
 }
 let defaultVirtualFs = void 0;
@@ -1301,63 +1446,6 @@ function getDefaultVirtualFs() {
 	if (!defaultVirtualFs) defaultVirtualFs = createVirtualFS();
 	return defaultVirtualFs;
 }
-
-//#endregion
-//#region src/common/transformers.ts
-function encoderTransformer(iterable, encoding) {
-	return isAsyncIterable(iterable) ? encoderAsyncIterable(iterable, encoding) : encoderIterable(iterable, encoding);
-}
-function* encoderIterable(iterable, encoding) {
-	let useBom = true;
-	for (const chunk of iterable) {
-		yield encodeString$1(chunk, encoding, useBom);
-		useBom = false;
-	}
-}
-async function* encoderAsyncIterable(iterable, encoding) {
-	let useBom = true;
-	for await (const chunk of iterable) {
-		yield encodeString$1(chunk, encoding, useBom);
-		useBom = false;
-	}
-}
-function isAsyncIterable(v) {
-	return v && typeof v === "object" && !!v[Symbol.asyncIterator];
-}
-
-//#endregion
-//#region src/node/file/fileWriter.ts
-const pipeline = promisify(Stream.pipeline);
-function writeToFile(filename, data, encoding) {
-	return writeToFileIterable(filename, typeof data === "string" ? [data] : data, encoding);
-}
-function writeToFileIterable(filename, data, encoding) {
-	return pipeline(Stream.Readable.from(encoderTransformer(data, encoding)), /\.gz$/.test(filename) ? zlib.createGzip() : new Stream.PassThrough(), fs.createWriteStream(filename));
-}
-
-//#endregion
-//#region src/file/file.ts
-async function readFileText(filename, encoding) {
-	return (await getDefaultCSpellIO().readFile(filename, encoding)).getText();
-}
-function readFileTextSync(filename, encoding) {
-	return getDefaultCSpellIO().readFileSync(filename, encoding).getText();
-}
-async function getStat(filenameOrUri) {
-	try {
-		return await getDefaultCSpellIO().getStat(filenameOrUri);
-	} catch (e) {
-		return toError$1(e);
-	}
-}
-function getStatSync(filenameOrUri) {
-	try {
-		return getDefaultCSpellIO().getStatSync(filenameOrUri);
-	} catch (e) {
-		return toError$1(e);
-	}
-}
-
 //#endregion
 //#region src/VirtualFS/redirectProvider.ts
 var RedirectProvider = class {
@@ -1441,6 +1529,7 @@ function remapFS(name, fs, shadowFs, publicRoot, privateRoot, options) {
 			dir
 		};
 	};
+	const dispose = () => fs.dispose();
 	return fsPassThrough({
 		stat: async (url) => {
 			const url2 = mapUrlOrReferenceToPrivate(url);
@@ -1463,7 +1552,8 @@ function remapFS(name, fs, shadowFs, publicRoot, privateRoot, options) {
 			name
 		},
 		capabilities: capabilities ?? fs.capabilities & capabilitiesMask,
-		dispose: () => fs.dispose()
+		dispose,
+		[Symbol.dispose]: dispose
 	}, shadowFs, publicRoot);
 }
 function fsPassThrough(fs, shadowFs, root) {
@@ -1494,10 +1584,13 @@ function fsPassThrough(fs, shadowFs, root) {
 		dispose: () => {
 			fs.dispose();
 			shadowFs?.dispose();
+		},
+		[Symbol.dispose]() {
+			this.dispose();
 		}
 	};
 }
-
 //#endregion
-export { CFileReference, CFileResource, CSpellIONode, FSCapabilityFlags, FileType as VFileType, toArray as asyncIterableToArray, compareStats, createRedirectProvider, fromFileResource as createTextFileResource, createVirtualFS, encodeDataUrl, getDefaultCSpellIO, getDefaultVirtualFs, getStat, getStatSync, isFileURL, isUrlLike, readFileText, readFileTextSync, renameFileReference, renameFileResource, toDataUrl, toFileURL, toURL, urlBasename, urlDirname, urlOrReferenceToUrl, writeToFile, writeToFileIterable, writeToFileIterable as writeToFileIterableP };
+export { CFileReference, CFileResource, CSPELL_VFS_PROTOCOL, CSpellIONode, FSCapabilityFlags, FileType as VFileType, toArray as asyncIterableToArray, compareStats, createRedirectProvider, fromFileResource as createTextFileResource, createVirtualFS, encodeDataUrl, getDefaultCSpellIO, getDefaultVirtualFs, getStat, getStatSync, isFileURL, isUrlLike, readFileText, readFileTextSync, renameFileReference, renameFileResource, toDataUrl, toFileURL, toURL, urlBasename, urlDirname, urlOrReferenceToUrl, writeToFile, writeToFileIterable, writeToFileIterable as writeToFileIterableP };
+
 //# sourceMappingURL=index.js.map

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.6.4",
+  "version": "9.8.0",
   "description": "A library of useful I/O functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -56,8 +56,8 @@
     "vitest-fetch-mock": "^0.4.5"
   },
   "dependencies": {
-    "@cspell/cspell-service-bus": "9.6.4",
-    "@cspell/url": "9.6.4"
+    "@cspell/cspell-service-bus": "9.8.0",
+    "@cspell/url": "9.8.0"
   },
-  "gitHead": "e126c7f5708d4258ada35ba1d29d18952d7f0886"
+  "gitHead": "c822013ce676dffb5fa5544567c25a3ae666718f"
 }