cspell-lib 5.19.1 → 5.19.2

package/dist/Models/CSpellSettingsInternalDef.d.ts

@@ -6,6 +6,11 @@ export interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTra
     [SymbolCSpellSettingsInternal]: true;
     dictionaryDefinitions?: DictionaryDefinitionInternal[];
 }
+export interface CSpellSettingsInternalFinalized extends CSpellSettingsInternal {
+    finalized: true;
+    ignoreRegExpList: RegExp[];
+    includeRegExpList: RegExp[];
+}
 declare type DictionaryDefinitionCustomUniqueFields = Omit<DictionaryDefinitionCustom, keyof DictionaryDefinitionPreferred>;
 export interface DictionaryDefinitionInternal extends Readonly<DictionaryDefinitionPreferred>, Readonly<Partial<DictionaryDefinitionCustomUniqueFields>>, Readonly<DictionaryDefinitionAugmented> {
     /**

package/dist/Settings/CSpellSettingsServer.d.ts

@@ -1,5 +1,5 @@
 import type { CSpellSettingsWithSourceTrace, Glob, ImportFileRef } from '@cspell/cspell-types';
-import { CSpellSettingsInternal } from '../Models/CSpellSettingsInternalDef';
+import { CSpellSettingsInternal, CSpellSettingsInternalFinalized } from '../Models/CSpellSettingsInternalDef';
 import { OptionalOrUndefined } from '../util/types';
 declare type CSpellSettingsWST = CSpellSettingsWithSourceTrace;
 declare type CSpellSettingsWSTO = OptionalOrUndefined<CSpellSettingsWithSourceTrace>;
@@ -20,7 +20,7 @@ export declare function calcOverrideSettings(settings: CSpellSettingsWSTO, filen
  * @param settings - settings to finalize
  * @returns settings where all globs and file paths have been resolved.
  */
-export declare function finalizeSettings(settings: CSpellSettingsWSTO | CSpellSettingsI): CSpellSettingsI;
+export declare function finalizeSettings(settings: CSpellSettingsWSTO | CSpellSettingsI): CSpellSettingsInternalFinalized;
 export declare function toInternalSettings(settings: undefined): undefined;
 export declare function toInternalSettings(settings: CSpellSettingsI | CSpellSettingsWSTO): CSpellSettingsI;
 export declare function toInternalSettings(settings?: CSpellSettingsI | CSpellSettingsWSTO): CSpellSettingsI | undefined;

package/dist/Settings/CSpellSettingsServer.js

@@ -221,6 +221,7 @@ function _finalizeSettings(settings) {
     // apply patterns to any RegExpLists.
     const finalized = {
         ...settings,
+        finalized: true,
         ignoreRegExpList: (0, patterns_1.resolvePatterns)(settings.ignoreRegExpList, settings.patterns),
         includeRegExpList: (0, patterns_1.resolvePatterns)(settings.includeRegExpList, settings.patterns),
     };

package/dist/Settings/patterns.d.ts

@@ -1,3 +1,3 @@
 import type { RegExpPatternDefinition } from '@cspell/cspell-types';
-export declare function resolvePatterns(regExpList?: (string | RegExp)[], patternDefinitions?: RegExpPatternDefinition[]): (string | RegExp)[];
+export declare function resolvePatterns(regExpList?: (string | RegExp)[], patternDefinitions?: RegExpPatternDefinition[]): RegExp[];
 //# sourceMappingURL=patterns.d.ts.map

package/dist/Settings/patterns.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePatterns = void 0;
+const text_1 = require("../util/text");
 const util_1 = require("../util/util");
 function resolvePatterns(regExpList = [], patternDefinitions = []) {
     const patternMap = new Map(patternDefinitions.map((def) => [def.name.toLowerCase(), def.pattern]));
@@ -22,7 +23,10 @@ function resolvePatterns(regExpList = [], patternDefinitions = []) {
         }
     }
     const patternList = regExpList.map(resolvePattern).filter(util_1.isDefined);
-    return [...flatten(patternList)];
+    return [...flatten(patternList)].map(toRegExp).filter(util_1.isDefined);
 }
 exports.resolvePatterns = resolvePatterns;
+function toRegExp(pattern) {
+    return pattern instanceof RegExp ? new RegExp(pattern) : (0, text_1.stringToRegExp)(pattern, 'gim', 'g');
+}
 //# sourceMappingURL=patterns.js.map

package/dist/textValidation/docValidator.d.ts

@@ -25,6 +25,7 @@ export declare class DocumentValidator {
     readonly errors: Error[];
     private _prepared;
     private _preparations;
+    private _preparationTime;
     /**
      * @param doc - Document to validate
      * @param config - configuration to use (not finalized).
@@ -34,6 +35,10 @@ export declare class DocumentValidator {
     prepareSync(): void;
     prepare(): Promise<void>;
     private _prepareAsync;
+    /**
+     * The amount of time in ms to prepare for validation.
+     */
+    get prepTime(): number;
     checkText(range: SimpleRange, _text: string, _scope: string[]): ValidationIssue[];
     get document(): TextDocument;
     private addPossibleError;

package/dist/textValidation/docValidator.js

@@ -4,11 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentValidator = void 0;
+const cspell_pipe_1 = require("@cspell/cspell-pipe");
 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 timer_1 = require("../util/timer");
 const util_1 = require("../util/util");
 const determineTextDocumentSettings_1 = require("./determineTextDocumentSettings");
 const textValidator_1 = require("./textValidator");
@@ -23,7 +25,9 @@ class DocumentValidator {
         this.settings = settings;
         this._ready = false;
         this.errors = [];
+        this._preparationTime = -1;
         this._document = doc;
+        // console.error(`DocumentValidator: ${doc.uri}`);
     }
     get ready() {
         return this._ready;
@@ -36,6 +40,7 @@ class DocumentValidator {
         // Load dictionaries
         if (this._ready)
             return;
+        const timer = (0, timer_1.createTimer)();
         const { options, settings } = this;
         const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
         const optionsConfigFile = options.configFile;
@@ -49,8 +54,9 @@ class DocumentValidator {
         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 finalSettings = (0, Settings_1.finalizeSettings)(docSettings);
+        const validateOptions = (0, validator_1.settingsToValidateOptions)(finalSettings);
+        const includeRanges = (0, textValidator_1.calcTextInclusionRanges)(this._document.text, validateOptions);
         const segmenter = (0, textValidator_1.mapLineSegmentAgainstRangesFactory)(includeRanges);
         const lineValidator = (0, textValidator_1.lineValidatorFactory)(dict, validateOptions);
         this._preparations = {
@@ -63,6 +69,7 @@ class DocumentValidator {
             lineValidator,
         };
         this._ready = true;
+        this._preparationTime = timer.elapsed();
     }
     async prepare() {
         if (this._ready)
@@ -75,6 +82,7 @@ class DocumentValidator {
     async _prepareAsync() {
         var _a, _b;
         (0, assert_1.default)(!this._ready);
+        const timer = (0, timer_1.createTimer)();
         const { options, settings } = this;
         const useSearchForConfig = (!options.noConfigSearch && !settings.noConfigSearch) || options.noConfigSearch === false;
         const pLocalConfig = options.configFile
@@ -88,8 +96,9 @@ class DocumentValidator {
         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 finalSettings = (0, Settings_1.finalizeSettings)(docSettings);
+        const validateOptions = (0, validator_1.settingsToValidateOptions)(finalSettings);
+        const includeRanges = (0, textValidator_1.calcTextInclusionRanges)(this._document.text, validateOptions);
         const segmenter = (0, textValidator_1.mapLineSegmentAgainstRangesFactory)(includeRanges);
         const lineValidator = (0, textValidator_1.lineValidatorFactory)(dict, validateOptions);
         this._preparations = {
@@ -102,11 +111,19 @@ class DocumentValidator {
             lineValidator,
         };
         this._ready = true;
+        this._preparationTime = timer.elapsed();
+    }
+    /**
+     * The amount of time in ms to prepare for validation.
+     */
+    get prepTime() {
+        return this._preparationTime;
     }
     checkText(range, _text, _scope) {
         var _a;
         (0, assert_1.default)(this._ready);
         (0, assert_1.default)(this._preparations);
+        const { segmenter, lineValidator } = this._preparations;
         // Determine settings for text range
         // Slice text based upon include ranges
         // Check text against dictionaries.
@@ -121,7 +138,8 @@ class DocumentValidator {
                 offset,
             },
         };
-        const issues = [...this._preparations.lineValidator(lineSeg)];
+        const aIssues = (0, cspell_pipe_1.pipeSync)(segmenter(lineSeg), (0, cspell_pipe_1.opConcatMap)(lineValidator));
+        const issues = [...aIssues];
         if (!this.options.generateSuggestions) {
             return issues;
         }

package/dist/textValidation/textValidator.d.ts

@@ -17,8 +17,8 @@ export interface CheckOptions extends ValidationOptions {
     ignoreCase: boolean;
 }
 export interface IncludeExcludeOptions {
-    ignoreRegExpList?: (RegExp | string)[];
-    includeRegExpList?: (RegExp | string)[];
+    ignoreRegExpList?: RegExp[];
+    includeRegExpList?: RegExp[];
 }
 export interface WordRangeAcc {
     textOffset: TextOffsetRO;

package/dist/textValidation/textValidator.js

@@ -54,7 +54,7 @@ exports.validateText = validateText;
 function calcTextInclusionRanges(text, options) {
     const { ignoreRegExpList = [], includeRegExpList = [] } = options;
     const filteredIncludeList = includeRegExpList.filter((a) => !!a);
-    const finalIncludeList = filteredIncludeList.length ? filteredIncludeList : ['.*'];
+    const finalIncludeList = filteredIncludeList.length ? filteredIncludeList : [/.*/gim];
     const includeRanges = TextRange.excludeRanges(TextRange.findMatchingRangesForPatterns(finalIncludeList, text), TextRange.findMatchingRangesForPatterns(ignoreRegExpList, text));
     return includeRanges;
 }

package/dist/textValidation/validator.d.ts

@@ -1,4 +1,5 @@
 import type { CSpellUserSettings } from '@cspell/cspell-types';
+import { CSpellSettingsInternalFinalized } from '../Models/CSpellSettingsInternalDef';
 import type { ValidationOptions, ValidationResult } from './textValidator';
 export declare const diagSource = "cSpell Checker";
 export interface ValidationIssue extends ValidationResult {
@@ -11,7 +12,7 @@ export interface ValidateTextOptions {
     numSuggestions?: number;
 }
 export declare function validateText(text: string, settings: CSpellUserSettings, options?: ValidateTextOptions): Promise<ValidationIssue[]>;
-export declare function settingsToValidateOptions(settings: CSpellUserSettings): ValidationOptions;
+export declare function settingsToValidateOptions(settings: CSpellSettingsInternalFinalized): ValidationOptions;
 export interface CheckTextInfo {
     text: string;
     items: TextInfoItem[];

package/dist/util/TextRange.d.ts

@@ -8,9 +8,9 @@ export interface MatchRangeWithText extends MatchRange {
 export interface MatchRangeOptionalText extends MatchRange {
     text?: string;
 }
-export declare function findMatchingRanges(pattern: string | RegExp, text: string): MatchRangeOptionalText[];
+export declare function findMatchingRanges(pattern: RegExp, text: string): MatchRangeOptionalText[];
 export declare function unionRanges(ranges: MatchRange[]): MatchRange[];
-export declare function findMatchingRangesForPatterns(patterns: (string | RegExp)[], text: string): MatchRange[];
+export declare function findMatchingRangesForPatterns(patterns: RegExp[], text: string): MatchRange[];
 /**
  * Create a new set of positions that have the excluded position ranges removed.
  */

package/dist/util/TextRange.js

@@ -25,7 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.__testing__ = exports.extractRangeText = exports.excludeRanges = exports.findMatchingRangesForPatterns = exports.unionRanges = exports.findMatchingRanges = void 0;
 const GS = __importStar(require("gensequence"));
-const Text = __importStar(require("./text"));
 function toMatchRangeWithText(m) {
     const index = m.index || 0;
     const _text = m[0];
@@ -36,26 +35,17 @@ function toMatchRangeWithText(m) {
     };
 }
 function findMatchingRanges(pattern, text) {
-    if (pattern === '.*') {
+    if (pattern.source === '.*') {
         return [{ startPos: 0, endPos: text.length }];
     }
-    try {
-        const regex = pattern instanceof RegExp ? new RegExp(pattern) : Text.stringToRegExp(pattern, 'gim', 'g');
-        if (regex) {
-            if (!regex.global) {
-                const m = text.match(regex);
-                if (!m)
-                    return [];
-                return [toMatchRangeWithText(m)];
-            }
-            return [...text.matchAll(regex)].map(toMatchRangeWithText);
-        }
-    }
-    catch (e) {
-        // ignore any malformed regexp from the user.
-        // console.log(e.message);
+    const regex = new RegExp(pattern);
+    if (!regex.global) {
+        const m = text.match(regex);
+        if (!m)
+            return [];
+        return [toMatchRangeWithText(m)];
     }
-    return [];
+    return [...text.matchAll(regex)].map(toMatchRangeWithText);
 }
 exports.findMatchingRanges = findMatchingRanges;
 function compareRanges(a, b) {

package/dist/util/timer.d.ts

@@ -0,0 +1,15 @@
+export interface Timer {
+    /** Start / restart the timer. */
+    start(): void;
+    /**
+     * Calculate the amount of time in ms since the
+     * timer was created / started.
+     */
+    elapsed(): number;
+}
+export declare function createTimer(hrTimeFn?: HRTimeFn): Timer;
+export declare type HRTimeFn = (time?: HRTime) => HRTime;
+export declare type HRTime = [number, number];
+export declare function toMilliseconds(t: HRTime): number;
+export declare function polyHrTime(time?: HRTime): HRTime;
+//# sourceMappingURL=timer.d.ts.map

package/dist/util/timer.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.polyHrTime = exports.toMilliseconds = exports.createTimer = void 0;
+const _hrTime = (process === null || process === void 0 ? void 0 : process.hrtime) || polyHrTime;
+function createTimer(hrTimeFn = _hrTime) {
+    let start = hrTimeFn();
+    return {
+        start() {
+            start = hrTimeFn();
+        },
+        elapsed() {
+            return toMilliseconds(hrTimeFn(start));
+        },
+    };
+}
+exports.createTimer = createTimer;
+function toMilliseconds(t) {
+    return (t[0] + t[1] * 1e-9) * 1000;
+}
+exports.toMilliseconds = toMilliseconds;
+function polyHrTime(time) {
+    const now = Date.now() - (time ? toMilliseconds(time) : 0);
+    const inSeconds = now * 1.0e-3;
+    const s = Math.floor(inSeconds);
+    const n = (inSeconds - s) * 1.0e9;
+    return [s, n];
+}
+exports.polyHrTime = polyHrTime;
+//# sourceMappingURL=timer.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "5.19.1",
+  "version": "5.19.2",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -48,16 +48,16 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "^5.19.1",
-    "@cspell/cspell-pipe": "^5.19.1",
-    "@cspell/cspell-types": "^5.19.1",
+    "@cspell/cspell-bundled-dicts": "^5.19.2",
+    "@cspell/cspell-pipe": "^5.19.2",
+    "@cspell/cspell-types": "^5.19.2",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.2",
     "configstore": "^5.0.1",
     "cosmiconfig": "^7.0.1",
-    "cspell-glob": "^5.19.1",
-    "cspell-io": "^5.19.1",
-    "cspell-trie-lib": "^5.19.1",
+    "cspell-glob": "^5.19.2",
+    "cspell-io": "^5.19.2",
+    "cspell-trie-lib": "^5.19.2",
     "fast-equals": "^3.0.0",
     "find-up": "^5.0.0",
     "fs-extra": "^10.0.1",
@@ -92,5 +92,5 @@
     "rollup-plugin-dts": "^4.2.0",
     "ts-jest": "^27.1.3"
   },
-  "gitHead": "622cd59a44bf1f76d538e3cf37983f387c5423e8"
+  "gitHead": "6540cb9f716993c554dc50dd54dd76d553f8f5e4"
 }