cspell-lib 8.15.1 → 8.15.2

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

@@ -1,6 +1,5 @@
 import type { CSpellUserSettings, ImportFileRef } from '@cspell/cspell-types';
-import type { CSpellConfigFile, CSpellConfigFileReaderWriter } from 'cspell-config-lib';
-import { CSpellConfigFileInMemory } from 'cspell-config-lib';
+import { CSpellConfigFile, CSpellConfigFileReaderWriter, ICSpellConfigFile } from 'cspell-config-lib';
 import type { VFileSystem } from '../../../fileSystem.js';
 import { AutoResolveCache } from '../../../util/AutoResolve.js';
 import { FileResolver } from '../../../util/resolveFile.js';
@@ -75,6 +74,12 @@ export interface IConfigLoader {
      * @param settings - settings to use.
      */
     createCSpellConfigFile(filename: URL | string, settings: CSpellUserSettings): CSpellConfigFile;
+    /**
+     * Convert a ICSpellConfigFile into a CSpellConfigFile.
+     * If cfg is a CSpellConfigFile, it is returned as is.
+     * @param cfg - configuration file to convert.
+     */
+    toCSpellConfigFile(cfg: ICSpellConfigFile): CSpellConfigFile;
     /**
      * Unsubscribe from any events and dispose of any resources including caches.
      */
@@ -99,7 +104,7 @@ export declare class ConfigLoader implements IConfigLoader {
     protected cachedConfigFiles: Map<string, CSpellConfigFile>;
     protected cachedPendingConfigFile: AutoResolveCache<string, Promise<Error | CSpellConfigFile>>;
     protected cachedMergedConfig: WeakMap<CSpellConfigFile, CacheMergeConfigFileWithImports>;
-    protected cachedCSpellConfigFileInMemory: WeakMap<import("@cspell/cspell-types").CSpellSettings, Map<string, CSpellConfigFileInMemory>>;
+    protected cachedCSpellConfigFileInMemory: WeakMap<import("@cspell/cspell-types").CSpellSettings, Map<string, CSpellConfigFile>>;
     protected globalSettings: CSpellSettingsI | undefined;
     protected cspellConfigFileReaderWriter: CSpellConfigFileReaderWriter;
     protected configSearch: ConfigSearch;
@@ -131,7 +136,7 @@ export declare class ConfigLoader implements IConfigLoader {
     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>;
+    mergeConfigFileWithImports(cfg: CSpellConfigFile | ICSpellConfigFile, pnpSettings: PnPSettingsOptional | undefined, referencedBy?: string[] | undefined): Promise<CSpellSettingsI>;
     private _mergeConfigFileWithImports;
     /**
      * normalizeSettings handles correcting all relative paths, anchoring globs, and importing other config files.
@@ -140,6 +145,7 @@ export declare class ConfigLoader implements IConfigLoader {
      */
     protected mergeImports(cfgFile: CSpellConfigFile, importedSettings: CSpellUserSettings[]): Promise<CSpellSettingsI>;
     createCSpellConfigFile(filename: URL | string, settings: CSpellUserSettings): CSpellConfigFile;
+    toCSpellConfigFile(cfg: ICSpellConfigFile): CSpellConfigFile;
     dispose(): void;
     getStats(): {
         cacheMergeListUnique: Readonly<import("../../../util/AutoResolve.js").CacheStats>;

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

@@ -1,7 +1,8 @@
 import assert from 'node:assert';
 import path from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'node:url';
-import { createReaderWriter, CSpellConfigFileInMemory } from 'cspell-config-lib';
+import { CSpellConfigFile } from 'cspell-config-lib';
+import { createReaderWriter } from 'cspell-config-lib';
 import { isUrlLike, toFileURL } from 'cspell-io';
 import { URI, Utils as UriUtils } from 'vscode-uri';
 import { onClearCache } from '../../../events/index.js';
@@ -254,7 +255,8 @@ export class ConfigLoader {
         const pathToSettingsDir = new URL('.', cfgFile.url);
         await loadPnP(pnpSettingsToUse, pathToSettingsDir);
     }
-    mergeConfigFileWithImports(cfgFile, pnpSettings, referencedBy) {
+    mergeConfigFileWithImports(cfg, pnpSettings, referencedBy) {
+        const cfgFile = this.toCSpellConfigFile(cfg);
         const cached = this.cachedMergedConfig.get(cfgFile);
         if (cached && cached.pnpSettings === pnpSettings && cached.referencedBy === referencedBy) {
             return cached.result;
@@ -333,7 +335,12 @@ export class ConfigLoader {
     }
     createCSpellConfigFile(filename, settings) {
         const map = autoResolveWeak(this.cachedCSpellConfigFileInMemory, settings, () => new Map());
-        return autoResolve(map, filename, () => new CSpellConfigFileInMemory(toFileURL(filename), settings));
+        return autoResolve(map, filename, () => this.cspellConfigFileReaderWriter.toCSpellConfigFile({ url: toFileURL(filename), settings }));
+    }
+    toCSpellConfigFile(cfg) {
+        if (cfg instanceof CSpellConfigFile)
+            return cfg;
+        return this.createCSpellConfigFile(cfg.url, cfg.settings);
     }
     dispose() {
         while (this.toDispose.length) {

package/dist/lib/Settings/Controller/configLoader/defaultConfigLoader.d.ts

@@ -1,5 +1,5 @@
 import type { CSpellSettings } from '@cspell/cspell-types';
-import type { CSpellConfigFile } from 'cspell-config-lib';
+import type { CSpellConfigFile, ICSpellConfigFile } from 'cspell-config-lib';
 import type { IConfigLoader } from './configLoader.js';
 import type { PnPSettingsOptional } from './PnPSettings.js';
 import type { CSpellSettingsI, CSpellSettingsWST } from './types.js';
@@ -25,6 +25,7 @@ export declare function loadConfig(file: string, pnpSettings?: PnPSettingsOption
  */
 export declare function resolveSettingsImports(settings: CSpellSettings, filename: string | URL): Promise<CSpellSettingsI>;
 export declare function readConfigFile(filename: string | URL, relativeTo?: string | URL): Promise<CSpellConfigFile>;
+export declare function resolveConfigFileImports(configFile: CSpellConfigFile | ICSpellConfigFile): Promise<CSpellSettingsI>;
 /**
  * Might throw if the settings have not yet been loaded.
  * @deprecated use {@link getGlobalSettingsAsync} instead.

package/dist/lib/Settings/Controller/configLoader/defaultConfigLoader.js

@@ -38,6 +38,9 @@ export async function readConfigFile(filename, relativeTo) {
     }
     return result;
 }
+export async function resolveConfigFileImports(configFile) {
+    return gcl().mergeConfigFileWithImports(configFile, configFile.settings);
+}
 /**
  * Might throw if the settings have not yet been loaded.
  * @deprecated use {@link getGlobalSettingsAsync} instead.

package/dist/lib/Settings/Controller/configLoader/index.d.ts

@@ -1,6 +1,6 @@
 export { __testing__, ConfigLoader, createConfigLoader, defaultFileName, loadPnP, sectionCSpell, } from './configLoader.js';
 export { defaultConfigFilenames } from './configLocations.js';
-export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, resolveSettingsImports, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readConfigFile, readRawSettings, resolveConfigFileImports, resolveSettingsImports, searchForConfig, } from './defaultConfigLoader.js';
 export { extractImportErrors, ImportFileRefWithError } from './extractImportErrors.js';
 export { readSettings } from './readSettings.js';
 export { readSettingsFiles } from './readSettingsFiles.js';

package/dist/lib/Settings/Controller/configLoader/index.js

@@ -1,6 +1,6 @@
 export { __testing__, ConfigLoader, createConfigLoader, defaultFileName, loadPnP, sectionCSpell, } from './configLoader.js';
 export { defaultConfigFilenames } from './configLocations.js';
-export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, resolveSettingsImports, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readConfigFile, readRawSettings, resolveConfigFileImports, resolveSettingsImports, searchForConfig, } from './defaultConfigLoader.js';
 export { extractImportErrors } from './extractImportErrors.js';
 export { readSettings } from './readSettings.js';
 export { readSettingsFiles } from './readSettingsFiles.js';

package/dist/lib/Settings/index.d.ts

@@ -1,7 +1,7 @@
 export { calcOverrideSettings } from './calcOverrideSettings.js';
 export { checkFilenameMatchesGlob } from './checkFilenameMatchesGlob.js';
 export { currentSettingsFileVersion, ENV_CSPELL_GLOB_ROOT } from './constants.js';
-export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, resolveSettingsImports, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
+export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, resolveSettingsImports, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
 export { ImportError } from './Controller/ImportError.js';
 export type { ConfigurationDependencies, ImportFileRefWithError } from './CSpellSettingsServer.js';
 export { extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, } from './CSpellSettingsServer.js';

package/dist/lib/Settings/index.js

@@ -1,7 +1,7 @@
 export { calcOverrideSettings } from './calcOverrideSettings.js';
 export { checkFilenameMatchesGlob } from './checkFilenameMatchesGlob.js';
 export { currentSettingsFileVersion, ENV_CSPELL_GLOB_ROOT } from './constants.js';
-export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, resolveSettingsImports, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
+export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, resolveSettingsImports, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
 export { ImportError } from './Controller/ImportError.js';
 export { extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, } from './CSpellSettingsServer.js';
 export { defaultSettingsLoader, getDefaultBundledSettingsAsync, getDefaultSettings } from './DefaultSettings.js';

package/dist/lib/index.d.ts

@@ -12,7 +12,7 @@ export type { CreateTextDocumentParams, TextDocument, TextDocumentLine, TextDocu
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
 export type { PerfTimer } from './perf/index.js';
 export { createPerfTimer } from './perf/index.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, type ConfigurationDependencies, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, type ImportFileRefWithError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Settings/index.js';
+export { calcOverrideSettings, checkFilenameMatchesGlob, type ConfigurationDependencies, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, type ImportFileRefWithError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, } from './Settings/index.js';
 export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
 export * as Link from './Settings/index.link.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';

package/dist/lib/index.js

@@ -7,7 +7,7 @@ export { getLanguagesForBasename as getLanguageIdsForBaseFilename, getLanguagesF
 export { getDictionary } from './getDictionary.js';
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
 export { createPerfTimer } from './perf/index.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Settings/index.js';
+export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, } from './Settings/index.js';
 export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
 export * as Link from './Settings/index.link.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "8.15.1",
+  "version": "8.15.2",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -64,22 +64,22 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.15.1",
-    "@cspell/cspell-pipe": "8.15.1",
-    "@cspell/cspell-resolver": "8.15.1",
-    "@cspell/cspell-types": "8.15.1",
-    "@cspell/dynamic-import": "8.15.1",
-    "@cspell/filetypes": "8.15.1",
-    "@cspell/strong-weak-map": "8.15.1",
-    "@cspell/url": "8.15.1",
+    "@cspell/cspell-bundled-dicts": "8.15.2",
+    "@cspell/cspell-pipe": "8.15.2",
+    "@cspell/cspell-resolver": "8.15.2",
+    "@cspell/cspell-types": "8.15.2",
+    "@cspell/dynamic-import": "8.15.2",
+    "@cspell/filetypes": "8.15.2",
+    "@cspell/strong-weak-map": "8.15.2",
+    "@cspell/url": "8.15.2",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.5",
-    "cspell-config-lib": "8.15.1",
-    "cspell-dictionary": "8.15.1",
-    "cspell-glob": "8.15.1",
-    "cspell-grammar": "8.15.1",
-    "cspell-io": "8.15.1",
-    "cspell-trie-lib": "8.15.1",
+    "cspell-config-lib": "8.15.2",
+    "cspell-dictionary": "8.15.2",
+    "cspell-glob": "8.15.2",
+    "cspell-grammar": "8.15.2",
+    "cspell-io": "8.15.2",
+    "cspell-trie-lib": "8.15.2",
     "env-paths": "^3.0.0",
     "fast-equals": "^5.0.1",
     "gensequence": "^7.0.0",
@@ -93,14 +93,14 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@cspell/dict-cpp": "^5.1.19",
-    "@cspell/dict-csharp": "^4.0.2",
-    "@cspell/dict-css": "^4.0.13",
-    "@cspell/dict-fa-ir": "^4.0.0",
-    "@cspell/dict-fr-fr": "^2.2.2",
-    "@cspell/dict-html": "^4.0.6",
-    "@cspell/dict-nl-nl": "^2.3.0",
-    "@cspell/dict-python": "^4.2.8",
+    "@cspell/dict-cpp": "^5.1.22",
+    "@cspell/dict-csharp": "^4.0.5",
+    "@cspell/dict-css": "^4.0.16",
+    "@cspell/dict-fa-ir": "^4.0.3",
+    "@cspell/dict-fr-fr": "^2.2.5",
+    "@cspell/dict-html": "^4.0.9",
+    "@cspell/dict-nl-nl": "^2.3.3",
+    "@cspell/dict-python": "^4.2.11",
     "@types/configstore": "^6.0.2",
     "configstore": "^7.0.0",
     "cspell-dict-nl-nl": "^1.1.2",
@@ -108,5 +108,5 @@
     "lorem-ipsum": "^2.0.8",
     "perf-insight": "^1.2.0"
   },
-  "gitHead": "6a99d22627f0e360fcfc5b98afa670464ec763f6"
+  "gitHead": "63f8b976a0711780646f63283cf4f0457db740ee"
 }