cspell-lib 10.3.5 → 10.4.0-alpha.1

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export * from './lib/index.js';
+export type { CheckTextInfo, ConfigurationDependencies, CreateTextDocumentParams, CSpellConfigFile, DetermineFinalDocumentSettingsResult, DictionaryReferenceCollection, Document, DocumentValidatorOptions, ExcludeFilesGlobMap, ExclusionFunction, FeatureFlag, ICSpellConfigFile, ImportFileRefWithError, IncludeExcludeOptions, Logger, PerfTimer, SpellCheckFileOptions, SpellCheckFilePerf, SpellCheckFileResult, SpellingDictionary, SpellingDictionaryCollection, SuggestedWord, SuggestionCollector, SuggestionOptions, SuggestionResult, SuggestionsForWordResult, SuggestOptions, TextDocument, TextDocumentLine, TextDocumentRef, TextInfoItem, TraceOptions, TraceResult, TraceWordResult, ValidationIssue, VFileSystemProvider, VirtualFS, } from './lib/index.js';
+export { asyncIterableToArray, calcOverrideSettings, checkFilenameMatchesGlob, checkText, checkTextDocument, clearCachedFiles, clearCaches, combineTextAndLanguageSettings, CompoundWordsMethod, constructSettingsForText, createConfigLoader, createDictionaryReferenceCollection, createPerfTimer, createSpellingDictionary, createSpellingDictionaryCollection, createTextDocument, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultSettingsFilename, determineFinalDocumentSettings, DocumentValidator, ENV_CSPELL_GLOB_ROOT, ExclusionHelper, extractDependencies, extractImportErrors, FeatureFlags, fileToDocument, fileToTextDocument, finalizeSettings, FSCapabilityFlags, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getDictionary, getGlobalSettings, getGlobalSettingsAsync, getLanguageIdsForBaseFilename, getLanguagesForExt, getLogger, getSources, getSystemFeatureFlags, getVirtualFS, ImportError, IncludeExcludeFlag, isBinaryFile, isSpellingDictionaryLoadError, Link, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readFile, readFileSync, readRawSettings, readSettings, readSettingsFiles, refreshDictionaryCache, resolveConfigFileImports, resolveFile, searchForConfig, sectionCSpell, setLogger, shouldCheckDocument, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, SpellingDictionaryLoadError, SuggestionError, suggestionsForWord, suggestionsForWords, Text, toCSpellSettingsWithOutSourceTrace, traceWords, traceWordsAsync, UnknownFeatureFlagError, updateTextDocument, validateText, writeToFile, writeToFileIterable, writeToFileIterableP, } from './lib/index.js';
+export * from '@cspell/cspell-types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,3 @@
-export * from './lib/index.js';
+export { asyncIterableToArray, calcOverrideSettings, checkFilenameMatchesGlob, checkText, checkTextDocument, clearCachedFiles, clearCaches, combineTextAndLanguageSettings, CompoundWordsMethod, constructSettingsForText, createConfigLoader, createDictionaryReferenceCollection, createPerfTimer, createSpellingDictionary, createSpellingDictionaryCollection, createTextDocument, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultSettingsFilename, determineFinalDocumentSettings, DocumentValidator, ENV_CSPELL_GLOB_ROOT, ExclusionHelper, extractDependencies, extractImportErrors, FeatureFlags, fileToDocument, fileToTextDocument, finalizeSettings, FSCapabilityFlags, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getDictionary, getGlobalSettings, getGlobalSettingsAsync, getLanguageIdsForBaseFilename, getLanguagesForExt, getLogger, getSources, getSystemFeatureFlags, getVirtualFS, ImportError, IncludeExcludeFlag, isBinaryFile, isSpellingDictionaryLoadError, Link, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readFile, readFileSync, readRawSettings, readSettings, readSettingsFiles, refreshDictionaryCache, resolveConfigFileImports, resolveFile, searchForConfig, sectionCSpell, setLogger, shouldCheckDocument, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, SpellingDictionaryLoadError, SuggestionError, suggestionsForWord, suggestionsForWords, Text, toCSpellSettingsWithOutSourceTrace, traceWords, traceWordsAsync, UnknownFeatureFlagError, updateTextDocument, validateText, writeToFile, writeToFileIterable, writeToFileIterableP, } from './lib/index.js';
+export * from '@cspell/cspell-types';
 //# sourceMappingURL=index.js.map

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

