cspell-lib 5.18.4 → 5.19.1

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -22,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.SuggestionError = exports.suggestionsForWords = exports.suggestionsForWord = exports.traceWordsAsync = exports.traceWords = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.getLanguagesForExt = void 0;
+exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.traceWordsAsync = exports.traceWords = exports.DocumentValidator = exports.suggestionsForWords = exports.suggestionsForWord = exports.SuggestionError = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.createTextDocument = exports.getLanguagesForExt = void 0;
 const ExclusionHelper = __importStar(require("./exclusionHelper"));
 exports.ExclusionHelper = ExclusionHelper;
 const Settings_1 = require("./Settings");
@@ -32,11 +36,13 @@ exports.Link = Link;
 const SpellingDictionary_1 = require("./SpellingDictionary");
 const Text = __importStar(require("./util/text"));
 exports.Text = Text;
+__exportStar(require("@cspell/cspell-types"), exports);
 __exportStar(require("cspell-io"), exports);
 var LanguageIds_1 = require("./LanguageIds");
 Object.defineProperty(exports, "getLanguagesForExt", { enumerable: true, get: function () { return LanguageIds_1.getLanguagesForExt; } });
+var TextDocument_1 = require("./Models/TextDocument");
+Object.defineProperty(exports, "createTextDocument", { enumerable: true, get: function () { return TextDocument_1.createTextDocument; } });
 __exportStar(require("./Settings"), exports);
-__exportStar(require("@cspell/cspell-types"), exports);
 var Settings_2 = require("./Settings");
 Object.defineProperty(exports, "defaultSettingsFilename", { enumerable: true, get: function () { return Settings_2.defaultFileName; } });
 var TextDocumentSettings_1 = require("./Settings/TextDocumentSettings");
@@ -55,13 +61,15 @@ Object.defineProperty(exports, "isSpellingDictionaryLoadError", { enumerable: tr
 Object.defineProperty(exports, "refreshDictionaryCache", { enumerable: true, get: function () { return SpellingDictionary_2.refreshDictionaryCache; } });
 Object.defineProperty(exports, "SpellingDictionaryCollection", { enumerable: true, get: function () { return SpellingDictionary_2.SpellingDictionaryCollection; } });
 Object.defineProperty(exports, "SpellingDictionaryLoadError", { enumerable: true, get: function () { return SpellingDictionary_2.SpellingDictionaryLoadError; } });
-var trace_1 = require("./trace");
-Object.defineProperty(exports, "traceWords", { enumerable: true, get: function () { return trace_1.traceWords; } });
-Object.defineProperty(exports, "traceWordsAsync", { enumerable: true, get: function () { return trace_1.traceWordsAsync; } });
 var suggestions_1 = require("./suggestions");
+Object.defineProperty(exports, "SuggestionError", { enumerable: true, get: function () { return suggestions_1.SuggestionError; } });
 Object.defineProperty(exports, "suggestionsForWord", { enumerable: true, get: function () { return suggestions_1.suggestionsForWord; } });
 Object.defineProperty(exports, "suggestionsForWords", { enumerable: true, get: function () { return suggestions_1.suggestionsForWords; } });
-Object.defineProperty(exports, "SuggestionError", { enumerable: true, get: function () { return suggestions_1.SuggestionError; } });
+var textValidation_1 = require("./textValidation");
+Object.defineProperty(exports, "DocumentValidator", { enumerable: true, get: function () { return textValidation_1.DocumentValidator; } });
+var trace_1 = require("./trace");
+Object.defineProperty(exports, "traceWords", { enumerable: true, get: function () { return trace_1.traceWords; } });
+Object.defineProperty(exports, "traceWordsAsync", { enumerable: true, get: function () { return trace_1.traceWordsAsync; } });
 var logger_1 = require("./util/logger");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return logger_1.getLogger; } });
 Object.defineProperty(exports, "setLogger", { enumerable: true, get: function () { return logger_1.setLogger; } });

package/dist/spellCheckFile.js

