cspell-lib 8.1.0 → 8.1.2

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

@@ -31,7 +31,46 @@ interface CacheMergeConfigFileWithImports {
     referencedBy: string[] | undefined;
     result: Promise<CSpellSettingsI>;
 }
-export declare class ConfigLoader {
+export interface IConfigLoader {
+    readSettingsAsync(filename: string | URL, relativeTo?: string | URL, pnpSettings?: PnPSettingsOptional): Promise<CSpellSettingsI>;
+    /**
+     * Read a cspell configuration file.
+     * @param filenameOrURL - URL, relative path, absolute path, or package name.
+     * @param relativeTo - optional URL, defaults to `pathToFileURL('./')`
+     */
+    readConfigFile(filenameOrURL: string | URL, relativeTo?: string | URL): Promise<CSpellConfigFile | Error>;
+    searchForConfigFileLocation(searchFrom: URL | string | undefined): Promise<URL | undefined>;
+    searchForConfigFile(searchFrom: URL | string | undefined): Promise<CSpellConfigFile | undefined>;
+    /**
+     * This is an alias for `searchForConfigFile` and `mergeConfigFileWithImports`.
+     * @param searchFrom the directory / file URL to start searching from.
+     * @param pnpSettings - related to Using Yarn PNP.
+     * @returns the resulting settings
+     */
+    searchForConfig(searchFrom: URL | string | undefined, pnpSettings?: PnPSettingsOptional): Promise<CSpellSettingsI | undefined>;
+    getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
+    /**
+     * The loader caches configuration files for performance. This method clears the cache.
+     */
+    clearCachedSettingsFiles(): void;
+    /**
+     * Resolve imports and merge.
+     * @param cfgFile - configuration file.
+     * @param pnpSettings - optional settings related to Using Yarn PNP.
+     */
+    mergeConfigFileWithImports(cfgFile: CSpellConfigFile, pnpSettings?: PnPSettingsOptional | undefined): Promise<CSpellSettingsI>;
+    /**
+     * Create an in memory CSpellConfigFile.
+     * @param filename - URL to the file. Used to resolve imports.
+     * @param settings - settings to use.
+     */
+    createCSpellConfigFile(filename: URL | string, settings: CSpellUserSettings): CSpellConfigFile;
+    /**
+     * Unsubscribe from any events and dispose of any resources including caches.
+     */
+    dispose(): void;
+}
+export declare class ConfigLoader implements IConfigLoader {
     readonly cspellIO: CSpellIO;
     onReady: Promise<void>;
     /**
@@ -64,6 +103,7 @@ export declare class ConfigLoader {
     getGlobalSettings(): CSpellSettingsI;
     getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
     clearCachedSettingsFiles(): void;
+    protected prefetchGlobalSettingsAsync(): Promise<void>;
     protected importSettings(fileRef: ImportFileRef, pnpSettings: PnPSettingsOptional | undefined, backReferences: string[]): ImportedConfigEntry;
     private setupPnp;
     mergeConfigFileWithImports(cfgFile: CSpellConfigFile, pnpSettings: PnPSettingsOptional | undefined, referencedBy?: string[] | undefined): Promise<CSpellSettingsI>;
@@ -83,7 +123,7 @@ declare class ConfigLoaderInternal extends ConfigLoader {
 }
 export declare function loadPnP(pnpSettings: PnPSettingsOptional, searchFrom: URL): Promise<LoaderResult>;
 declare function validateRawConfigVersion(config: CSpellConfigFile): void;
-export declare function createConfigLoader(cspellIO?: CSpellIO): ConfigLoader;
+export declare function createConfigLoader(cspellIO?: CSpellIO): IConfigLoader;
 export declare function getDefaultConfigLoaderInternal(): ConfigLoaderInternal;
 export declare const __testing__: {
     getDefaultConfigLoaderInternal: typeof getDefaultConfigLoaderInternal;

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

@@ -2,7 +2,7 @@ import assert from 'assert';
 import { createReaderWriter, CSpellConfigFileInMemory } from 'cspell-config-lib';
 import { getDefaultCSpellIO } from 'cspell-io';
 import * as path from 'path';
-import { fileURLToPath } from 'url';
+import { fileURLToPath, pathToFileURL } from 'url';
 import { onClearCache } from '../../../events/index.js';
 import { createCSpellSettingsInternal as csi } from '../../../Models/CSpellSettingsInternalDef.js';
 import { AutoResolveCache } from '../../../util/AutoResolve.js';
@@ -35,7 +35,7 @@ export class ConfigLoader {
     constructor(cspellIO) {
         this.cspellIO = cspellIO;
         this.cspellConfigFileReaderWriter = createReaderWriter(undefined, undefined, createIO(cspellIO));
-        this.onReady = this.getGlobalSettingsAsync().then(() => undefined, (e) => logError(e));
+        this.onReady = this.prefetchGlobalSettingsAsync();
         this.subscribeToEvents();
     }
     subscribeToEvents() {
@@ -50,12 +50,13 @@ export class ConfigLoader {
     configSearch = new ConfigSearch(searchPlaces);
     toDispose = [];
     async readSettingsAsync(filename, relativeTo, pnpSettings) {
-        const ref = resolveFilename(filename, relativeTo || process.cwd());
+        await this.onReady;
+        const ref = resolveFilename(filename, relativeTo || pathToFileURL('./'));
         const entry = this.importSettings(ref, pnpSettings || defaultPnPSettings, []);
         return entry.onReady;
     }
     async readConfigFile(filenameOrURL, relativeTo) {
-        const ref = resolveFilename(filenameOrURL.toString(), relativeTo || process.cwd());
+        const ref = resolveFilename(filenameOrURL.toString(), relativeTo || pathToFileURL('./'));
         const url = this.cspellIO.toFileURL(ref.filename);
         const href = url.href;
         if (ref.error)
@@ -103,7 +104,7 @@ export class ConfigLoader {
         return this.mergeConfigFileWithImports(configFile, pnpSettings);
     }
     getGlobalSettings() {
-        assert(this.globalSettings);
+        assert(this.globalSettings, 'Global settings not loaded');
         return this.globalSettings;
     }
     async getGlobalSettingsAsync() {
@@ -123,6 +124,11 @@ export class ConfigLoader {
         this.cachedPendingConfigFile.clear();
         this.cspellConfigFileReaderWriter.clearCachedFiles();
         this.cachedMergedConfig = new WeakMap();
+        this.prefetchGlobalSettingsAsync();
+    }
+    prefetchGlobalSettingsAsync() {
+        this.onReady = this.getGlobalSettingsAsync().then(() => undefined, (e) => logError(e));
+        return this.onReady;
     }
     importSettings(fileRef, pnpSettings, backReferences) {
         const url = this.cspellIO.toFileURL(fileRef.filename);

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

@@ -1,5 +1,5 @@
 import type { CSpellConfigFile } from 'cspell-config-lib';
-import type { ConfigLoader } from './configLoader.js';
+import type { IConfigLoader } from './configLoader.js';
 import type { PnPSettingsOptional } from './PnPSettings.js';
 import type { CSpellSettingsI, CSpellSettingsWST } from './types.js';
 /**
@@ -29,6 +29,6 @@ export declare function getGlobalSettings(): CSpellSettingsI;
 export declare function getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
 export declare function getCachedFileSize(): number;
 export declare function clearCachedSettingsFiles(): void;
-export declare function getDefaultConfigLoader(): ConfigLoader;
+export declare function getDefaultConfigLoader(): IConfigLoader;
 export declare function readRawSettings(filename: string | URL, relativeTo?: string | URL): Promise<CSpellSettingsWST>;
 //# sourceMappingURL=defaultConfigLoader.d.ts.map

package/dist/esm/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, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
 export { extractImportErrors, ImportFileRefWithError } from './extractImportErrors.js';
 export { readSettings } from './readSettings.js';
 export { readSettingsFiles } from './readSettingsFiles.js';

package/dist/esm/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, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
 export { extractImportErrors } from './extractImportErrors.js';
 export { readSettings } from './readSettings.js';
 export { readSettingsFiles } from './readSettingsFiles.js';

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

@@ -1,7 +1,6 @@
 import { getDefaultConfigLoader } from './defaultConfigLoader.js';
 export async function readSettings(filename, relativeToOrPnP, pnpSettings) {
     const loader = getDefaultConfigLoader();
-    await loader.onReady;
     const relativeTo = typeof relativeToOrPnP === 'string' || relativeToOrPnP instanceof URL ? relativeToOrPnP : undefined;
     const pnp = pnpSettings
         ? pnpSettings

package/dist/esm/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, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
+export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, 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/esm/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, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Controller/configLoader/index.js';
+export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, loadPnP, readRawSettings, readSettings, readSettingsFiles, 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/esm/index.d.ts

@@ -8,7 +8,7 @@ export { FeatureFlag, FeatureFlags, getSystemFeatureFlags, UnknownFeatureFlagErr
 export { getLanguagesForBasename as getLanguageIdsForBaseFilename, getLanguagesForExt } from './LanguageIds.js';
 export type { CreateTextDocumentParams, TextDocument, TextDocumentLine, TextDocumentRef, } from './Models/TextDocument.js';
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, type ConfigurationDependencies, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, 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, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Settings/index.js';
 export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';
 export { determineFinalDocumentSettings, DetermineFinalDocumentSettingsResult, spellCheckDocument, spellCheckFile, SpellCheckFileOptions, SpellCheckFileResult, } from './spellCheckFile.js';

package/dist/esm/index.js

@@ -5,7 +5,7 @@ export { fileToDocument, fileToTextDocument, isBinaryFile } from './Document/ind
 export { FeatureFlags, getSystemFeatureFlags, UnknownFeatureFlagError } from './FeatureFlags/index.js';
 export { getLanguagesForBasename as getLanguageIdsForBaseFilename, getLanguagesForExt } from './LanguageIds.js';
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, 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, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Settings/index.js';
 export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';
 export { determineFinalDocumentSettings, spellCheckDocument, spellCheckFile, } from './spellCheckFile.js';

package/dist/esm/util/url.js

@@ -15,8 +15,7 @@ export function toFilePathOrHref(url) {
  * @returns URL for the source directory
  */
 export function getSourceDirectoryUrl() {
-    const base = pathToFileURL(srcDirectory);
-    const srcDirectoryURL = new URL(base.pathname + '/', base);
+    const srcDirectoryURL = pathToFileURL(path.join(srcDirectory, '/'));
     return srcDirectoryURL;
 }
 /**
@@ -28,7 +27,7 @@ export function relativeTo(path, relativeTo) {
     return new URL(normalizePathSlashesForUrl(path), relativeTo || cwdURL());
 }
 export function cwdURL() {
-    return pathToFileURL(process.cwd() + '/');
+    return pathToFileURL('./');
 }
 export function resolveFileWithURL(file, relativeToURL) {
     if (file instanceof URL)

package/dist/lib-cjs/pkg-info.cjs

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.srcDirectory = void 0;
+// import { join } from 'path';
+// export const srcDirectory = join(__dirname, '/');
 exports.srcDirectory = __dirname;
 //# sourceMappingURL=pkg-info.cjs.map

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "cspell-lib",
-  "version": "8.1.0",
+  "version": "8.1.2",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
+  "sideEffects": false,
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
   "exports": {
@@ -56,21 +57,21 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.1.0",
-    "@cspell/cspell-pipe": "8.1.0",
-    "@cspell/cspell-resolver": "8.1.0",
-    "@cspell/cspell-types": "8.1.0",
-    "@cspell/dynamic-import": "8.1.0",
-    "@cspell/strong-weak-map": "8.1.0",
+    "@cspell/cspell-bundled-dicts": "8.1.2",
+    "@cspell/cspell-pipe": "8.1.2",
+    "@cspell/cspell-resolver": "8.1.2",
+    "@cspell/cspell-types": "8.1.2",
+    "@cspell/dynamic-import": "8.1.2",
+    "@cspell/strong-weak-map": "8.1.2",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
     "configstore": "^6.0.0",
-    "cspell-config-lib": "8.1.0",
-    "cspell-dictionary": "8.1.0",
-    "cspell-glob": "8.1.0",
-    "cspell-grammar": "8.1.0",
-    "cspell-io": "8.1.0",
-    "cspell-trie-lib": "8.1.0",
+    "cspell-config-lib": "8.1.2",
+    "cspell-dictionary": "8.1.2",
+    "cspell-glob": "8.1.2",
+    "cspell-grammar": "8.1.2",
+    "cspell-io": "8.1.2",
+    "cspell-trie-lib": "8.1.2",
     "fast-equals": "^5.0.1",
     "gensequence": "^6.0.0",
     "import-fresh": "^3.3.0",
@@ -94,5 +95,5 @@
     "cspell-dict-nl-nl": "^1.1.2",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "28568808deaf39b9ffa71fd0f722441ff1b8c794"
+  "gitHead": "ba4eef94480562e7641298b32cb99723fd64aeca"
 }