@@ -1,10 +1,14 @@
+import type { TextEncoding } from 'cspell-io';
+import type { BufferEncoding } from '../Models/BufferEncoding.js';
 import type { TextDocument } from '../Models/TextDocument.js';
 import type { Document, DocumentWithText } from './Document.js';
+type DocumentEncoding = Extract<BufferEncoding, TextEncoding>;
 export declare function fileToDocument(file: string): Document;
 export declare function fileToDocument(file: string, text: string, languageId?: string, locale?: string): DocumentWithText;
 export declare function fileToDocument(file: string, text?: string, languageId?: string, locale?: string): Document | DocumentWithText;
 export declare function fileToTextDocument(file: string): Promise<TextDocument>;
 export declare function documentToTextDocument(document: DocumentWithText): TextDocument;
 export declare function resolveDocumentToTextDocument(doc: Document): Promise<TextDocument>;
-export declare function resolveDocument(document: DocumentWithText | Document, encoding?: BufferEncoding): Promise<DocumentWithText>;
+export declare function resolveDocument(document: DocumentWithText | Document, encoding?: DocumentEncoding): Promise<DocumentWithText>;
+export {};
 //# sourceMappingURL=resolveDocument.d.ts.map

package/dist/lib/Document/resolveDocument.js

@@ -1,4 +1,5 @@
 import { readFile } from 'node:fs/promises';
+import { readTextFile } from '../fileSystem.js';
 import { createTextDocument } from '../Models/TextDocument.js';
 import * as Uri from '../util/Uri.js';
 import { clean } from '../util/util.js';
