cspell-lib 8.9.0 → 8.10.0

package/dist/esm/Document/isBinaryDoc.d.ts

@@ -1,5 +1,5 @@
 import type { Uri } from '../util/Uri.js';
 import type { Document } from './Document.js';
 export declare function isBinaryDoc(document: Document): boolean;
-export declare function isBinaryFile(filename: Uri | URL | string, languageId?: string | string[]): boolean;
+export declare function isBinaryFile(filename: Uri | URL | string, languageId?: string | string[], text?: string): boolean;
 //# sourceMappingURL=isBinaryDoc.d.ts.map

package/dist/esm/Document/isBinaryDoc.js

@@ -1,10 +1,10 @@
-import { isGenerated, isGeneratedFile } from '../LanguageIds.js';
+import { getLanguagesForBasename, isGenerated } from '../LanguageIds.js';
 import { basename, toUri } from '../util/Uri.js';
 import { normalizeLanguageIds } from './normalizeLanguageIds.js';
 export function isBinaryDoc(document) {
-    return isBinaryFile(toUri(document.uri), document.languageId);
+    return isBinaryFile(toUri(document.uri), document.languageId, document.text);
 }
-export function isBinaryFile(filename, languageId) {
+export function isBinaryFile(filename, languageId, text) {
     const filenameUri = toUri(filename);
     if (languageId) {
         const ids = normalizeLanguageIds(languageId);
@@ -12,6 +12,10 @@ export function isBinaryFile(filename, languageId) {
             return isGenerated(ids);
     }
     const file = basename(filenameUri);
-    return isGeneratedFile(file);
+    const ids = getLanguagesForBasename(file);
+    if (ids.length)
+        return isGenerated(ids);
+    // Unknown file type, check the content.
+    return text?.slice(0, 1024).includes('\u0000') || false;
 }
 //# sourceMappingURL=isBinaryDoc.js.map

package/dist/esm/Document/resolveDocument.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { TextDocument } from '../Models/TextDocument.js';
 import type { Document, DocumentWithText } from './Document.js';
 export declare function fileToDocument(file: string): Document;

package/dist/esm/LanguageIds.js

@@ -216,7 +216,7 @@ export const languageExtensionDefinitions = [
     },
     {
         id: 'video',
-        extensions: ['.mov', '.mpg'],
+        extensions: ['.mov', '.mpg', '.mpeg', '.mp4', '.avi', '.wmv', '.mkv', '.flv'],
         format: 'Binary',
     },
     {

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

@@ -1,5 +1,6 @@
 import type { CSpellUserSettings, ImportFileRef } from '@cspell/cspell-types';
 import type { CSpellConfigFile, CSpellConfigFileReaderWriter } from 'cspell-config-lib';
+import { CSpellConfigFileInMemory } from 'cspell-config-lib';
 import type { VFileSystem } from '../../../fileSystem.js';
 import { AutoResolveCache } from '../../../util/AutoResolve.js';
 import { FileResolver } from '../../../util/resolveFile.js';
@@ -55,6 +56,13 @@ export interface IConfigLoader {
      * The loader caches configuration files for performance. This method clears the cache.
      */
     clearCachedSettingsFiles(): void;
+    /**
+     * Resolve and merge the settings from the imports.
+     * This will create a virtual configuration file that is used to resolve the settings.
+     * @param settings - settings to resolve imports for
+     * @param filename - the path / URL to the settings file. Used to resolve imports.
+     */
+    resolveSettingsImports(settings: CSpellUserSettings, filename: string | URL): Promise<CSpellSettingsI>;
     /**
      * Resolve imports and merge.
      * @param cfgFile - configuration file.
@@ -91,6 +99,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 globalSettings: CSpellSettingsI | undefined;
     protected cspellConfigFileReaderWriter: CSpellConfigFileReaderWriter;
     protected configSearch: ConfigSearch;
@@ -111,6 +120,12 @@ export declare class ConfigLoader implements IConfigLoader {
     getGlobalSettings(): CSpellSettingsI;
     getGlobalSettingsAsync(): Promise<CSpellSettingsI>;
     clearCachedSettingsFiles(): void;
+    /**
+     * Resolve and merge the settings from the imports.
+     * @param settings - settings to resolve imports for
+     * @param filename - the path / URL to the settings file. Used to resolve imports.
+     */
+    resolveSettingsImports(settings: CSpellUserSettings, filename: string | URL): Promise<CSpellSettingsI>;
     protected init(): Promise<void>;
     protected prefetchGlobalSettingsAsync(): Promise<void>;
     protected resolveDefaultConfig(): Promise<URL>;
@@ -146,8 +161,8 @@ export declare function createConfigLoader(fs?: VFileSystem): IConfigLoader;
 export declare function getDefaultConfigLoaderInternal(): ConfigLoaderInternal;
 export declare class ConfigurationLoaderError extends Error {
     readonly configurationFile?: string | undefined;
-    readonly relativeTo?: string | URL | undefined;
-    constructor(message: string, configurationFile?: string | undefined, relativeTo?: string | URL | undefined, cause?: unknown);
+    readonly relativeTo?: (string | URL) | undefined;
+    constructor(message: string, configurationFile?: string | undefined, relativeTo?: (string | URL) | undefined, cause?: unknown);
 }
 export declare class ConfigurationLoaderFailedToResolveError extends ConfigurationLoaderError {
     readonly configurationFile: string;

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

@@ -8,7 +8,7 @@ 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';
-import { AutoResolveCache } from '../../../util/AutoResolve.js';
+import { autoResolve, AutoResolveCache, autoResolveWeak } from '../../../util/AutoResolve.js';
 import { logError, logWarning } from '../../../util/logger.js';
 import { FileResolver } from '../../../util/resolveFile.js';
 import { envToTemplateVars } from '../../../util/templates.js';
@@ -62,6 +62,7 @@ export class ConfigLoader {
     cachedConfigFiles = new Map();
     cachedPendingConfigFile = new AutoResolveCache();
     cachedMergedConfig = new WeakMap();
+    cachedCSpellConfigFileInMemory = new WeakMap();
     globalSettings;
     cspellConfigFileReaderWriter;
     configSearch;
@@ -147,8 +148,18 @@ export class ConfigLoader {
         this.cachedPendingConfigFile.clear();
         this.cspellConfigFileReaderWriter.clearCachedFiles();
         this.cachedMergedConfig = new WeakMap();
+        this.cachedCSpellConfigFileInMemory = new WeakMap();
         this.prefetchGlobalSettingsAsync();
     }
+    /**
+     * Resolve and merge the settings from the imports.
+     * @param settings - settings to resolve imports for
+     * @param filename - the path / URL to the settings file. Used to resolve imports.
+     */
+    resolveSettingsImports(settings, filename) {
+        const settingsFile = this.createCSpellConfigFile(filename, settings);
+        return this.mergeConfigFileWithImports(settingsFile, settings);
+    }
     init() {
         this.onReady = Promise.all([this.prefetchGlobalSettingsAsync(), this.resolveDefaultConfig()]).then(() => undefined);
         return this.onReady;
@@ -321,7 +332,8 @@ export class ConfigLoader {
         return finalizeSettings;
     }
     createCSpellConfigFile(filename, settings) {
-        return new CSpellConfigFileInMemory(toFileURL(filename), settings);
+        const map = autoResolveWeak(this.cachedCSpellConfigFileInMemory, settings, () => new Map());
+        return autoResolve(map, filename, () => new CSpellConfigFileInMemory(toFileURL(filename), settings));
     }
     dispose() {
         while (this.toDispose.length) {

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

@@ -1,3 +1,4 @@
+import type { CSpellSettings } from '@cspell/cspell-types';
 import type { CSpellConfigFile } from 'cspell-config-lib';
 import type { IConfigLoader } from './configLoader.js';
 import type { PnPSettingsOptional } from './PnPSettings.js';
@@ -16,6 +17,13 @@ export declare function searchForConfig(searchFrom: URL | string | undefined, pn
  * @returns normalized CSpellSettings
  */
 export declare function loadConfig(file: string, pnpSettings?: PnPSettingsOptional): Promise<CSpellSettingsI>;
+/**
+ * Resolve the imports in the settings file.
+ * @param settings - settings to resolve imports for
+ * @param filename - the filename of the settings file, use cwd if not available.
+ * @returns
+ */
+export declare function resolveSettingsImports(settings: CSpellSettings, filename: string | URL): Promise<CSpellSettingsI>;
 export declare function readConfigFile(filename: string | URL, relativeTo?: string | URL): Promise<CSpellConfigFile>;
 /**
  * Might throw if the settings have not yet been loaded.

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

@@ -22,6 +22,15 @@ export function searchForConfig(searchFrom, pnpSettings = defaultPnPSettings) {
 export async function loadConfig(file, pnpSettings) {
     return gcl().readSettingsAsync(file, undefined, pnpSettings);
 }
+/**
+ * Resolve the imports in the settings file.
+ * @param settings - settings to resolve imports for
+ * @param filename - the filename of the settings file, use cwd if not available.
+ * @returns
+ */
+export async function resolveSettingsImports(settings, filename) {
+    return gcl().resolveSettingsImports(settings, filename);
+}
 export async function readConfigFile(filename, relativeTo) {
     const result = await gcl().readConfigFile(filename, relativeTo);
     if (result instanceof Error) {

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, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, resolveSettingsImports, 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, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, searchForConfig, } from './defaultConfigLoader.js';
+export { clearCachedSettingsFiles, getCachedFileSize, getDefaultConfigLoader, getGlobalSettings, getGlobalSettingsAsync, loadConfig, readRawSettings, resolveSettingsImports, 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/normalizeRawSettings.d.ts

@@ -11,16 +11,16 @@ export declare function normalizeDictionaryDefs(settings: NormalizeDictionaryDef
     languageSettings: import("../../../util/types.js").RemoveUndefined<{
         dictionaryDefinitions: import("../../../Models/CSpellSettingsInternalDef.js").DictionaryDefinitionInternalWithSource[] | undefined;
         languageId: import("@cspell/cspell-types").MatchingFileType;
-        locale?: string | string[];
-        local?: string | string[];
+        locale?: import("@cspell/cspell-types").LocaleId | import("@cspell/cspell-types").LocaleId[];
+        local?: import("@cspell/cspell-types").LocaleId | import("@cspell/cspell-types").LocaleId[];
         id?: string;
         name?: string;
         description?: string;
         enabled?: boolean;
         allowCompoundWords?: boolean;
         caseSensitive?: boolean;
-        dictionaries?: string[];
-        noSuggestDictionaries?: string[];
+        dictionaries?: import("@cspell/cspell-types").DictionaryReference[];
+        noSuggestDictionaries?: import("@cspell/cspell-types").DictionaryReference[];
         ignoreRegExpList?: import("@cspell/cspell-types").RegExpPatternList;
         includeRegExpList?: import("@cspell/cspell-types").RegExpPatternList;
         patterns?: import("@cspell/cspell-types").RegExpPatternDefinition[];
@@ -28,7 +28,7 @@ export declare function normalizeDictionaryDefs(settings: NormalizeDictionaryDef
         flagWords?: string[];
         ignoreWords?: string[];
         suggestWords?: string[];
-        parser?: string;
+        parser?: import("@cspell/cspell-types").ParserName;
     }>[] | undefined;
 }>;
 type NormalizeOverrides = Pick<CSpellUserSettings, 'globRoot' | 'overrides'>;

package/dist/esm/Settings/RegExpPatterns.js

@@ -37,7 +37,7 @@ export const regExPhpHereDoc = /<<<['"]?(\w+)['"]?[\s\S]+?^\1;/gm;
 export const regExString = /(?:(['"]).*?(?<![^\\]\\(\\\\)*)\1)|(?:`[\s\S]*?(?<![^\\]\\(\\\\)*)`)/g;
 // Note: the C Style Comments incorrectly considers '/*' and '//' inside of strings as comments.
 export const regExCStyleComments = /(?<!\w:)(?:\/\/.*)|(?:\/\*[\s\S]*?\*\/)/g;
-export const rexExPythonStyleComments = /#.*|(?:('''|""")[^\1]+?\1)/gm;
+export const rexExPythonStyleComments = /#.*|(?:('''|""")[\s\S]+?\1)/gm;
 export const regExEmail = /<?\b[\w.\-+]{1,128}@\w{1,63}(\.\w{1,63}){1,4}\b>?/gi;
 export const regExRepeatedChar = /^(\w)\1{3,}$/i;
 export const regExSha = /\bsha\d+-[a-z0-9+/]{25,}={0,3}/gi;

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, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, 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, 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/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, createConfigLoader, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getDefaultConfigLoader, 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, 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/esm/spellCheckFile.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { CSpellSettingsWithSourceTrace, CSpellUserSettings } from '@cspell/cspell-types';
 import type { Document, DocumentWithText } from './Document/index.js';
 import type { Uri } from './util/Uri.js';

package/dist/esm/spellCheckFile.js

@@ -39,6 +39,17 @@ export async function spellCheckDocument(document, options, settings) {
     try {
         const timer = createPerfTimer('loadFile');
         const doc = await resolveDocument(document).finally(() => timer.end());
+        if (isBinaryDoc(doc)) {
+            return {
+                document,
+                options,
+                settingsUsed: settings,
+                localConfigFilepath: undefined,
+                issues: [],
+                checked: false,
+                errors: undefined,
+            };
+        }
         const result = await spellCheckFullDocument(doc, options, settings);
         const perf = result.perf || {};
         perf.loadTimeMs = timer.elapsed;

package/dist/esm/textValidation/docValidator.d.ts

@@ -25,6 +25,11 @@ export interface DocumentValidatorOptions extends ValidateTextOptions {
      * @defaultValue undefined
      */
     noConfigSearch?: boolean;
+    /**
+     * If `settings: CSpellUserSettings` contains imports, they will be resolved using this path.
+     * If not set, the current working directory will be used.
+     */
+    resolveImportsRelativeTo?: string | URL;
 }
 type PerfTimings = Record<string, number>;
 export declare class DocumentValidator {

package/dist/esm/textValidation/docValidator.js

@@ -1,10 +1,12 @@
 import assert from 'node:assert';
+import { pathToFileURL } from 'node:url';
 import { opConcatMap, opMap, pipeSync } from '@cspell/cspell-pipe/sync';
 import { IssueType } from '@cspell/cspell-types';
+import { toFileURL } from '@cspell/url';
 import { getGlobMatcherForExcluding } from '../globs/getGlobMatcher.js';
 import { updateTextDocument } from '../Models/TextDocument.js';
 import { createPerfTimer } from '../perf/index.js';
-import { finalizeSettings, loadConfig, mergeSettings, searchForConfig } from '../Settings/index.js';
+import { finalizeSettings, loadConfig, mergeSettings, resolveSettingsImports, searchForConfig, } from '../Settings/index.js';
 import { validateInDocumentSettings } from '../Settings/InDocSettings.js';
 import { getDictionaryInternal } from '../SpellingDictionary/index.js';
 import { calcSuggestionAdjustedToToMatchCase } from '../suggestions.js';
@@ -60,7 +62,11 @@ export class DocumentValidator {
     async _prepareAsync() {
         assert(!this._ready);
         const timer = createPerfTimer('_prepareAsync');
-        const { options, settings } = this;
+        const { options, settings: rawSettings } = this;
+        const resolveImportsRelativeTo = toFileURL(options.resolveImportsRelativeTo || pathToFileURL('./virtual.settings.json'));
+        const settings = rawSettings.import?.length
+            ? await resolveSettingsImports(rawSettings, resolveImportsRelativeTo)
+            : rawSettings;
         const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
         const pLocalConfig = options.configFile
             ? loadConfig(options.configFile, settings)

package/dist/esm/textValidation/traceWord.d.ts

@@ -2,15 +2,25 @@ import type { CSpellSettingsWithSourceTrace } from '@cspell/cspell-types';
 import type { SpellingDictionaryCollection } from '../SpellingDictionary/index.js';
 type Href = string;
 export interface DictionaryTraceResult {
+    /** The word being traced. */
     word: string;
     found: boolean;
+    /** The word found. */
     foundWord: string | undefined;
+    /** Indicates that the word is flagged. */
     forbidden: boolean;
+    /** The would should not show up in suggestions, but is considered correct. */
     noSuggest: boolean;
+    /** The name of the dictionary. */
     dictName: string;
+    /** The path/href to dictionary file. */
     dictSource: string;
+    /** Suggested changes to the word. */
+    preferredSuggestions?: string[] | undefined;
+    /** href to the config file referencing the dictionary. */
     configSource: Href | undefined;
-    errors: Error[] | undefined;
+    /** Errors */
+    errors?: Error[] | undefined;
 }
 export interface WordSplits {
     word: string;

package/dist/esm/textValidation/traceWord.js

@@ -5,7 +5,7 @@ import { uniqueFn } from '../util/util.js';
 import { split } from '../util/wordSplitter.js';
 export function traceWord(word, dictCollection, config) {
     const opts = {
-        ignoreCase: true,
+        ignoreCase: config.ignoreCase ?? true,
         useCompounds: config.allowCompoundWords || false,
     };
     const splits = split({ text: word, offset: 0 }, 0, checkWord);
@@ -35,6 +35,7 @@ export function traceWord(word, dictCollection, config) {
  */
 function unpackDictionaryFindResult(found, config) {
     const { word, dict, findResult } = found;
+    const dictPreferred = getPreferred(dict, word);
     const baseResult = {
         word,
         found: !!findResult?.found,
@@ -44,6 +45,7 @@ function unpackDictionaryFindResult(found, config) {
         dictName: dict.name,
         dictSource: dict.source,
         configSource: undefined,
+        preferredSuggestions: dictPreferred,
         errors: normalizeErrors(dict.getErrors?.()),
     };
     const configFieldName = mapSpecialDictionaryNamesToSettings.get(dict.name);
@@ -68,7 +70,8 @@ function unpackDictionaryFindResult(found, config) {
         const cfg = { [configFieldName]: src[configFieldName] };
         const cfgDict = createCollection(getInlineConfigDictionaries(cfg), dict.name, configSource);
         const findResult = cfgDict.find(word, opts);
-        if (!findResult?.found)
+        const preferredSuggestions = getPreferred(cfgDict, word);
+        if (!findResult?.found && !preferredSuggestions)
             continue;
         const result = {
             word,
@@ -79,24 +82,21 @@ function unpackDictionaryFindResult(found, config) {
             dictName: dict.name,
             dictSource: configSource,
             configSource,
+            preferredSuggestions,
             errors: normalizeErrors(dict.getErrors?.()),
         };
         results.push(result);
-        // console.log('unpackDictFindResult %o', {
-        //     id: src.id,
-        //     name: src.name,
-        //     filename: src.source?.filename,
-        //     configFieldName,
-        //     findResult,
-        //     cfg,
-        //     result,
-        // });
     }
     return results.length ? results : [baseResult];
 }
 function normalizeErrors(errors) {
     return errors?.length ? errors : undefined;
 }
+function getPreferred(dict, word) {
+    const sugs = dict.getPreferredSuggestions?.(word);
+    const preferred = sugs?.length ? sugs.filter((s) => s.isPreferred).map((s) => s.word) : undefined;
+    return preferred;
+}
 class CTraceResult extends Array {
     splits = [];
     constructor(...items) {

package/dist/esm/trace.d.ts

@@ -1,17 +1,9 @@
 import type { CSpellSettings, LocaleId } from '@cspell/cspell-types';
 import type { LanguageId } from './LanguageIds.js';
-import type { WordSplits } from './textValidation/traceWord.js';
-export interface TraceResult {
-    word: string;
-    found: boolean;
-    foundWord: string | undefined;
-    forbidden: boolean;
-    noSuggest: boolean;
-    dictName: string;
-    dictSource: string;
+import type { DictionaryTraceResult, WordSplits } from './textValidation/traceWord.js';
+export interface TraceResult extends DictionaryTraceResult {
+    /** True if the dictionary is currently active. */
     dictActive: boolean;
-    configSource: string;
-    errors: Error[] | undefined;
 }
 export interface TraceOptions {
     languageId?: LanguageId | LanguageId[];

package/dist/esm/util/errors.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 declare function getTypeOf(t: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
 export declare function isErrnoException(e: unknown): e is NodeJS.ErrnoException;
 export declare function isError(e: unknown): e is Error;

package/dist/esm/util/findUpFromUrl.d.ts

@@ -1,6 +1,6 @@
 import type { VFileSystem } from '../fileSystem.js';
 type EntryType = 'file' | 'directory' | '!file' | '!directory';
-export type FindUpFileSystem = Pick<VFileSystem, 'stat'>;
+export type FindUpFileSystem = Pick<VFileSystem, 'findUp'>;
 export interface FindUpURLOptions {
     type?: EntryType;
     stopAt?: URL;

package/dist/esm/util/findUpFromUrl.js

@@ -1,44 +1,6 @@
 import { getVirtualFS } from '../fileSystem.js';
 export async function findUpFromUrl(name, from, options = {}) {
-    const { type: entryType = 'file', stopAt, fs = getVirtualFS().fs } = options;
-    let dir = new URL('.', from);
-    const root = new URL('/', dir);
-    const predicate = makePredicate(fs, name, entryType);
-    const stopAtDir = stopAt || root;
-    let last = '';
-    while (dir.href !== last) {
-        const found = await predicate(dir);
-        if (found !== undefined)
-            return found;
-        last = dir.href;
-        if (dir.href === root.href || dir.href === stopAtDir.href)
-            break;
-        dir = new URL('..', dir);
-    }
-    return undefined;
-}
-function makePredicate(fs, name, entryType) {
-    if (typeof name === 'function')
-        return name;
-    const checkStat = entryType === 'file' || entryType === '!file' ? 'isFile' : 'isDirectory';
-    const checkValue = entryType.startsWith('!') ? false : true;
-    function checkName(dir, name) {
-        const f = new URL(name, dir);
-        return fs
-            .stat(f)
-            .then((stats) => ((stats.isUnknown() || stats[checkStat]() === checkValue) && f) || undefined)
-            .catch(() => undefined);
-    }
-    if (!Array.isArray(name))
-        return (dir) => checkName(dir, name);
-    return async (dir) => {
-        const pending = name.map((n) => checkName(dir, n));
-        for (const p of pending) {
-            const found = await p;
-            if (found)
-                return found;
-        }
-        return undefined;
-    };
+    const fs = options.fs ?? getVirtualFS().fs;
+    return fs.findUp(name, from, options);
 }
 //# sourceMappingURL=findUpFromUrl.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "8.9.0",
+  "version": "8.10.0",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -59,21 +59,21 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.9.0",
-    "@cspell/cspell-pipe": "8.9.0",
-    "@cspell/cspell-resolver": "8.9.0",
-    "@cspell/cspell-types": "8.9.0",
-    "@cspell/dynamic-import": "8.9.0",
-    "@cspell/strong-weak-map": "8.9.0",
-    "@cspell/url": "8.9.0",
+    "@cspell/cspell-bundled-dicts": "8.10.0",
+    "@cspell/cspell-pipe": "8.10.0",
+    "@cspell/cspell-resolver": "8.10.0",
+    "@cspell/cspell-types": "8.10.0",
+    "@cspell/dynamic-import": "8.10.0",
+    "@cspell/strong-weak-map": "8.10.0",
+    "@cspell/url": "8.10.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
-    "cspell-config-lib": "8.9.0",
-    "cspell-dictionary": "8.9.0",
-    "cspell-glob": "8.9.0",
-    "cspell-grammar": "8.9.0",
-    "cspell-io": "8.9.0",
-    "cspell-trie-lib": "8.9.0",
+    "cspell-config-lib": "8.10.0",
+    "cspell-dictionary": "8.10.0",
+    "cspell-glob": "8.10.0",
+    "cspell-grammar": "8.10.0",
+    "cspell-io": "8.10.0",
+    "cspell-trie-lib": "8.10.0",
     "env-paths": "^3.0.0",
     "fast-equals": "^5.0.1",
     "gensequence": "^7.0.0",
@@ -101,5 +101,5 @@
     "leaked-handles": "^5.2.0",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "33c513cf848a61fb1ebcea1b9c67505a31447411"
+  "gitHead": "a5dde6ae7e2ac86ac956220d4b8c39a0e58e1bc6"
 }