@@ -1,36 +1,16 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fileToDocument = exports.isBinaryFile = exports.isBinaryDoc = exports.determineFinalDocumentSettings = exports.spellCheckDocument = exports.spellCheckFile = void 0;
 const cspell_glob_1 = require("cspell-glob");
 const fs_extra_1 = require("fs-extra");
-const path = __importStar(require("path"));
 const vscode_uri_1 = require("vscode-uri");
+const determineTextDocumentSettings_1 = require("./textValidation/determineTextDocumentSettings");
 const LanguageIds_1 = require("./LanguageIds");
+const TextDocument_1 = require("./Models/TextDocument");
 const Settings_1 = require("./Settings");
-const TextDocumentSettings_1 = require("./Settings/TextDocumentSettings");
 const errors_1 = require("./util/errors");
-const Memorizer_1 = require("./util/Memorizer");
+const util_1 = require("./util/util");
 const validator_1 = require("./validator");
-const getLanguagesForExt = (0, Memorizer_1.memorizer)(LanguageIds_1.getLanguagesForExt);
 const defaultEncoding = 'utf8';
 /**
  * Spell Check a file
@@ -96,7 +76,7 @@ async function spellCheckFullDocument(document, options, settings) {
     }
     const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
     const pLocalConfig = options.configFile
-        ? catchError(loadConfigFile(options.configFile, settings))
+        ? catchError((0, Settings_1.loadConfig)(options.configFile, settings))
         : useSearchForConfig
             ? catchError(searchForDocumentConfig(document, settings, settings))
             : undefined;
@@ -119,7 +99,7 @@ async function spellCheckFullDocument(document, options, settings) {
     const uri = vscode_uri_1.URI.parse(document.uri);
     const shouldCheck = !matcher.match(uri.fsPath) && ((_c = docSettings.settings.enabled) !== null && _c !== void 0 ? _c : true);
     const { generateSuggestions, numSuggestions } = options;
-    const validateOptions = { generateSuggestions, numSuggestions };
+    const validateOptions = (0, util_1.clean)({ generateSuggestions, numSuggestions });
     const issues = shouldCheck ? await (0, validator_1.validateText)(document.text, docSettings.settings, validateOptions) : [];
     const result = {
         document,
@@ -139,9 +119,6 @@ async function searchForDocumentConfig(document, defaultConfig, pnpSettings) {
         return Promise.resolve(defaultConfig);
     return (0, Settings_1.searchForConfig)(u.fsPath, pnpSettings).then((s) => s || defaultConfig);
 }
-async function loadConfigFile(filename, pnpSettings) {
-    return (0, Settings_1.loadConfig)(filename, pnpSettings);
-}
 async function readDocument(filename, encoding = defaultEncoding) {
     const text = await (0, fs_extra_1.readFile)(filename, encoding);
     const uri = vscode_uri_1.URI.file(filename).toString();
@@ -175,23 +152,15 @@ function isDocumentWithText(doc) {
  * @param settings - The near final settings. Should already be the combination of all configuration files.
  */
 function determineFinalDocumentSettings(document, settings) {
-    var _a;
-    const uri = vscode_uri_1.URI.parse(document.uri);
-    const filename = uri.fsPath;
-    const settingsWithDefaults = (0, Settings_1.mergeSettings)((0, Settings_1.getDefaultSettings)(), (0, Settings_1.getGlobalSettings)(), settings);
-    const fileSettings = (0, Settings_1.calcOverrideSettings)(settingsWithDefaults, filename);
-    const languageIds = ((_a = fileSettings === null || fileSettings === void 0 ? void 0 : fileSettings.languageId) === null || _a === void 0 ? void 0 : _a.length)
-        ? fileSettings.languageId
-        : document.languageId
-            ? document.languageId
-            : getLanguageForFilename(filename);
-    if (document.locale) {
-        fileSettings.language = document.locale;
-    }
-    const config = (0, TextDocumentSettings_1.combineTextAndLanguageSettings)(fileSettings, document.text, languageIds);
+    const doc = (0, TextDocument_1.createTextDocument)({
+        uri: document.uri,
+        content: document.text,
+        languageId: document.languageId,
+        locale: document.locale,
+    });
     return {
         document,
-        settings: config,
+        settings: (0, determineTextDocumentSettings_1.determineTextDocumentSettings)(doc, settings),
     };
 }
 exports.determineFinalDocumentSettings = determineFinalDocumentSettings;
