cspell-lib 8.2.4 → 8.3.0

package/dist/esm/Settings/Controller/configLoader/configLoader.d.ts

@@ -49,6 +49,7 @@ export interface IConfigLoader {
      * @returns the resulting settings
      */
     searchForConfig(searchFrom: URL | string | undefined, pnpSettings?: PnPSettingsOptional): Promise<CSpellSettingsI | undefined>;
+    resolveConfigFileLocation(filenameOrURL: string | URL, relativeTo?: string | URL): Promise<URL | undefined>;
     getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
     /**
      * The loader caches configuration files for performance. This method clears the cache.
@@ -71,12 +72,15 @@ export interface IConfigLoader {
      */
     dispose(): void;
     getStats(): Readonly<Record<string, Readonly<Record<string, number>>>>;
+    readonly isTrusted: boolean;
+    setIsTrusted(isTrusted: boolean): void;
 }
 export declare class ConfigLoader implements IConfigLoader {
     readonly fs: VFileSystem;
     readonly templateVariables: Record<string, string>;
     onReady: Promise<void>;
     readonly fileResolver: FileResolver;
+    private _isTrusted;
     /**
      * Use `createConfigLoader`
      * @param virtualFs - virtual file system to use.
@@ -107,7 +111,9 @@ export declare class ConfigLoader implements IConfigLoader {
     getGlobalSettings(): CSpellSettingsI;
     getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
     clearCachedSettingsFiles(): void;
+    protected init(): Promise<void>;
     protected prefetchGlobalSettingsAsync(): Promise<void>;
+    protected resolveDefaultConfig(): Promise<URL>;
     protected importSettings(fileRef: ImportFileRef, pnpSettings: PnPSettingsOptional | undefined, backReferences: string[]): ImportedConfigEntry;
     private setupPnp;
     mergeConfigFileWithImports(cfgFile: CSpellConfigFile, pnpSettings: PnPSettingsOptional | undefined, referencedBy?: string[] | undefined): Promise<CSpellSettingsI>;
@@ -124,7 +130,10 @@ export declare class ConfigLoader implements IConfigLoader {
         cacheMergeListUnique: Readonly<import("../../../util/AutoResolve.js").CacheStats>;
         cacheMergeLists: Readonly<import("../../../util/AutoResolve.js").CacheStats>;
     };
+    resolveConfigFileLocation(filenameOrURL: string | URL, relativeTo: string | URL): Promise<URL | undefined>;
     private resolveFilename;
+    get isTrusted(): boolean;
+    setIsTrusted(isTrusted: boolean): void;
 }
 declare class ConfigLoaderInternal extends ConfigLoader {
     constructor(vfs: VFileSystem);

package/dist/esm/Settings/Controller/configLoader/configLoader.js

@@ -4,6 +4,7 @@ import { isUrlLike, toFileURL } from 'cspell-io';
 import path from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
 import { URI, Utils as UriUtils } from 'vscode-uri';
+import { srcDirectory } from '../../../../lib-cjs/index.cjs';
 import { onClearCache } from '../../../events/index.js';
 import { getVirtualFS } from '../../../fileSystem.js';
 import { createCSpellSettingsInternal as csi } from '../../../Models/CSpellSettingsInternalDef.js';
@@ -12,7 +13,7 @@ import { logError, logWarning } from '../../../util/logger.js';
 import { FileResolver } from '../../../util/resolveFile.js';
 import { envToTemplateVars } from '../../../util/templates.js';
 import { addTrailingSlash, cwdURL, resolveFileWithURL, toFilePathOrHref, windowsDriveLetterToUpper, } from '../../../util/url.js';
-import { configSettingsFileVersion0_1, configSettingsFileVersion0_2, currentSettingsFileVersion, ENV_CSPELL_GLOB_ROOT, } from '../../constants.js';
+import { configSettingsFileVersion0_1, configSettingsFileVersion0_2, currentSettingsFileVersion, defaultConfigFileModuleRef, ENV_CSPELL_GLOB_ROOT, } from '../../constants.js';
 import { getMergeStats, mergeSettings } from '../../CSpellSettingsServer.js';
 import { getGlobalConfig } from '../../GlobalSettings.js';
 import { ImportError } from '../ImportError.js';
@@ -28,11 +29,19 @@ const setOfSupportedConfigVersions = Object.freeze(new Set(supportedCSpellConfig
 export const sectionCSpell = 'cSpell';
 export const defaultFileName = 'cspell.json';
 let defaultConfigLoader = undefined;
+const defaultExtensions = ['.json', '.yaml', '.yml', '.jsonc'];
+const defaultJsExtensions = ['.js', '.cjs', '.mjs'];
+const trustedSearch = new Map([
+    ['*', defaultExtensions],
+    ['file:', [...defaultExtensions, ...defaultJsExtensions]],
+]);
+const unTrustedSearch = new Map([['*', defaultExtensions]]);
 export class ConfigLoader {
     fs;
     templateVariables;
     onReady;
     fileResolver;
+    _isTrusted = true;
     /**
      * Use `createConfigLoader`
      * @param virtualFs - virtual file system to use.
@@ -40,10 +49,10 @@ export class ConfigLoader {
     constructor(fs, templateVariables = envToTemplateVars(process.env)) {
         this.fs = fs;
         this.templateVariables = templateVariables;
-        this.configSearch = new ConfigSearch(searchPlaces, fs);
+        this.configSearch = new ConfigSearch(searchPlaces, trustedSearch, fs);
         this.cspellConfigFileReaderWriter = createReaderWriter(undefined, undefined, createIO(fs));
         this.fileResolver = new FileResolver(fs, this.templateVariables);
-        this.onReady = this.prefetchGlobalSettingsAsync();
+        this.onReady = this.init();
         this.subscribeToEvents();
     }
     subscribeToEvents() {
@@ -140,10 +149,19 @@ export class ConfigLoader {
         this.cachedMergedConfig = new WeakMap();
         this.prefetchGlobalSettingsAsync();
     }
-    prefetchGlobalSettingsAsync() {
-        this.onReady = this.getGlobalSettingsAsync().then(() => undefined, (e) => logError(e));
+    init() {
+        this.onReady = Promise.all([this.prefetchGlobalSettingsAsync(), this.resolveDefaultConfig()]).then(() => undefined);
         return this.onReady;
     }
+    async prefetchGlobalSettingsAsync() {
+        await this.getGlobalSettingsAsync().catch((e) => logError(e));
+    }
+    async resolveDefaultConfig() {
+        const r = await this.fileResolver.resolveFile(defaultConfigFileModuleRef, srcDirectory);
+        const url = toFileURL(r.filename);
+        this.cspellConfigFileReaderWriter.setTrustedUrls([new URL('../..', url)]);
+        return url;
+    }
     importSettings(fileRef, pnpSettings, backReferences) {
         const url = toFileURL(fileRef.filename);
         const cacheKey = url.href;
@@ -318,6 +336,10 @@ export class ConfigLoader {
     getStats() {
         return { ...getMergeStats() };
     }
+    async resolveConfigFileLocation(filenameOrURL, relativeTo) {
+        const r = await this.fileResolver.resolveFile(filenameOrURL, relativeTo);
+        return r.found ? toFileURL(r.filename) : undefined;
+    }
     async resolveFilename(filename, relativeTo) {
         if (filename instanceof URL)
             return { filename: toFilePathOrHref(filename) };
@@ -332,6 +354,15 @@ export class ConfigLoader {
             error: r.found ? undefined : new Error(`Failed to resolve file: "${filename}"`),
         };
     }
+    get isTrusted() {
+        return this._isTrusted;
+    }
+    setIsTrusted(isTrusted) {
+        this._isTrusted = isTrusted;
+        this.clearCachedSettingsFiles();
+        this.configSearch = new ConfigSearch(searchPlaces, isTrusted ? trustedSearch : unTrustedSearch, this.fs);
+        this.cspellConfigFileReaderWriter.setUntrustedExtensions(isTrusted ? [] : defaultJsExtensions);
+    }
 }
 class ConfigLoaderInternal extends ConfigLoader {
     constructor(vfs) {

package/dist/esm/Settings/Controller/configLoader/configSearch.d.ts

@@ -1,10 +1,17 @@
 import type { VFileSystem } from '../../../fileSystem.js';
 export declare class ConfigSearch {
     readonly searchPlaces: readonly string[];
+    readonly allowedExtensionsByProtocol: Map<string, readonly string[]>;
     private fs;
     private searchCache;
     private searchDirCache;
-    constructor(searchPlaces: readonly string[], fs: VFileSystem);
+    private searchPlacesByProtocol;
+    /**
+     * @param searchPlaces - The list of file names to search for.
+     * @param allowedExtensionsByProtocol - Map of allowed extensions by protocol, '*' is used to match all protocols.
+     * @param fs - The file system to use.
+     */
+    constructor(searchPlaces: readonly string[], allowedExtensionsByProtocol: Map<string, readonly string[]>, fs: VFileSystem);
     searchForConfig(searchFromURL: URL): Promise<URL | undefined>;
     clearCache(): void;
     private findUpConfigPath;

package/dist/esm/Settings/Controller/configLoader/configSearch.js

@@ -1,15 +1,25 @@
+import { extname } from 'node:path/posix';
 import { urlBasename } from 'cspell-io';
 import { createAutoResolveCache } from '../../../util/AutoResolve.js';
 import { findUpFromUrl } from '../../../util/findUpFromUrl.js';
 export class ConfigSearch {
     searchPlaces;
+    allowedExtensionsByProtocol;
     fs;
     searchCache = new Map();
     searchDirCache = new Map();
-    constructor(searchPlaces, fs) {
+    searchPlacesByProtocol;
+    /**
+     * @param searchPlaces - The list of file names to search for.
+     * @param allowedExtensionsByProtocol - Map of allowed extensions by protocol, '*' is used to match all protocols.
+     * @param fs - The file system to use.
+     */
+    constructor(searchPlaces, allowedExtensionsByProtocol, fs) {
         this.searchPlaces = searchPlaces;
+        this.allowedExtensionsByProtocol = allowedExtensionsByProtocol;
         this.fs = fs;
-        this.searchPlaces = searchPlaces;
+        this.searchPlacesByProtocol = setupSearchPlacesByProtocol(searchPlaces, allowedExtensionsByProtocol);
+        this.searchPlaces = this.searchPlacesByProtocol.get('*') || searchPlaces;
     }
     searchForConfig(searchFromURL) {
         const dirUrl = new URL('.', searchFromURL);
@@ -105,7 +115,8 @@ export class ConfigSearch {
         const hasFile = this.fs.getCapabilities(dir).readDirectory
             ? this.createHasFileDirSearch()
             : this.createHasFileStatCheck();
-        for (const searchPlace of this.searchPlaces) {
+        const searchPlaces = this.searchPlacesByProtocol.get(dir.protocol) || this.searchPlaces;
+        for (const searchPlace of searchPlaces) {
             const file = new URL(searchPlace, dir);
             const found = await hasFile(file);
             if (found) {
@@ -118,6 +129,12 @@ export class ConfigSearch {
         return undefined;
     }
 }
+function setupSearchPlacesByProtocol(searchPlaces, allowedExtensionsByProtocol) {
+    const map = new Map([...allowedExtensionsByProtocol.entries()]
+        .map(([k, v]) => [k, new Set(v)])
+        .map(([protocol, exts]) => [protocol, searchPlaces.filter((url) => exts.has(extname(url)))]));
+    return map;
+}
 async function checkPackageJson(fs, filename) {
     try {
         const file = await fs.readFile(filename);

package/dist/esm/Settings/DefaultSettings.js

@@ -3,11 +3,11 @@ import { srcDirectory } from '../../lib-cjs/index.cjs';
 import { createCSpellSettingsInternal } from '../Models/CSpellSettingsInternalDef.js';
 import { PatternRegExp } from '../Models/PatternRegExp.js';
 import { resolveFile } from '../util/resolveFile.js';
+import { defaultConfigFileModuleRef } from './constants.js';
 import { readSettings } from './Controller/configLoader/index.js';
 import { mergeSettings } from './CSpellSettingsServer.js';
 import * as LanguageSettings from './LanguageSettings.js';
 import * as RegPat from './RegExpPatterns.js';
-const defaultConfigFileModuleRef = '@cspell/cspell-bundled-dicts/cspell-default.json';
 // Do not use require.resolve because webpack will mess it up.
 const defaultConfigFile = () => resolveConfigModule(defaultConfigFileModuleRef);
 const regExpSpellCheckerDisable = [

package/dist/esm/Settings/constants.d.ts

@@ -2,4 +2,5 @@ export declare const configSettingsFileVersion0_1 = "0.1";
 export declare const configSettingsFileVersion0_2 = "0.2";
 export declare const currentSettingsFileVersion = "0.2";
 export declare const ENV_CSPELL_GLOB_ROOT = "CSPELL_GLOB_ROOT";
+export declare const defaultConfigFileModuleRef = "@cspell/cspell-bundled-dicts/cspell-default.json";
 //# sourceMappingURL=constants.d.ts.map

package/dist/esm/Settings/constants.js

@@ -2,4 +2,5 @@ export const configSettingsFileVersion0_1 = '0.1';
 export const configSettingsFileVersion0_2 = '0.2';
 export const currentSettingsFileVersion = configSettingsFileVersion0_2;
 export const ENV_CSPELL_GLOB_ROOT = 'CSPELL_GLOB_ROOT';
+export const defaultConfigFileModuleRef = '@cspell/cspell-bundled-dicts/cspell-default.json';
 //# sourceMappingURL=constants.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "8.2.4",
+  "version": "8.3.0",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -57,21 +57,21 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.2.4",
-    "@cspell/cspell-pipe": "8.2.4",
-    "@cspell/cspell-resolver": "8.2.4",
-    "@cspell/cspell-types": "8.2.4",
-    "@cspell/dynamic-import": "8.2.4",
-    "@cspell/strong-weak-map": "8.2.4",
+    "@cspell/cspell-bundled-dicts": "8.3.0",
+    "@cspell/cspell-pipe": "8.3.0",
+    "@cspell/cspell-resolver": "8.3.0",
+    "@cspell/cspell-types": "8.3.0",
+    "@cspell/dynamic-import": "8.3.0",
+    "@cspell/strong-weak-map": "8.3.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
     "configstore": "^6.0.0",
-    "cspell-config-lib": "8.2.4",
-    "cspell-dictionary": "8.2.4",
-    "cspell-glob": "8.2.4",
-    "cspell-grammar": "8.2.4",
-    "cspell-io": "8.2.4",
-    "cspell-trie-lib": "8.2.4",
+    "cspell-config-lib": "8.3.0",
+    "cspell-dictionary": "8.3.0",
+    "cspell-glob": "8.3.0",
+    "cspell-grammar": "8.3.0",
+    "cspell-io": "8.3.0",
+    "cspell-trie-lib": "8.3.0",
     "fast-equals": "^5.0.1",
     "gensequence": "^6.0.0",
     "import-fresh": "^3.3.0",
@@ -95,5 +95,5 @@
     "cspell-dict-nl-nl": "^1.1.2",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "d3c5ff685b3aa2bf984f557d81380f2c994547e0"
+  "gitHead": "019c7ccd326b7fc9e106069ddf6008d5079bbd12"
 }