@@ -33,11 +34,18 @@ export function resolveDocument(document, encoding) {
     if (isDocumentWithText(document))
         return Promise.resolve(document);
     const uri = Uri.toUri(document.uri);
-    if (uri.scheme !== 'file') {
+    if (uri.scheme === 'stdin') {
         throw new Error(`Unsupported schema: "${uri.scheme}", open "${uri.toString()}"`);
     }
+    if (uri.scheme !== 'file') {
+        return readDocumentFromUrl(document.uri, encoding);
+    }
     return readDocument(Uri.uriToFilePath(uri), encoding);
 }
+async function readDocumentFromUrl(uri, encoding = defaultEncoding) {
+    const text = await readTextFile(Uri.documentUriToURL(uri), encoding);
+    return { uri, text };
+}
 function isDocumentWithText(doc) {
     return doc.text !== undefined;
 }

package/dist/lib/Models/BufferEncoding.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The text encodings Node.js supports, the same as its global `BufferEncoding`.
+ * Declared here so the published types do not need `@types/node`.
+ */
+export type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'utf-16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex';
+//# sourceMappingURL=BufferEncoding.d.ts.map

package/dist/lib/Models/BufferEncoding.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BufferEncoding.js.map

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

@@ -1,4 +1,6 @@
-export * from './Dictionaries.js';
-export * from './SpellingDictionary.js';
-export * from './SpellingDictionaryError.js';
+export type { DictionaryNameFields } from './Dictionaries.js';
+export { getDictionaryInternal, getInlineConfigDictionaries, loadDictionaryDefs, mapSpecialDictionaryNamesToSettings, refreshDictionaryCache, specialDictionaryNames, } from './Dictionaries.js';
+export type { FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary.js';
+export { CompoundWordsMethod, createCollection, createInlineSpellingDictionary, createSpellingDictionary, } from './SpellingDictionary.js';
+export { isSpellingDictionaryLoadError, SpellingDictionaryLoadError } from './SpellingDictionaryError.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/lib/SpellingDictionary/index.js

@@ -1,4 +1,4 @@
-export * from './Dictionaries.js';
-export * from './SpellingDictionary.js';
-export * from './SpellingDictionaryError.js';
+export { getDictionaryInternal, getInlineConfigDictionaries, loadDictionaryDefs, mapSpecialDictionaryNamesToSettings, refreshDictionaryCache, specialDictionaryNames, } from './Dictionaries.js';
+export { CompoundWordsMethod, createCollection, createInlineSpellingDictionary, createSpellingDictionary, } from './SpellingDictionary.js';
+export { isSpellingDictionaryLoadError, SpellingDictionaryLoadError } from './SpellingDictionaryError.js';
 //# sourceMappingURL=index.js.map

package/dist/lib/spellCheckFile.d.ts

@@ -1,6 +1,7 @@
 import type { CSpellSettingsWithSourceTrace, CSpellUserSettings } from '@cspell/cspell-types';
 import type { ICSpellConfigFile } from 'cspell-config-lib';
 import type { Document, DocumentWithText } from './Document/index.js';
+import type { BufferEncoding } from './Models/BufferEncoding.js';
 import type { ValidationIssueRPC } from './Models/ValidationIssue.js';
 import type { ImportFileRefWithError } from './Settings/index.js';
 import type { Uri } from './util/IUri.js';

package/dist/lib/spellCheckFile.js

@@ -123,15 +123,14 @@ async function spellCheckFullDocument(document, options, settingsOrConfigFile) {
     const docValOptions = options;
     const docValidator = await DocumentValidator.create(doc, docValOptions, settingsOrConfigFile).finally(() => timerPrepare.end());
     Object.assign(perf, Object.fromEntries(Object.entries(docValidator.perfTiming).map(([k, v]) => ['_' + k, v])));
-    const prep = docValidator._getPreparations();
     if (docValidator.errors.length) {
-        const settingsUsed = prep?.localConfig ||
+        const settingsUsed = docValidator._getLocalConfig() ||
             (satisfiesCSpellConfigFile(settingsOrConfigFile) ? settingsOrConfigFile.settings : settingsOrConfigFile);
         return {
             document,
             options,
             settingsUsed,
-            localConfigFilepath: prep?.localConfigFilepath,
+            localConfigFilepath: docValidator._getLocalConfigFilepath(),
             issues: [],
             checked: false,
             errors: docValidator.errors,
@@ -148,7 +147,7 @@ async function spellCheckFullDocument(document, options, settingsOrConfigFile) {
         document,
         options,
         settingsUsed: docValidator.getFinalizedDocSettings(),
-        localConfigFilepath: prep?.localConfigFilepath,
+        localConfigFilepath: docValidator._getLocalConfigFilepath(),
         issues,
         checked: docValidator.shouldCheckDocument(),
         errors: undefined,

package/dist/lib/textValidation/checkText.js

@@ -1,4 +1,3 @@
-import assert from 'node:assert';
 import { resolveDocumentToTextDocument } from '../Document/resolveDocument.js';
 import { isTextDocument } from '../Models/TextDocument.js';
 import * as Settings from '../Settings/index.js';
@@ -57,8 +56,6 @@ export async function genCheckText(docValidator) {
     docValidator.recordCheckedRanges = true;
     await docValidator.prepare();
     const issues = docValidator.checkDocument(true);
-    const preparations = docValidator._getPreparations();
-    assert(preparations);
     return genResult(docValidator.document.text, issues, docValidator.getRangesChecked());
 }
 function genResult(text, issues, includeRanges) {

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

@@ -1,13 +1,12 @@
-import type { CSpellUserSettings, MappedText, ParsedText } from '@cspell/cspell-types';
+import type { CSpellUserSettings, ParsedText } from '@cspell/cspell-types';
 import type { ICSpellConfigFile } from 'cspell-config-lib';
 import type { ExtendedSuggestion } from '../Models/Suggestion.js';
 import type { TextDocument, TextDocumentRef } from '../Models/TextDocument.js';
 import type { ValidationIssue } from '../Models/ValidationIssue.js';
-import type { CSpellSettingsInternal, CSpellSettingsInternalFinalized, ImportFileRefWithError } from '../Settings/index.js';
-import type { SpellingDictionaryCollection } from '../SpellingDictionary/index.js';
+import type { CSpellSettingsInternal, ImportFileRefWithError } from '../Settings/index.js';
 import type { WordSuggestion } from '../suggestions.js';
-import type { MatchRange, SimpleRange, TextTransformer } from '../Transform/index.js';
-import type { TextValidationFactoryOptions, TextValidator } from './lineValidatorFactory.js';
+import type { MatchRange, SimpleRange } from '../Transform/index.js';
+import type { Preparations } from './docValidatorPreparations.js';
 import type { TraceResult } from './traceWord.js';
 import type { ValidateTextOptions } from './ValidateTextOptions.js';
 export interface DocumentValidatorOptions extends ValidateTextOptions {
@@ -117,8 +116,20 @@ export declare class DocumentValidator {
     shouldCheckDocument(): boolean;
     /**
      * Internal `cspell-lib` use.
+     * @deprecated Will be removed in a future major version. Use {@link _getLocalConfig} and
+     * {@link _getLocalConfigFilepath} instead.
      */
     _getPreparations(): Preparations | undefined;
+    /**
+     * Internal `cspell-lib` use.
+     * @returns the config file found for the document, if any.
+     */
+    _getLocalConfig(): CSpellUserSettings | undefined;
+    /**
+     * Internal `cspell-lib` use.
+     * @returns the path of the config file found for the document, if any.
+     */
+    _getLocalConfigFilepath(): string | undefined;
     /**
      * Get the calculated ranges of text that should be included in the spell checking.
      *
@@ -132,22 +143,6 @@ export declare class DocumentValidator {
     set recordCheckedRanges(value: boolean);
 }
 declare function sanitizeSuggestion(sug: WordSuggestion): ExtendedSuggestion;
-interface Preparations {
-    /** loaded config */
-    config: CSpellSettingsInternal;
-    dictionary: SpellingDictionaryCollection;
-    /** configuration after applying in-doc settings */
-    docSettings: CSpellSettingsInternal;
-    finalSettings: CSpellSettingsInternalFinalized;
-    includeRanges: MatchRange[];
-    textValidator: TextValidator;
-    segmenter: (texts: MappedText) => Iterable<MappedText>;
-    shouldCheck: boolean;
-    validateOptions: TextValidationFactoryOptions;
-    localConfig: CSpellUserSettings | undefined;
-    localConfigFilepath: string | undefined;
-    transformer: TextTransformer;
-}
 interface ShouldCheckDocumentResult {
     /** possible errors found while loading configuration. */
     errors: Error[];

package/dist/lib/textValidation/docValidator.js

@@ -10,13 +10,14 @@ import { extractImportErrors, finalizeSettings, loadConfig, mergeSettings, resol
 import { validateInDocumentSettings } from '../Settings/InDocSettings.js';
 import { getDictionaryInternal } from '../SpellingDictionary/index.js';
 import { calcSuggestionAdjustedToToMatchCase } from '../suggestions.js';
-import { chainTransformers, createIntlSegmentTextTransformer, createMappedTextSegmenter, createSoftWordBreakTextTransformer, createSubstitutionTransformer, } from '../Transform/index.js';
+import { chainTransformers, createIntlSegmentTextTransformer, createSoftWordBreakTextTransformer, createSubstitutionTransformer, } from '../Transform/index.js';
 import { catchPromiseError, toError } from '../util/errors.js';
 import { AutoCache } from '../util/simpleCache.js';
 import { uriToFilePath } from '../util/Uri.js';
 import { cleanValidationIssue } from './cleanValidationIssue.js';
 import { defaultMaxDuplicateProblems, defaultMaxNumberOfProblems } from './defaultConstants.js';
 import { determineTextDocumentSettings } from './determineTextDocumentSettings.js';
+import { DocumentValidatorPreparations } from './docValidatorPreparations.js';
 import { textValidatorFactory } from './lineValidatorFactory.js';
 import { settingsToValidateOptions } from './settingsToValidateOptions.js';
 import { calcTextInclusionRanges } from './textValidator.js';
@@ -108,22 +109,18 @@ export class DocumentValidator {
         recShouldCheckTime();
         const recFinalizeTime = recordPerfTime(this.perfTiming, '_finalizeSettings');
         const finalSettings = finalizeSettings(docSettings);
-        const { transformer, validateOptions, includeRanges, segmenter, textValidator } = this.#calcSharedPrep(finalSettings, dict);
+        const { transformer, validateOptions, calcIncludeRanges, textValidator } = this.#calcSharedPrep(finalSettings, dict);
         recFinalizeTime();
-        this._preparations = {
-            config,
+        this._preparations = new DocumentValidatorPreparations(config, localConfig, localConfig?.__importRef?.filename, {
             dictionary: dict,
             docSettings,
             finalSettings,
             shouldCheck,
             validateOptions,
-            includeRanges,
-            segmenter,
             textValidator,
-            localConfig,
-            localConfigFilepath: localConfig?.__importRef?.filename,
             transformer,
-        };
+            calcIncludeRanges,
+        });
         this._ready = true;
         this._preparationTime = timer.elapsed;
         this.perfTiming.prepTime = this._preparationTime;
@@ -138,19 +135,17 @@ export class DocumentValidator {
         const stopMeasure = measurePerf('DocumentValidator._updatePrep');
         const shouldCheck = docSettings.enabled ?? true;
         const finalSettings = finalizeSettings(docSettings);
-        const { transformer, validateOptions, includeRanges, segmenter, textValidator } = this.#calcSharedPrep(finalSettings, dict);
-        this._preparations = {
-            ...prep,
+        const { transformer, validateOptions, calcIncludeRanges, textValidator } = this.#calcSharedPrep(finalSettings, dict);
+        prep.update({
             dictionary: dict,
             docSettings,
             finalSettings,
             shouldCheck,
             validateOptions,
-            includeRanges,
-            segmenter,
             textValidator,
             transformer,
-        };
+            calcIncludeRanges,
+        });
         this._preparationTime = timer.elapsed;
         stopMeasure();
     }
@@ -169,10 +164,10 @@ export class DocumentValidator {
         const validateOptions = { ...settingsToValidateOptions(finalSettings), transformer };
         // Avoid excluding text ranges that have a full substitution applied.
         const rangeTransformer = finalSettings.substitutions?.length ? sub.transformer : undefined;
-        const includeRanges = calcTextInclusionRanges(this._document.text, validateOptions, rangeTransformer);
-        const segmenter = createMappedTextSegmenter(includeRanges);
+        const text = this._document.text;
+        const calcIncludeRanges = () => calcTextInclusionRanges(text, validateOptions, rangeTransformer);
         const textValidator = textValidatorFactory(dict, validateOptions);
-        return { segmenter, textValidator, includeRanges, validateOptions, transformer };
+        return { textValidator, calcIncludeRanges, validateOptions, transformer };
     }
     /**
      * The amount of time in ms to prepare for validation.
@@ -415,10 +410,26 @@ export class DocumentValidator {
     }
     /**
      * Internal `cspell-lib` use.
+     * @deprecated Will be removed in a future major version. Use {@link _getLocalConfig} and
+     * {@link _getLocalConfigFilepath} instead.
      */
     _getPreparations() {
         return this._preparations;
     }
+    /**
+     * Internal `cspell-lib` use.
+     * @returns the config file found for the document, if any.
+     */
+    _getLocalConfig() {
+        return this._preparations?.localConfig;
+    }
+    /**
+     * Internal `cspell-lib` use.
+     * @returns the path of the config file found for the document, if any.
+     */
+    _getLocalConfigFilepath() {
+        return this._preparations?.localConfigFilepath;
+    }
     /**
      * Get the calculated ranges of text that should be included in the spell checking.
      *

package/dist/lib/textValidation/docValidatorPreparations.d.ts

@@ -0,0 +1,74 @@
+import type { CSpellUserSettings, MappedText } from '@cspell/cspell-types';
+import type { CSpellSettingsInternal, CSpellSettingsInternalFinalized } from '../Settings/index.js';
+import type { SpellingDictionaryCollection } from '../SpellingDictionary/index.js';
+import type { MatchRange, TextTransformer } from '../Transform/index.js';
+import type { TextValidationFactoryOptions, TextValidator } from './lineValidatorFactory.js';
+/**
+ * What a `DocumentValidator` needs to spell check its document.
+ */
+export interface Preparations {
+    /** loaded config */
+    config: CSpellSettingsInternal;
+    dictionary: SpellingDictionaryCollection;
+    /** configuration after applying in-doc settings */
+    docSettings: CSpellSettingsInternal;
+    finalSettings: CSpellSettingsInternalFinalized;
+    includeRanges: MatchRange[];
+    textValidator: TextValidator;
+    segmenter: (texts: MappedText) => Iterable<MappedText>;
+    shouldCheck: boolean;
+    validateOptions: TextValidationFactoryOptions;
+    localConfig: CSpellUserSettings | undefined;
+    localConfigFilepath: string | undefined;
+    transformer: TextTransformer;
+}
+/**
+ * The preparations that depend on the document's settings. They are replaced when the document changes.
+ */
+export interface DocumentSettingsPreparations {
+    dictionary: SpellingDictionaryCollection;
+    /** configuration after applying in-doc settings */
+    docSettings: CSpellSettingsInternal;
+    finalSettings: CSpellSettingsInternalFinalized;
+    shouldCheck: boolean;
+    validateOptions: TextValidationFactoryOptions;
+    textValidator: TextValidator;
+    transformer: TextTransformer;
+    /**
+     * Runs every ignore pattern over the whole document, so it is only called once the include ranges are needed.
+     */
+    calcIncludeRanges: () => MatchRange[];
+}
+/**
+ * The include ranges, and the segmenter built from them, are calculated on first use. A document that
+ * is never checked never pays for them.
+ */
+export declare class DocumentValidatorPreparations implements Preparations {
+    #private;
+    readonly config: CSpellSettingsInternal;
+    readonly localConfig: CSpellUserSettings | undefined;
+    readonly localConfigFilepath: string | undefined;
+    dictionary: SpellingDictionaryCollection;
+    /** configuration after applying in-doc settings */
+    docSettings: CSpellSettingsInternal;
+    finalSettings: CSpellSettingsInternalFinalized;
+    shouldCheck: boolean;
+    validateOptions: TextValidationFactoryOptions;
+    textValidator: TextValidator;
+    transformer: TextTransformer;
+    /**
+     * @param config - loaded config
+     * @param localConfig - the config file found for the document, if any.
+     * @param localConfigFilepath - the path of `localConfig`.
+     * @param prep - the preparations that depend on the document's settings.
+     */
+    constructor(config: CSpellSettingsInternal, localConfig: CSpellUserSettings | undefined, localConfigFilepath: string | undefined, prep: DocumentSettingsPreparations);
+    /**
+     * Replace the preparations that depend on the document's settings. The include ranges are
+     * calculated again on next use.
+     */
+    update(prep: DocumentSettingsPreparations): void;
+    get includeRanges(): MatchRange[];
+    get segmenter(): (texts: MappedText) => Iterable<MappedText>;
+}
+//# sourceMappingURL=docValidatorPreparations.d.ts.map

package/dist/lib/textValidation/docValidatorPreparations.js

@@ -0,0 +1,63 @@
+import { createMappedTextSegmenter } from '../Transform/index.js';
+/**
+ * The include ranges, and the segmenter built from them, are calculated on first use. A document that
+ * is never checked never pays for them.
+ */
+export class DocumentValidatorPreparations {
+    config;
+    localConfig;
+    localConfigFilepath;
+    dictionary;
+    /** configuration after applying in-doc settings */
+    docSettings;
+    finalSettings;
+    shouldCheck;
+    validateOptions;
+    textValidator;
+    transformer;
+    #calcIncludeRanges;
+    #includeRanges;
+    #segmenter;
+    /**
+     * @param config - loaded config
+     * @param localConfig - the config file found for the document, if any.
+     * @param localConfigFilepath - the path of `localConfig`.
+     * @param prep - the preparations that depend on the document's settings.
+     */
+    constructor(config, localConfig, localConfigFilepath, prep) {
+        this.config = config;
+        this.localConfig = localConfig;
+        this.localConfigFilepath = localConfigFilepath;
+        this.dictionary = prep.dictionary;
+        this.docSettings = prep.docSettings;
+        this.finalSettings = prep.finalSettings;
+        this.shouldCheck = prep.shouldCheck;
+        this.validateOptions = prep.validateOptions;
+        this.textValidator = prep.textValidator;
+        this.transformer = prep.transformer;
+        this.#calcIncludeRanges = prep.calcIncludeRanges;
+    }
+    /**
+     * Replace the preparations that depend on the document's settings. The include ranges are
+     * calculated again on next use.
+     */
+    update(prep) {
+        this.dictionary = prep.dictionary;
+        this.docSettings = prep.docSettings;
+        this.finalSettings = prep.finalSettings;
+        this.shouldCheck = prep.shouldCheck;
+        this.validateOptions = prep.validateOptions;
+        this.textValidator = prep.textValidator;
+        this.transformer = prep.transformer;
+        this.#calcIncludeRanges = prep.calcIncludeRanges;
+        this.#includeRanges = undefined;
+        this.#segmenter = undefined;
+    }
+    get includeRanges() {
+        return (this.#includeRanges ??= this.#calcIncludeRanges());
+    }
+    get segmenter() {
+        return (this.#segmenter ??= createMappedTextSegmenter(this.includeRanges));
+    }
+}
+//# sourceMappingURL=docValidatorPreparations.js.map

package/dist/rpc.d.ts

@@ -1,2 +1,47 @@
-export * from '@cspell/rpc';
+export type { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+MessagePortLike, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEvent, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyHandler, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyOnceEvent, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClientConfiguration, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClientOptions, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCProtocol, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCProtocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServerConfiguration, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServerOptions, } from '@cspell/rpc';
+export { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+AbortRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+CanceledRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEmitter, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventOnce, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventToPromise, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolDefinition, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClient, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServer, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+TimeoutRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+UnknownMethodRPCRequestError, } from '@cspell/rpc';
 //# sourceMappingURL=rpc.d.ts.map

package/dist/rpc.js

@@ -1,2 +1,26 @@
-export * from '@cspell/rpc';
+export { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+AbortRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+CanceledRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEmitter, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventOnce, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventToPromise, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolDefinition, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClient, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServer, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+TimeoutRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+UnknownMethodRPCRequestError, } from '@cspell/rpc';
 //# sourceMappingURL=rpc.js.map

package/package.json

@@ -1,15 +1,35 @@
 {
   "name": "cspell-lib",
+  "version": "10.4.0-alpha.1",
+  "description": "A library of useful functions used across various cspell tools.",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.5",
-  "description": "A library of useful functions used across various cspell tools.",
-  "type": "module",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/streetsidesoftware/cspell.git",
+    "directory": "packages/cspell-lib"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/issues?q=is%3Aissue%20state%3Aopen%20label%3Acspell-lib"
+  },
+  "keywords": [
+    "spell",
+    "checker",
+    "code",
+    "camel",
+    "case",
+    "spelling",
+    "spell checker",
+    "spelling checker",
+    "lint"
+  ],
+  "license": "MIT",
+  "author": "Jason Dent",
   "sideEffects": false,
-  "types": "dist/index.d.ts",
-  "module": "dist/index.js",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js"
@@ -27,6 +47,8 @@
       "import": "./dist/cspell-rpc/client.js"
     }
   },
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "!**/*.tsbuildInfo",
@@ -38,82 +60,56 @@
     "!**/*.map"
   ],
   "scripts": {
-    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
-    "clean-build": "pnpm clean && pnpm build",
     "build": "tsc -p . && pnpm run build:api",
     "build:api": "tsdown",
-    "watch": "tsc -p . --watch",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
+    "clean-build": "pnpm clean && pnpm build",
     "coverage": "vitest run --coverage --pool=forks",
-    "test-watch": "vitest",
     "prepublishOnly": "pnpm run clean-build",
     "test": "vitest run --pool=forks",
-    "test:update-snapshot": "vitest run -u",
     "test:perf": "NODE_ENV=production insight --file \"**/*.perf.{mjs,js}\"",
+    "test:perf:prof": "NODE_ENV=production node --cpu-prof ../../node_modules/perf-insight/bin.mjs --file \"dist/**/*.perf.{mjs,js}\" -t 1000",
     "test:perf:ts": "NODE_ENV=production insight --file \"**/*.perf.{mts,ts}\" ",
-    "test:perf:prof": "NODE_ENV=production node --cpu-prof ../../node_modules/perf-insight/bin.mjs --file \"dist/**/*.perf.{mjs,js}\" -t 1000"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/streetsidesoftware/cspell.git",
-    "directory": "packages/cspell-lib"
-  },
-  "keywords": [
-    "spell",
-    "checker",
-    "code",
-    "camel",
-    "case",
-    "spelling",
-    "spell checker",
-    "spelling checker",
-    "lint"
-  ],
-  "author": "Jason Dent",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-lib"
+    "test:update-snapshot": "vitest run -u",
+    "test-watch": "vitest",
+    "watch": "tsc -p . --watch"
   },
-  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "10.3.5",
-    "@cspell/cspell-performance-monitor": "10.3.5",
-    "@cspell/cspell-pipe": "10.3.5",
-    "@cspell/cspell-resolver": "10.3.5",
-    "@cspell/cspell-types": "10.3.5",
-    "@cspell/dynamic-import": "10.3.5",
-    "@cspell/filetypes": "10.3.5",
-    "@cspell/rpc": "10.3.5",
-    "@cspell/strong-weak-map": "10.3.5",
-    "@cspell/url": "10.3.5",
-    "cspell-config-lib": "10.3.5",
-    "cspell-dictionary": "10.3.5",
-    "cspell-glob": "10.3.5",
-    "cspell-grammar": "10.3.5",
-    "cspell-io": "10.3.5",
-    "cspell-trie-lib": "10.3.5",
+    "@cspell/cspell-bundled-dicts": "10.4.0-alpha.1",
+    "@cspell/cspell-performance-monitor": "10.4.0-alpha.1",
+    "@cspell/cspell-pipe": "10.4.0-alpha.1",
+    "@cspell/cspell-resolver": "10.4.0-alpha.1",
+    "@cspell/cspell-types": "10.4.0-alpha.1",
+    "@cspell/dynamic-import": "10.4.0-alpha.1",
+    "@cspell/filetypes": "10.4.0-alpha.1",
+    "@cspell/rpc": "10.4.0-alpha.1",
+    "@cspell/strong-weak-map": "10.4.0-alpha.1",
+    "@cspell/url": "10.4.0-alpha.1",
+    "cspell-config-lib": "10.4.0-alpha.1",
+    "cspell-dictionary": "10.4.0-alpha.1",
+    "cspell-glob": "10.4.0-alpha.1",
+    "cspell-grammar": "10.4.0-alpha.1",
+    "cspell-io": "10.4.0-alpha.1",
+    "cspell-trie-lib": "10.4.0-alpha.1",
     "env-paths": "^4.0.0",
     "gensequence": "^8.0.8",
-    "import-fresh": "^4.0.0",
+    "import-fresh": "^4.0.1",
     "resolve-from": "^5.0.0",
-    "vscode-languageserver-textdocument": "^1.0.14",
+    "vscode-languageserver-textdocument": "^1.0.15",
     "vscode-uri": "^3.2.0",
     "xdg-basedir": "^5.1.0"
   },
-  "engines": {
-    "node": ">=22.18.0"
-  },
   "devDependencies": {
-    "@cspell/cspell-tools": "10.3.5",
-    "@cspell/dict-cpp": "^7.1.0",
+    "@cspell/dict-cpp": "^7.1.2",
     "@cspell/dict-csharp": "^4.0.8",
     "@cspell/dict-css": "^4.1.2",
-    "@cspell/dict-en_us": "^4.4.37",
+    "@cspell/dict-en_us": "^4.4.40",
     "@cspell/dict-fa-ir": "^4.0.5",
     "@cspell/dict-fr-fr": "^2.3.2",
     "@cspell/dict-html": "^4.0.16",
     "@cspell/dict-nl-nl": "^2.4.2",
-    "@cspell/dict-python": "^4.5.0",
-    "@cspell/dict-th-th": "^1.0.0",
+    "@cspell/dict-python": "^4.5.2",
+    "@cspell/dict-th-th": "^1.0.1",
     "@cspell/dictionary-bundler-plugin": "",
     "@types/configstore": "^6.0.2",
     "comment-json": "^5.0.0",
@@ -123,5 +119,8 @@
     "lorem-ipsum": "^3.0.0",
     "perf-insight": "^2.0.1"
   },
-  "gitHead": "f37a244a54b686fc1ac11272d6019b9a059b062a"
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "gitHead": "628768a6e62b792e628189b41e63e12e5d3d8fe3"
 }

package/dist/api.d.ts

@@ -1,2 +0,0 @@
-export * from './lib/index.js';
-//# sourceMappingURL=api.d.ts.map

package/dist/api.js

@@ -1,2 +0,0 @@
-export * from './lib/index.js';
-//# sourceMappingURL=api.js.map