@@ -209,22 +178,16 @@ function isBinaryFile(filenameUri, languageId) {
     return (0, LanguageIds_1.isGeneratedFile)(filename);
 }
 exports.isBinaryFile = isBinaryFile;
-function getLanguageForFilename(filename) {
-    const basename = path.basename(filename);
-    const ext = path.extname(basename);
-    const languagesExt = getLanguagesForExt(ext);
-    return languagesExt.length ? languagesExt : (0, LanguageIds_1.getLanguagesForExt)(basename);
-}
 function normalizeLanguageIds(languageId) {
     return (Array.isArray(languageId) ? languageId.join(',') : languageId).split(',').map((s) => s.trim());
 }
 function fileToDocument(file, text, languageId, locale) {
-    return {
+    return (0, util_1.clean)({
         uri: vscode_uri_1.URI.file(file).toString(),
         text,
         languageId,
         locale,
-    };
+    });
 }
 exports.fileToDocument = fileToDocument;
 //# sourceMappingURL=spellCheckFile.js.map

package/dist/suggestions.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -35,13 +39,13 @@ async function suggestionsForWord(word, options, settings = {}) {
     const ignoreCase = !strict;
     async function determineDictionaries(config) {
         var _a, _b;
-        const withLocale = (0, Settings_1.mergeSettings)(config, {
+        const withLocale = (0, Settings_1.mergeSettings)(config, util.clean({
             language: language || config.language,
             // dictionaries: dictionaries?.length ? dictionaries : config.dictionaries,
-        });
+        }));
         const withLanguageId = (0, LanguageSettings_1.calcSettingsForLanguageId)(withLocale, (_a = languageId !== null && languageId !== void 0 ? languageId : withLocale.languageId) !== null && _a !== void 0 ? _a : 'plaintext');
         const settings = (0, Settings_1.finalizeSettings)(withLanguageId);
-        settings.dictionaries = (dictionaries === null || dictionaries === void 0 ? void 0 : dictionaries.length) ? dictionaries : settings.dictionaries;
+        settings.dictionaries = (dictionaries === null || dictionaries === void 0 ? void 0 : dictionaries.length) ? dictionaries : settings.dictionaries || [];
         validateDictionaries(settings, dictionaries);
         const dictionaryCollection = await (0, SpellingDictionary_1.getDictionaryInternal)(settings);
         settings.dictionaries = ((_b = settings.dictionaryDefinitions) === null || _b === void 0 ? void 0 : _b.map((def) => def.name)) || [];

package/dist/textValidation/determineTextDocumentSettings.d.ts

@@ -0,0 +1,17 @@
+import { CSpellUserSettings } from '@cspell/cspell-types';
+import { CSpellSettingsInternal } from '../Models/CSpellSettingsInternalDef';
+import { TextDocument } from '../Models/TextDocument';
+/**
+ * Combines all relevant setting values into a final configuration to be used for spell checking.
+ * It applies any overrides and appropriate language settings by taking into account the document type (languageId)
+ * the locale (natural language) and any in document settings.
+ *
+ * Note: this method will not search for configuration files. Configuration files should already be merged into `settings`.
+ * It is NOT necessary to include the cspell defaultSettings or globalSettings. They will be applied within this function.
+ * @param document - The document to be spell checked. Note: if the URI doesn't have a path, overrides cannot be applied.
+ *   `locale` - if defined will be used unless it is overridden by an in-document setting.
+ *   `languageId` - if defined will be used to select appropriate file type dictionaries.
+ * @param settings - The near final settings. Should already be the combination of all configuration files.
+ */
+export declare function determineTextDocumentSettings(doc: TextDocument, settings: CSpellUserSettings): CSpellSettingsInternal;
+//# sourceMappingURL=determineTextDocumentSettings.d.ts.map

package/dist/textValidation/determineTextDocumentSettings.js

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.determineTextDocumentSettings = void 0;
+const path = __importStar(require("path"));
+const LanguageIds_1 = require("../LanguageIds");
+const Settings_1 = require("../Settings");
+const TextDocumentSettings_1 = require("../Settings/TextDocumentSettings");
+/**
+ * Combines all relevant setting values into a final configuration to be used for spell checking.
+ * It applies any overrides and appropriate language settings by taking into account the document type (languageId)
+ * the locale (natural language) and any in document settings.
+ *
+ * Note: this method will not search for configuration files. Configuration files should already be merged into `settings`.
+ * It is NOT necessary to include the cspell defaultSettings or globalSettings. They will be applied within this function.
+ * @param document - The document to be spell checked. Note: if the URI doesn't have a path, overrides cannot be applied.
+ *   `locale` - if defined will be used unless it is overridden by an in-document setting.
+ *   `languageId` - if defined will be used to select appropriate file type dictionaries.
+ * @param settings - The near final settings. Should already be the combination of all configuration files.
+ */
+function determineTextDocumentSettings(doc, settings) {
+    var _a;
+    const filename = doc.uri.fsPath;
+    const settingsWithDefaults = (0, Settings_1.mergeSettings)((0, Settings_1.getDefaultSettings)(), (0, Settings_1.getGlobalSettings)(), settings);
+    const fileSettings = (0, Settings_1.calcOverrideSettings)(settingsWithDefaults, filename);
+    const languageIds = ((_a = fileSettings === null || fileSettings === void 0 ? void 0 : fileSettings.languageId) === null || _a === void 0 ? void 0 : _a.length)
+        ? fileSettings.languageId
+        : doc.languageId
+            ? doc.languageId
+            : getLanguageForFilename(filename);
+    if (doc.locale) {
+        fileSettings.language = doc.locale;
+    }
+    return (0, TextDocumentSettings_1.combineTextAndLanguageSettings)(fileSettings, doc.text, languageIds);
+}
+exports.determineTextDocumentSettings = determineTextDocumentSettings;
+function getLanguageForFilename(filename) {
+    const basename = path.basename(filename);
+    return (0, LanguageIds_1.getLanguagesForBasename)(basename);
+}
+//# sourceMappingURL=determineTextDocumentSettings.js.map

package/dist/textValidation/docValidator.d.ts

@@ -0,0 +1,45 @@
+import type { CSpellUserSettings } from '@cspell/cspell-types';
+import { TextDocument } from '../Models/TextDocument';
+import { ValidateTextOptions, ValidationIssue } from './validator';
+export interface DocumentValidatorOptions extends ValidateTextOptions {
+    /**
+     * Optional path to a configuration file.
+     * If given, it will be used instead of searching for a configuration file.
+     */
+    configFile?: string;
+    /**
+     * Prevents searching for local configuration files
+     * By default the spell checker looks for configuration files
+     * starting at the location of given filename.
+     * If `configFile` is defined it will still be loaded instead of searching.
+     * `false` will override the value in `settings.noConfigSearch`.
+     * @defaultValue undefined
+     */
+    noConfigSearch?: boolean;
+}
+export declare class DocumentValidator {
+    readonly options: DocumentValidatorOptions;
+    readonly settings: CSpellUserSettings;
+    private _document;
+    private _ready;
+    readonly errors: Error[];
+    private _prepared;
+    private _preparations;
+    /**
+     * @param doc - Document to validate
+     * @param config - configuration to use (not finalized).
+     */
+    constructor(doc: TextDocument, options: DocumentValidatorOptions, settings: CSpellUserSettings);
+    get ready(): boolean;
+    prepareSync(): void;
+    prepare(): Promise<void>;
+    private _prepareAsync;
+    checkText(range: SimpleRange, _text: string, _scope: string[]): ValidationIssue[];
+    get document(): TextDocument;
+    private addPossibleError;
+    private catchError;
+    private errorCatcherWrapper;
+}
+export declare type Offset = number;
+export declare type SimpleRange = readonly [Offset, Offset];
+//# sourceMappingURL=docValidator.d.ts.map

package/dist/textValidation/docValidator.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentValidator = void 0;
+const assert_1 = __importDefault(require("assert"));
+const Settings_1 = require("../Settings");
+const configLoader_1 = require("../Settings/configLoader");
+const SpellingDictionary_1 = require("../SpellingDictionary");
+const errors_1 = require("../util/errors");
+const util_1 = require("../util/util");
+const determineTextDocumentSettings_1 = require("./determineTextDocumentSettings");
+const textValidator_1 = require("./textValidator");
+const validator_1 = require("./validator");
+class DocumentValidator {
+    /**
+     * @param doc - Document to validate
+     * @param config - configuration to use (not finalized).
+     */
+    constructor(doc, options, settings) {
+        this.options = options;
+        this.settings = settings;
+        this._ready = false;
+        this.errors = [];
+        this._document = doc;
+    }
+    get ready() {
+        return this._ready;
+    }
+    prepareSync() {
+        var _a, _b;
+        // @todo
+        // Determine doc settings.
+        // Calc include ranges
+        // Load dictionaries
+        if (this._ready)
+            return;
+        const { options, settings } = this;
+        const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
+        const optionsConfigFile = options.configFile;
+        const localConfig = optionsConfigFile
+            ? this.errorCatcherWrapper(() => (0, configLoader_1.loadConfigSync)(optionsConfigFile, settings))
+            : useSearchForConfig
+                ? this.errorCatcherWrapper(() => searchForDocumentConfigSync(this._document, settings, settings))
+                : undefined;
+        this.addPossibleError((_a = localConfig === null || localConfig === void 0 ? void 0 : localConfig.__importRef) === null || _a === void 0 ? void 0 : _a.error);
+        const config = localConfig ? (0, Settings_1.mergeSettings)(settings, localConfig) : settings;
+        const docSettings = (0, determineTextDocumentSettings_1.determineTextDocumentSettings)(this._document, config);
+        const dict = (0, SpellingDictionary_1.getDictionaryInternalSync)(docSettings);
+        const shouldCheck = (_b = docSettings.enabled) !== null && _b !== void 0 ? _b : true;
+        const validateOptions = (0, validator_1.settingsToValidateOptions)(docSettings);
+        const includeRanges = (0, textValidator_1.calcTextInclusionRanges)(this._document.text, docSettings);
+        const segmenter = (0, textValidator_1.mapLineSegmentAgainstRangesFactory)(includeRanges);
+        const lineValidator = (0, textValidator_1.lineValidatorFactory)(dict, validateOptions);
+        this._preparations = {
+            dictionary: dict,
+            docSettings,
+            shouldCheck,
+            validateOptions,
+            includeRanges,
+            segmenter,
+            lineValidator,
+        };
+        this._ready = true;
+    }
+    async prepare() {
+        if (this._ready)
+            return;
+        if (this._prepared)
+            return this._prepared;
+        this._prepared = this._prepareAsync();
+        return this._prepared;
+    }
+    async _prepareAsync() {
+        var _a, _b;
+        (0, assert_1.default)(!this._ready);
+        const { options, settings } = this;
+        const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
+        const pLocalConfig = options.configFile
+            ? this.catchError((0, Settings_1.loadConfig)(options.configFile, settings))
+            : useSearchForConfig
+                ? this.catchError(searchForDocumentConfig(this._document, settings, settings))
+                : undefined;
+        const localConfig = await pLocalConfig;
+        this.addPossibleError((_a = localConfig === null || localConfig === void 0 ? void 0 : localConfig.__importRef) === null || _a === void 0 ? void 0 : _a.error);
+        const config = localConfig ? (0, Settings_1.mergeSettings)(settings, localConfig) : settings;
+        const docSettings = (0, determineTextDocumentSettings_1.determineTextDocumentSettings)(this._document, config);
+        const dict = await (0, SpellingDictionary_1.getDictionaryInternal)(docSettings);
+        const shouldCheck = (_b = docSettings.enabled) !== null && _b !== void 0 ? _b : true;
+        const validateOptions = (0, validator_1.settingsToValidateOptions)(docSettings);
+        const includeRanges = (0, textValidator_1.calcTextInclusionRanges)(this._document.text, docSettings);
+        const segmenter = (0, textValidator_1.mapLineSegmentAgainstRangesFactory)(includeRanges);
+        const lineValidator = (0, textValidator_1.lineValidatorFactory)(dict, validateOptions);
+        this._preparations = {
+            dictionary: dict,
+            docSettings,
+            shouldCheck,
+            validateOptions,
+            includeRanges,
+            segmenter,
+            lineValidator,
+        };
+        this._ready = true;
+    }
+    checkText(range, _text, _scope) {
+        var _a;
+        (0, assert_1.default)(this._ready);
+        (0, assert_1.default)(this._preparations);
+        // Determine settings for text range
+        // Slice text based upon include ranges
+        // Check text against dictionaries.
+        const offset = range[0];
+        const offsetEnd = range[1];
+        const text = this._document.text.slice(offset, offsetEnd);
+        const line = this._document.lineAt(offset);
+        const lineSeg = {
+            line,
+            segment: {
+                text,
+                offset,
+            },
+        };
+        const issues = [...this._preparations.lineValidator(lineSeg)];
+        if (!this.options.generateSuggestions) {
+            return issues;
+        }
+        const settings = this._preparations.docSettings;
+        const dict = this._preparations.dictionary;
+        const sugOptions = (0, util_1.clean)({
+            compoundMethod: 0,
+            numSuggestions: this.options.numSuggestions,
+            includeTies: false,
+            ignoreCase: !((_a = settings.caseSensitive) !== null && _a !== void 0 ? _a : false),
+            timeout: settings.suggestionsTimeout,
+            numChanges: settings.suggestionNumChanges,
+        });
+        const withSugs = issues.map((t) => {
+            const suggestions = dict.suggest(t.text, sugOptions).map((r) => r.word);
+            return { ...t, suggestions };
+        });
+        return withSugs;
+    }
+    get document() {
+        return this._document;
+    }
+    addPossibleError(error) {
+        if (!error)
+            return;
+        error = this.errors.push((0, errors_1.toError)(error));
+    }
+    catchError(p) {
+        return p.catch((error) => {
+            this.addPossibleError(error);
+            return undefined;
+        });
+    }
+    errorCatcherWrapper(fn) {
+        try {
+            return fn();
+        }
+        catch (error) {
+            this.addPossibleError(error);
+        }
+        return undefined;
+    }
+}
+exports.DocumentValidator = DocumentValidator;
+async function searchForDocumentConfig(document, defaultConfig, pnpSettings) {
+    const { uri } = document;
+    if (uri.scheme !== 'file')
+        return Promise.resolve(defaultConfig);
+    return (0, Settings_1.searchForConfig)(uri.fsPath, pnpSettings).then((s) => s || defaultConfig);
+}
+function searchForDocumentConfigSync(document, defaultConfig, pnpSettings) {
+    const { uri } = document;
+    if (uri.scheme !== 'file')
+        defaultConfig;
+    return (0, configLoader_1.searchForConfigSync)(uri.fsPath, pnpSettings) || defaultConfig;
+}
+//# sourceMappingURL=docValidator.js.map

package/dist/textValidation/index.d.ts

@@ -0,0 +1,7 @@
+export { calcTextInclusionRanges } from './textValidator';
+export type { CheckOptions, IncludeExcludeOptions, ValidationOptions, ValidationResult } from './textValidator';
+export { checkText, IncludeExcludeFlag, validateText } from './validator';
+export type { CheckTextInfo, TextInfoItem, ValidateTextOptions, ValidationIssue } from './validator';
+export { DocumentValidator } from './docValidator';
+export type { DocumentValidatorOptions } from './docValidator';
+//# sourceMappingURL=index.d.ts.map

package/dist/textValidation/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentValidator = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.calcTextInclusionRanges = void 0;
+var textValidator_1 = require("./textValidator");
+Object.defineProperty(exports, "calcTextInclusionRanges", { enumerable: true, get: function () { return textValidator_1.calcTextInclusionRanges; } });
+var validator_1 = require("./validator");
+Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return validator_1.checkText; } });
+Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return validator_1.IncludeExcludeFlag; } });
+Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return validator_1.validateText; } });
+var docValidator_1 = require("./docValidator");
+Object.defineProperty(exports, "DocumentValidator", { enumerable: true, get: function () { return docValidator_1.DocumentValidator; } });
+//# sourceMappingURL=index.js.map

