fix: Enable reading dictionaries from cspell-vfs (#8553)

Signed-off-by: Jason Dent <Jason3S@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: Jason3S

packages/cspell-dictionary-bundler-plugin/package.json

@@ -16,15 +16,15 @@
     "plugin"
   ],
   "exports": {
-    ".": "./dist/index.js",
-    "./api": "./dist/api.js",
-    "./esbuild": "./dist/esbuild.js",
-    "./farm": "./dist/farm.js",
-    "./rolldown": "./dist/rolldown.js",
-    "./rollup": "./dist/rollup.js",
-    "./rspack": "./dist/rspack.js",
-    "./vite": "./dist/vite.js",
-    "./webpack": "./dist/webpack.js",
+    ".": "./dist/index.mjs",
+    "./api": "./dist/api.mjs",
+    "./esbuild": "./dist/esbuild.mjs",
+    "./farm": "./dist/farm.mjs",
+    "./rolldown": "./dist/rolldown.mjs",
+    "./rollup": "./dist/rollup.mjs",
+    "./rspack": "./dist/rspack.mjs",
+    "./vite": "./dist/vite.mjs",
+    "./webpack": "./dist/webpack.mjs",
     "./package.json": "./package.json"
   },
   "files": [

packages/cspell-dictionary-bundler-plugin/src/core/bundler.ts

@@ -45,10 +45,11 @@ export class CSpellDictionaryBundler {
             if (!def.path) continue;
             const d = { ...def };
             dictDefs[i] = d;
-            delete d.file;
             const url = new URL(def.btrie ?? def.path, config.url);
             if (url.protocol !== 'file:') continue;
             const vfsUrl = await populateVfs(vfs, url);
+            delete d.file;
+            delete d.btrie;
             d.path = vfsUrl.href;
         }
 

packages/cspell-dictionary-bundler-plugin/src/core/core.ts

@@ -1,4 +1,6 @@
-import { fileURLToPath, pathToFileURL } from 'node:url';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
 
 import { createFilter, dataToEsm } from '@rollup/pluginutils';
 import type { CSpellConfigFileReaderWriter } from 'cspell-config-lib';
@@ -12,6 +14,7 @@ export function createPlugin(): UnpluginInstance<Options | undefined, false> {
     return createUnplugin((rawOptions = {}) => {
         const options = resolveOptions(rawOptions);
         const filter = createFilter(options.include, options.exclude);
+        const consoleLog = options.debug ? console.log.bind(console) : () => {};
 
         let readerWriter: CSpellConfigFileReaderWriter | undefined = undefined;
         let bundler: CSpellDictionaryBundler | undefined = undefined;
@@ -22,13 +25,13 @@ export function createPlugin(): UnpluginInstance<Options | undefined, false> {
             enforce: options.enforce,
 
             transform: {
-                // filter: {
-                //     id: { include: options.include, exclude: options.exclude },
-                // },
+                filter: {
+                    id: { include: options.include, exclude: options.exclude },
+                },
                 async handler(code, id) {
-                    console.log(`Can transform ${id}? ${filter(id) ? 'yes' : 'no'}`);
+                    consoleLog(`Can transform ${id}? ${filter(id) ? 'yes' : 'no'}`);
                     if (!filter(id)) return undefined;
-                    console.log(`Transforming ${id} with ${code.length} characters`);
+                    consoleLog(`Transforming ${id} with ${code.length} characters`);
                     readerWriter ??= createReaderWriter();
                     bundler ??= new CSpellDictionaryBundler(readerWriter);
 
@@ -49,15 +52,17 @@ export function createPlugin(): UnpluginInstance<Options | undefined, false> {
                 },
             },
             resolveId: {
-                // filter: {
-                //     id: { include: options.include, exclude: options.exclude },
-                // },
+                filter: {
+                    id: { include: options.include, exclude: options.exclude },
+                },
                 handler(id, importer) {
-                    console.log(`Can Resolve ${id}? ${filter(id) ? 'yes' : 'no'} %o`, { id, importer });
+                    consoleLog(`Can Resolve ${id}? ${filter(id) ? 'yes' : 'no'} %o`, { id, importer });
                     if (id.includes('\0') || !filter(id)) return undefined;
-                    const importedFromUrl = pathToFileURL(importer || process.cwd() + '/');
-                    const resolvedId = fileURLToPath(import.meta.resolve(id, importedFromUrl));
-                    console.log(`Resolving ${id}: %o`, import.meta.resolve(id));
+                    const resolvedId = resolveId(id, importer);
+                    if (!resolvedId) return undefined;
+                    consoleLog(`Resolving ${id}: %o`, {
+                        resolvedId,
+                    });
                     return {
                         id: resolvedId,
                         external: false,
@@ -69,6 +74,20 @@ export function createPlugin(): UnpluginInstance<Options | undefined, false> {
     });
 }
 
+function resolveId(id: string, importer?: string): string | undefined {
+    if (id.includes('\0')) return undefined;
+    const dir = (importer ? path.dirname(importer) : process.cwd()) + '/';
+    if (id.startsWith('./') || id.startsWith('../')) {
+        return path.resolve(dir, id);
+    }
+    const require = createRequire(pathToFileURL(dir));
+    try {
+        return require.resolve(id, { paths: [dir] });
+    } catch {
+        return undefined;
+    }
+}
+
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
 
 export type OptionsResolved = Overwrite<Required<Options>, Pick<Options, 'enforce' | 'exclude'>>;
@@ -78,5 +97,6 @@ export function resolveOptions(options: Options): OptionsResolved {
         include: options.include || [/.*cspell(?:[-]ext)?(\..*)?\.(?:jsonc?|ya?ml|toml)$/i],
         exclude: options.exclude || undefined,
         enforce: 'enforce' in options ? options.enforce : 'pre',
+        debug: !!options.debug,
     };
 }

packages/cspell-dictionary-bundler-plugin/src/core/options.ts

@@ -4,4 +4,5 @@ export interface Options {
     include?: FilterPattern | undefined;
     exclude?: FilterPattern | undefined;
     enforce?: 'pre' | 'post' | undefined;
+    debug?: boolean;
 }

packages/cspell-io/src/VirtualFS/CVirtualFS.ts

@@ -3,8 +3,10 @@ import type { CSpellIO } from '../CSpellIO.js';
 import { getDefaultCSpellIO } from '../CSpellIONode.js';
 import type { Disposable } from '../models/index.js';
 import type { LogEvent } from '../models/LogEvent.js';
+import { CSPELL_VFS_PROTOCOL } from './constants.js';
 import { CVFileSystem } from './CVFileSystem.js';
 import { VFSErrorUnsupportedRequest } from './errors.js';
+import { MemFileSystemProvider } from './MemVfsProvider.js';
 import type { UrlOrReference, VFileSystem, VFileSystemCore } from './VFileSystem.js';
 import type { NextProvider, VFileSystemProvider, VirtualFS } from './VirtualFS.js';
 import { debug } from './VirtualFS.js';
@@ -161,6 +163,7 @@ export function createVirtualFS(cspellIO?: CSpellIO): VirtualFS {
     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: VirtualFS | undefined = undefined;

packages/cspell-io/src/VirtualFS/MemVfsProvider.ts

@@ -115,7 +115,6 @@ export class MemVFileSystem implements VProviderFileSystem {
      * It is up to the provider to define what information is available.
      */
     readonly providerInfo: FileSystemProviderInfo;
-    readonly hasProvider: boolean = true;
 
     dispose(): void {
         this.#files.clear();

packages/cspell-io/src/VirtualFS/constants.ts

@@ -0,0 +1 @@
+export const CSPELL_VFS_PROTOCOL = 'cspell-vfs:' as const;

packages/cspell-io/src/VirtualFS/index.ts

@@ -1,3 +1,4 @@
+export { CSPELL_VFS_PROTOCOL } from './constants.js';
 export { CVFileSystem } from './CVFileSystem.js';
 export { createVirtualFS, getDefaultVirtualFs } from './CVirtualFS.js';
 export { VFSError, VFSErrorUnsupportedRequest, VFSNotImplemented, VFSNotSupported } from './errors.js';

packages/cspell-io/src/__snapshots__/index.test.ts.snap

@@ -4,6 +4,7 @@ exports[`index > api 1`] = `
 [
   "CFileReference => function",
   "CFileResource => function",
+  "CSPELL_VFS_PROTOCOL => string",
   "CSpellIONode => function",
   "FSCapabilityFlags => object",
   "VFileType => object",

packages/cspell-io/src/index.ts

@@ -30,4 +30,10 @@ export type {
     VirtualFS,
     VProviderFileSystem,
 } from './VirtualFS/index.js';
-export { createRedirectProvider, createVirtualFS, FSCapabilityFlags, getDefaultVirtualFs } from './VirtualFS/index.js';
+export {
+    createRedirectProvider,
+    createVirtualFS,
+    CSPELL_VFS_PROTOCOL,
+    FSCapabilityFlags,
+    getDefaultVirtualFs,
+} from './VirtualFS/index.js';