cspell-lib 10.3.1 → 10.3.2

package/dist/lib/Settings/internal/CSpellSettingsInternalDef.d.ts

@@ -1,4 +1,4 @@
-import type { AdvancedCSpellSettingsWithSourceTrace, CSpellSettingsWithSourceTrace, Parser } from '@cspell/cspell-types';
+import type { AdvancedCSpellSettingsWithSourceTrace, CSpellSettingsWithSourceTrace, DocumentParser, Parser } from '@cspell/cspell-types';
 import type { OptionalOrUndefined } from '../../util/types.js';
 import type { DictionaryDefinitionInternal } from './InternalDictionaryDef.js';
 export declare const SymbolCSpellSettingsInternal: unique symbol;
@@ -7,7 +7,7 @@ export interface CSpellSettingsInternal extends Omit<AdvancedCSpellSettingsWithS
     dictionaryDefinitions?: DictionaryDefinitionInternal[];
 }
 export interface CSpellSettingsInternalFinalized extends CSpellSettingsInternal {
-    parserFn: Parser | undefined;
+    parserFn: Parser | DocumentParser | undefined;
     finalized: true;
     ignoreRegExpList: RegExp[];
     includeRegExpList: RegExp[];

package/dist/lib/textValidation/checkText.js

@@ -33,7 +33,7 @@ export async function checkText(text, settings) {
 export async function checkTextOld(text, settings) {
     const validationResult = validateText(text, settings);
     const finalSettings = Settings.finalizeSettings(settings);
-    const includeRanges = calcTextInclusionRanges(text, finalSettings);
+    const includeRanges = calcTextInclusionRanges(text, finalSettings).map(({ startPos, endPos }) => [startPos, endPos]);
     const issues = await validationResult;
     return genResult(text, issues, includeRanges);
 }
@@ -54,22 +54,35 @@ export async function checkTextDocument(doc, options, settings = {}) {
     return genCheckText(new DocumentValidator(doc, options, settings));
 }
 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, preparations.includeRanges);
+    return genResult(docValidator.document.text, issues, docValidator.getRangesChecked());
 }
 function genResult(text, issues, includeRanges) {
     const result = [];
     let lastPos = 0;
-    for (const { startPos, endPos } of includeRanges) {
+    for (const [startPos, endPos] of includeRanges) {
+        if (lastPos < startPos) {
+            result.push({
+                text: text.slice(lastPos, startPos),
+                startPos: lastPos,
+                endPos: startPos,
+                flagIE: IncludeExcludeFlag.EXCLUDE,
+            });
+        }
+        else {
+            const prev = result.at(-1);
+            if (prev && prev.flagIE === IncludeExcludeFlag.INCLUDE && prev.endPos === startPos) {
+                prev.endPos = endPos;
+                prev.text = text.slice(prev.startPos, endPos);
+                lastPos = endPos;
+                continue;
+            }
+        }
         result.push({
-            text: text.slice(lastPos, startPos),
-            startPos: lastPos,
-            endPos: startPos,
-            flagIE: IncludeExcludeFlag.EXCLUDE,
-        }, {
             text: text.slice(startPos, endPos),
             startPos,
             endPos,

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

@@ -34,6 +34,10 @@ export interface DocumentValidatorOptions extends ValidateTextOptions {
      * If true, the document will be checked even if it would normally be excluded.
      */
     forceCheck?: boolean;
+    /**
+     * If true, the ranges of text that have been checked will be recorded and available for later using the `getCheckedRanges` method.
+     */
+    recordCheckedRanges?: boolean;
 }
 type PerfTimings = Record<string, number>;
 export declare class DocumentValidator {
@@ -49,6 +53,7 @@ export declare class DocumentValidator {
     readonly options: DocumentValidatorOptions;
     readonly perfTiming: PerfTimings;
     skipValidation: boolean;
+    private rangesChecked;
     static create(doc: TextDocument, options: DocumentValidatorOptions, settingsOrConfigFile: CSpellUserSettings | ICSpellConfigFile): Promise<DocumentValidator>;
     /**
      * @param doc - Document to validate
@@ -91,11 +96,6 @@ export declare class DocumentValidator {
     checkDocumentDirectives(forceCheck?: boolean): ValidationIssue[];
     get document(): TextDocument;
     updateDocumentText(text: string): Promise<void>;
-    /**
-     * Get the calculated ranges of text that should be included in the spell checking.
-     * @returns MatchRanges of text to include.
-     */
-    getCheckedTextRanges(): MatchRange[];
     traceWord(word: string): TraceResult;
     private defaultParser;
     private _checkParsedText;
@@ -119,6 +119,17 @@ export declare class DocumentValidator {
      * Internal `cspell-lib` use.
      */
     _getPreparations(): Preparations | undefined;
+    /**
+     * Get the calculated ranges of text that should be included in the spell checking.
+     *
+     * Use {@link getRangesChecked} to retrieve the ranges of text that have been checked.
+     *
+     * @returns MatchRanges of text to include.
+     */
+    getCheckedTextRanges(): MatchRange[];
+    getRangesChecked(): Iterable<SimpleRange>;
+    get recordCheckedRanges(): boolean;
+    set recordCheckedRanges(value: boolean);
 }
 declare function sanitizeSuggestion(sug: WordSuggestion): ExtendedSuggestion;
 interface Preparations {

package/dist/lib/textValidation/docValidator.js

@@ -34,6 +34,11 @@ export class DocumentValidator {
     options;
     perfTiming = {};
     skipValidation;
+    rangesChecked = [];
+    /**
+     * If true, the ranges of text that have been checked will be recorded and available for later using the `getCheckedRanges` method.
+     */
+    #recordCheckedRanges;
     static async create(doc, options, settingsOrConfigFile) {
         const settings = satisfiesCSpellConfigFile(settingsOrConfigFile)
             ? await resolveConfigFileImports(settingsOrConfigFile)
@@ -56,6 +61,7 @@ export class DocumentValidator {
             this.options.numSuggestions = numSuggestions;
         }
         this.skipValidation = !!options.skipValidation;
+        this.#recordCheckedRanges = !!options.recordCheckedRanges;
         // console.error(`DocumentValidator: ${doc.uri}`);
     }
     get ready() {
@@ -218,7 +224,15 @@ export class DocumentValidator {
                 hasSimpleSuggestions,
             };
         }
-        const issues = [...pipeSync(segmenter(parsedText), opConcatMap(textValidator.validate), opMap(mapToIssue))];
+        const skipRecordRanges = (iter) => iter;
+        const recordRanges = opMap((m) => {
+            this.rangesChecked.push(m.range[0], m.range[1]);
+            return m;
+        });
+        const recordRangesIfNeeded = this.recordCheckedRanges ? recordRanges : skipRecordRanges;
+        const issues = [
+            ...pipeSync(segmenter(parsedText), recordRangesIfNeeded, opConcatMap(textValidator.validate), opMap(mapToIssue)),
+        ];
         if (!this.options.generateSuggestions) {
             return issues.map((issue) => {
                 if (!issue.suggestionsEx)
@@ -295,17 +309,10 @@ export class DocumentValidator {
         return this._document;
     }
     async updateDocumentText(text) {
+        this.rangesChecked.length = 0;
         updateTextDocument(this._document, [{ text }]);
         await this._updatePrep();
     }
-    /**
-     * Get the calculated ranges of text that should be included in the spell checking.
-     * @returns MatchRanges of text to include.
-     */
-    getCheckedTextRanges() {
-        assert(this._preparations, ERROR_NOT_PREPARED);
-        return this._preparations.includeRanges;
-    }
     traceWord(word) {
         assert(this._preparations, ERROR_NOT_PREPARED);
         return traceWord(word, this._preparations.dictionary, this._preparations.config);
@@ -347,7 +354,7 @@ export class DocumentValidator {
         const parser = this._preparations.finalSettings.parserFn;
         if (typeof parser !== 'object')
             return this.defaultParser();
-        return parser.parse(this.document.text, toFilePathOrHref(documentUriToURL(this.document.uri))).parsedTexts;
+        return parseDocumentWithParser(parser, this.document).parsedTexts;
     }
     getSuggestions(text) {
         return this._suggestions.get(text);
@@ -412,6 +419,32 @@ export class DocumentValidator {
     _getPreparations() {
         return this._preparations;
     }
+    /**
+     * Get the calculated ranges of text that should be included in the spell checking.
+     *
+     * Use {@link getRangesChecked} to retrieve the ranges of text that have been checked.
+     *
+     * @returns MatchRanges of text to include.
+     */
+    getCheckedTextRanges() {
+        assert(this._preparations, ERROR_NOT_PREPARED);
+        return this._preparations.includeRanges;
+    }
+    *getRangesChecked() {
+        const ranges = this.rangesChecked;
+        for (let i = 0; i < ranges.length - 1; i += 2) {
+            const start = ranges[i];
+            const end = ranges[i + 1];
+            yield [start, end];
+        }
+    }
+    get recordCheckedRanges() {
+        return this.#recordCheckedRanges;
+    }
+    set recordCheckedRanges(value) {
+        this.rangesChecked.length = 0;
+        this.#recordCheckedRanges = value;
+    }
 }
 function sanitizeSuggestion(sug) {
     const { word, isPreferred, wordAdjustedToMatchCase } = sug;
@@ -434,6 +467,15 @@ async function searchForDocumentConfig(document, defaultConfig, pnpSettings) {
         throw e;
     }
 }
+function parseDocumentWithParser(parser, document) {
+    if (isDocumentParser(parser)) {
+        return parser.parseDocument({ text: document.text, url: documentUriToURL(document.uri) });
+    }
+    return parser.parse(document.text, toFilePathOrHref(documentUriToURL(document.uri)));
+}
+function isDocumentParser(parser) {
+    return typeof parser.parseDocument === 'function';
+}
 function mapSug(sug) {
     return { cost: 999, ...sug };
 }

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.1",
+  "version": "10.3.2",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -75,22 +75,22 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "10.3.1",
-    "@cspell/cspell-performance-monitor": "10.3.1",
-    "@cspell/cspell-pipe": "10.3.1",
-    "@cspell/cspell-resolver": "10.3.1",
-    "@cspell/cspell-types": "10.3.1",
-    "@cspell/dynamic-import": "10.3.1",
-    "@cspell/filetypes": "10.3.1",
-    "@cspell/rpc": "10.3.1",
-    "@cspell/strong-weak-map": "10.3.1",
-    "@cspell/url": "10.3.1",
-    "cspell-config-lib": "10.3.1",
-    "cspell-dictionary": "10.3.1",
-    "cspell-glob": "10.3.1",
-    "cspell-grammar": "10.3.1",
-    "cspell-io": "10.3.1",
-    "cspell-trie-lib": "10.3.1",
+    "@cspell/cspell-bundled-dicts": "10.3.2",
+    "@cspell/cspell-performance-monitor": "10.3.2",
+    "@cspell/cspell-pipe": "10.3.2",
+    "@cspell/cspell-resolver": "10.3.2",
+    "@cspell/cspell-types": "10.3.2",
+    "@cspell/dynamic-import": "10.3.2",
+    "@cspell/filetypes": "10.3.2",
+    "@cspell/rpc": "10.3.2",
+    "@cspell/strong-weak-map": "10.3.2",
+    "@cspell/url": "10.3.2",
+    "cspell-config-lib": "10.3.2",
+    "cspell-dictionary": "10.3.2",
+    "cspell-glob": "10.3.2",
+    "cspell-grammar": "10.3.2",
+    "cspell-io": "10.3.2",
+    "cspell-trie-lib": "10.3.2",
     "env-paths": "^4.0.0",
     "gensequence": "^8.0.8",
     "import-fresh": "^4.0.0",
@@ -103,7 +103,7 @@
     "node": ">=22.18.0"
   },
   "devDependencies": {
-    "@cspell/cspell-tools": "10.3.1",
+    "@cspell/cspell-tools": "10.3.2",
     "@cspell/dict-cpp": "^7.1.0",
     "@cspell/dict-csharp": "^4.0.8",
     "@cspell/dict-css": "^4.1.2",
@@ -123,5 +123,5 @@
     "lorem-ipsum": "^3.0.0",
     "perf-insight": "^2.0.1"
   },
-  "gitHead": "793953d1c2b4f1cab257389ff6ecb3ae2dd40230"
+  "gitHead": "d43b5ffd5fbb295fcfd06358cdfc7560b3a84a7f"
 }