package/dist/{textValidator.d.ts → textValidation/textValidator.d.ts}

@@ -1,7 +1,8 @@
-import type { TextOffset } from '@cspell/cspell-types';
+import type { TextOffset as TextOffsetRW } from '@cspell/cspell-types';
 import { Sequence } from 'gensequence';
-import { SpellingDictionary } from './SpellingDictionary/SpellingDictionary';
-import * as TextRange from './util/TextRange';
+import { SpellingDictionary } from '../SpellingDictionary/SpellingDictionary';
+import * as TextRange from '../util/TextRange';
+declare type TextOffsetRO = Readonly<TextOffsetRW>;
 export interface ValidationOptions extends IncludeExcludeOptions {
     maxNumberOfProblems?: number;
     maxDuplicateProblems?: number;
@@ -20,12 +21,12 @@ export interface IncludeExcludeOptions {
     includeRegExpList?: (RegExp | string)[];
 }
 export interface WordRangeAcc {
-    textOffset: TextOffset;
+    textOffset: TextOffsetRO;
     isIncluded: boolean;
     rangePos: number;
 }
-export interface ValidationResult extends TextOffset {
-    line: TextOffset;
+export interface ValidationResult extends TextOffsetRW {
+    line: TextOffsetRW;
     isFlagged?: boolean;
     isFound?: boolean;
 }
@@ -35,19 +36,26 @@ export declare const defaultMinWordLength = 4;
 export declare const minWordSplitLen = 3;
 export declare function validateText(text: string, dict: SpellingDictionary, options: ValidationOptions): Sequence<ValidationResult>;
 export declare function calcTextInclusionRanges(text: string, options: IncludeExcludeOptions): TextRange.MatchRange[];
-export declare function isWordValid(dict: SpellingDictionary, wo: TextOffset, line: TextOffset, options: HasWordOptions): boolean;
+export interface LineSegment {
+    line: TextOffsetRO;
+    segment: TextOffsetRO;
+}
+export declare type LineValidator = (line: LineSegment) => Iterable<ValidationResult>;
+export declare function lineValidatorFactory(dict: SpellingDictionary, options: ValidationOptions): LineValidator;
+export declare function isWordValid(dict: SpellingDictionary, wo: TextOffsetRO, line: TextOffsetRO, options: HasWordOptions): boolean;
 export interface HasWordOptions {
     ignoreCase: boolean;
     useCompounds: boolean | undefined;
 }
 export declare function hasWordCheck(dict: SpellingDictionary, word: string, options: HasWordOptions): boolean;
 /**
- * Returns a mapper function that will
+ * Returns a mapper function that will segment a TextOffset based upon the includeRanges.
+ * This function is optimized for forward scanning. It will perform poorly for randomly ordered offsets.
  * @param includeRanges Allowed ranges for words.
  */
-declare function mapTextOffsetsAgainstRanges(includeRanges: TextRange.MatchRange[]): (wo: TextOffset) => Iterable<TextOffset>;
+export declare function mapLineSegmentAgainstRangesFactory(includeRanges: TextRange.MatchRange[]): (lineSeg: LineSegment) => LineSegment[];
 export declare const _testMethods: {
-    mapWordsAgainstRanges: typeof mapTextOffsetsAgainstRanges;
+    mapWordsAgainstRanges: typeof mapLineSegmentAgainstRangesFactory;
 };
 export {};
 //# sourceMappingURL=textValidator.d.ts.map