cspell-lib 5.18.5 → 5.19.0

package/dist/util/text.d.ts

@@ -1,5 +1,4 @@
 import type { TextDocumentOffset, TextOffset } from '@cspell/cspell-types';
-import { Sequence } from 'gensequence';
 export declare function splitCamelCaseWordWithOffset(wo: TextOffset): Array<TextOffset>;
 /**
  * Split camelCase words into an array of strings.
@@ -8,26 +7,26 @@ export declare function splitCamelCaseWord(word: string): string[];
 /**
  * This function lets you iterate over regular expression matches.
  */
-export declare function match(reg: RegExp, text: string): Sequence<RegExpExecArray>;
-export declare function matchStringToTextOffset(reg: RegExp, text: string): Sequence<TextOffset>;
-export declare function matchToTextOffset(reg: RegExp, text: TextOffset): Sequence<TextOffset>;
-export declare function extractLinesOfText(text: string): Sequence<TextOffset>;
+export declare function match(reg: RegExp, text: string): Iterable<RegExpExecArray>;
+export declare function matchStringToTextOffset(reg: RegExp, text: string): Iterable<TextOffset>;
+export declare function matchToTextOffset(reg: RegExp, text: TextOffset): Iterable<TextOffset>;
+export declare function extractLinesOfText(text: string): Iterable<TextOffset>;
 /**
  * Extract out whole words from a string of text.
  */
-export declare function extractWordsFromText(text: string): Sequence<TextOffset>;
+export declare function extractWordsFromText(text: string): Iterable<TextOffset>;
 /**
  * Extract out whole words from a string of text.
  */
-export declare function extractWordsFromTextOffset(text: TextOffset): Sequence<TextOffset>;
+export declare function extractWordsFromTextOffset(text: TextOffset): Iterable<TextOffset>;
 export declare function cleanText(text: string): string;
 export declare function cleanTextOffset(text: TextOffset): TextOffset;
 /**
  * Extract out whole words and words containing numbers from a string of text.
  */
-export declare function extractPossibleWordsFromTextOffset(text: TextOffset): Sequence<TextOffset>;
-export declare function extractWordsFromCode(text: string): Sequence<TextOffset>;
-export declare function extractWordsFromCodeTextOffset(textOffset: TextOffset): Sequence<TextOffset>;
+export declare function extractPossibleWordsFromTextOffset(text: TextOffset): Iterable<TextOffset>;
+export declare function extractWordsFromCode(text: string): Iterable<TextOffset>;
+export declare function extractWordsFromCodeTextOffset(textOffset: TextOffset): Iterable<TextOffset>;
 export declare function isUpperCase(word: string): boolean;
 export declare function isLowerCase(word: string): boolean;
 export declare function isFirstCharacterUpper(word: string): boolean;

package/dist/util/text.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.__testing__ = exports.removeAccents = exports.calculateTextDocumentOffsets = exports.stringToRegExp = exports.extractText = exports.textOffset = exports.matchCase = exports.camelToSnake = exports.snakeToCamel = exports.lcFirst = exports.ucFirst = exports.isFirstCharacterLower = exports.isFirstCharacterUpper = exports.isLowerCase = exports.isUpperCase = exports.extractWordsFromCodeTextOffset = exports.extractWordsFromCode = exports.extractPossibleWordsFromTextOffset = exports.cleanTextOffset = exports.cleanText = exports.extractWordsFromTextOffset = exports.extractWordsFromText = exports.extractLinesOfText = exports.matchToTextOffset = exports.matchStringToTextOffset = exports.match = exports.splitCamelCaseWord = exports.splitCamelCaseWordWithOffset = void 0;
+const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const gensequence_1 = require("gensequence");
 const search_1 = require("./search");
 const textRegex_1 = require("./textRegex");
@@ -17,7 +18,7 @@ exports.splitCamelCaseWordWithOffset = splitCamelCaseWordWithOffset;
  * Split camelCase words into an array of strings.
  */
 function splitCamelCaseWord(word) {
-    const wPrime = word.replace(textRegex_1.regExUpperSOrIng, (s) => s[0] + s.substr(1).toLowerCase());
+    const wPrime = word.replace(textRegex_1.regExUpperSOrIng, (s) => s[0] + s.slice(1).toLowerCase());
     const separator = '_<^*_*^>_';
     const pass1 = wPrime.replace(textRegex_1.regExSplitWords, '$1' + separator + '$2');
     const pass2 = pass1.replace(textRegex_1.regExSplitWords2, '$1' + separator + '$2');
@@ -38,7 +39,8 @@ exports.matchStringToTextOffset = matchStringToTextOffset;
 function matchToTextOffset(reg, text) {
     const textOffset = text;
     const fnOffsetMap = offsetMap(textOffset.offset);
-    return match(reg, textOffset.text).map((m) => fnOffsetMap({ text: m[0], offset: m.index }));
+    textOffset.text.matchAll(reg);
+    return (0, cspell_pipe_1.pipeSync)(match(reg, textOffset.text), (0, cspell_pipe_1.opMap)((m) => fnOffsetMap({ text: m[0], offset: m.index || 0 })));
 }
 exports.matchToTextOffset = matchToTextOffset;
 function extractLinesOfText(text) {
@@ -85,7 +87,7 @@ function extractWordsFromCode(text) {
 }
 exports.extractWordsFromCode = extractWordsFromCode;
 function extractWordsFromCodeTextOffset(textOffset) {
-    return extractWordsFromTextOffset(textOffset).concatMap(splitCamelCaseWordWithOffset);
+    return (0, cspell_pipe_1.pipeSync)(extractWordsFromTextOffset(textOffset), (0, cspell_pipe_1.opConcatMap)(splitCamelCaseWordWithOffset));
 }
 exports.extractWordsFromCodeTextOffset = extractWordsFromCodeTextOffset;
 function isUpperCase(word) {
@@ -173,7 +175,11 @@ function stringToRegExp(pattern, defaultFlags = 'gimu', forceFlags = 'g') {
 }
 exports.stringToRegExp = stringToRegExp;
 function calculateTextDocumentOffsets(uri, doc, wordOffsets) {
-    const lines = [-1, ...match(/\n/g, doc).map((a) => a.index), doc.length];
+    const lines = [
+        -1,
+        ...(0, cspell_pipe_1.pipeSync)(match(/\n/g, doc), (0, cspell_pipe_1.opMap)((a) => a.index)),
+        doc.length,
+    ];
     let lastRow = -1;
     let lastOffset = doc.length + 1;
     let lastLineRow = -1;

package/dist/util/types.d.ts

@@ -47,4 +47,16 @@ export declare type OnlyOptional<T> = {
     [P in keyof T as P extends OptionalKeys<T> ? P : never]: T[P];
 };
 export declare type MakeOptional<T> = OnlyRequired<T> & Partial<OnlyOptional<T>>;
+/**
+ * Like Required, but keeps the Optional.
+ */
+export declare type RemoveUndefined<T> = {
+    [P in keyof T]: Exclude<T[P], undefined>;
+};
+/**
+ * Allow undefined in optional fields
+ */
+export declare type OptionalOrUndefined<T> = {
+    [P in keyof T]: P extends OptionalKeys<T> ? T[P] | undefined : T[P];
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/util/util.d.ts

@@ -1,3 +1,4 @@
+import { RemoveUndefined } from './types';
 export declare const uniqueFn: typeof uniqueFilterFnGenerator;
 export declare function uniqueFilterFnGenerator<T>(): (v: T) => boolean;
 export declare function uniqueFilterFnGenerator<T, U>(extractFn: (v: T) => U): (v: T) => boolean;
@@ -6,7 +7,7 @@ export declare function unique<T>(src: T[]): T[];
  * Delete all `undefined` fields from an object.
  * @param src - object to be cleaned
  */
-export declare function clean<T>(src: T): T;
+export declare function clean<T>(src: T): RemoveUndefined<T>;
 /**
  * Creates a scan function that can be used in a map function.
  */
@@ -16,4 +17,11 @@ export declare function isDefined<T>(v: T | undefined): v is T;
 export declare function flattenIterable<T>(values: Iterable<Iterable<T>> | T[][]): Iterable<T>;
 export declare function flatten<T>(values: Iterable<Iterable<T>> | T[][]): T[];
 export declare function asyncIterableToArray<T>(iter: Iterable<T> | AsyncIterable<T>): Promise<Awaited<T>[]>;
+/**
+ * Shallow is Equal test.
+ * @param a - array of values
+ * @param b - array of values
+ * @returns true if the values of `a` are exactly equal to the values of `b`
+ */
+export declare function isArrayEqual<K>(a: K[], b: K[]): boolean;
 //# sourceMappingURL=util.d.ts.map

package/dist/util/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncIterableToArray = exports.flatten = exports.flattenIterable = exports.isDefined = exports.scanMap = exports.clean = exports.unique = exports.uniqueFilterFnGenerator = exports.uniqueFn = void 0;
+exports.isArrayEqual = exports.asyncIterableToArray = exports.flatten = exports.flattenIterable = exports.isDefined = exports.scanMap = exports.clean = exports.unique = exports.uniqueFilterFnGenerator = exports.uniqueFn = void 0;
 // alias for uniqueFilterFnGenerator
 exports.uniqueFn = uniqueFilterFnGenerator;
 function uniqueFilterFnGenerator(extractFn) {
@@ -68,4 +68,20 @@ async function asyncIterableToArray(iter) {
     return acc;
 }
 exports.asyncIterableToArray = asyncIterableToArray;
+/**
+ * Shallow is Equal test.
+ * @param a - array of values
+ * @param b - array of values
+ * @returns true if the values of `a` are exactly equal to the values of `b`
+ */
+function isArrayEqual(a, b) {
+    if (a === b)
+        return true;
+    let isMatch = a.length === b.length;
+    for (let i = 0; i < a.length && isMatch; ++i) {
+        isMatch = a[i] === b[i];
+    }
+    return isMatch;
+}
+exports.isArrayEqual = isArrayEqual;
 //# sourceMappingURL=util.js.map

package/dist/validator.d.ts

@@ -1,32 +1,3 @@
-import type { CSpellUserSettings } from '@cspell/cspell-types';
-import * as TV from './textValidator';
-export declare const diagSource = "cSpell Checker";
-export { IncludeExcludeOptions } from './textValidator';
-export interface ValidationIssue extends TV.ValidationResult {
-    suggestions?: string[];
-}
-export interface ValidateTextOptions {
-    /** Generate suggestions where there are spelling issues. */
-    generateSuggestions?: boolean;
-    /** The number of suggestions to generate. The higher the number the longer it takes. */
-    numSuggestions?: number;
-}
-export declare function validateText(text: string, settings: CSpellUserSettings, options?: ValidateTextOptions): Promise<ValidationIssue[]>;
-export declare function settingsToValidateOptions(settings: CSpellUserSettings): TV.ValidationOptions;
-export interface CheckTextInfo {
-    text: string;
-    items: TextInfoItem[];
-}
-export interface TextInfoItem {
-    text: string;
-    startPos: number;
-    endPos: number;
-    flagIE: IncludeExcludeFlag;
-    isError?: boolean;
-}
-export declare enum IncludeExcludeFlag {
-    INCLUDE = "I",
-    EXCLUDE = "E"
-}
-export declare function checkText(text: string, settings: CSpellUserSettings): Promise<CheckTextInfo>;
+export { checkText, IncludeExcludeFlag, validateText } from './textValidation';
+export type { CheckTextInfo, IncludeExcludeOptions, TextInfoItem, ValidateTextOptions, ValidationIssue, } from './textValidation';
 //# sourceMappingURL=validator.d.ts.map

package/dist/validator.js

@@ -1,127 +1,8 @@
 "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.checkText = exports.IncludeExcludeFlag = exports.settingsToValidateOptions = exports.validateText = exports.diagSource = void 0;
-const Settings = __importStar(require("./Settings"));
-const SpellingDictionary_1 = require("./SpellingDictionary");
-const TV = __importStar(require("./textValidator"));
-exports.diagSource = 'cSpell Checker';
-async function validateText(text, settings, options = {}) {
-    const finalSettings = Settings.finalizeSettings(settings);
-    const dict = await (0, SpellingDictionary_1.getDictionaryInternal)(finalSettings);
-    const issues = [...TV.validateText(text, dict, settingsToValidateOptions(finalSettings))];
-    if (!options.generateSuggestions) {
-        return issues;
-    }
-    const withSugs = issues.map((t) => {
-        var _a;
-        const suggestions = dict
-            .suggest(t.text, {
-            numSuggestions: options.numSuggestions,
-            compoundMethod: SpellingDictionary_1.CompoundWordsMethod.NONE,
-            includeTies: false,
-            ignoreCase: !((_a = settings.caseSensitive) !== null && _a !== void 0 ? _a : false),
-            timeout: settings.suggestionsTimeout,
-            numChanges: settings.suggestionNumChanges,
-        })
-            .map((r) => r.word);
-        return { ...t, suggestions };
-    });
-    return withSugs;
-}
-exports.validateText = validateText;
-function settingsToValidateOptions(settings) {
-    var _a;
-    const opt = {
-        ...settings,
-        ignoreCase: !((_a = settings.caseSensitive) !== null && _a !== void 0 ? _a : false),
-    };
-    return opt;
-}
-exports.settingsToValidateOptions = settingsToValidateOptions;
-var IncludeExcludeFlag;
-(function (IncludeExcludeFlag) {
-    IncludeExcludeFlag["INCLUDE"] = "I";
-    IncludeExcludeFlag["EXCLUDE"] = "E";
-})(IncludeExcludeFlag = exports.IncludeExcludeFlag || (exports.IncludeExcludeFlag = {}));
-async function checkText(text, settings) {
-    const validationResult = validateText(text, settings);
-    const finalSettings = Settings.finalizeSettings(settings);
-    const includeRanges = TV.calcTextInclusionRanges(text, finalSettings);
-    const result = [];
-    let lastPos = 0;
-    for (const { startPos, endPos } of includeRanges) {
-        result.push({
-            text: text.slice(lastPos, startPos),
-            startPos: lastPos,
-            endPos: startPos,
-            flagIE: IncludeExcludeFlag.EXCLUDE,
-        });
-        result.push({
-            text: text.slice(startPos, endPos),
-            startPos,
-            endPos,
-            flagIE: IncludeExcludeFlag.INCLUDE,
-        });
-        lastPos = endPos;
-    }
-    result.push({
-        text: text.slice(lastPos),
-        startPos: lastPos,
-        endPos: text.length,
-        flagIE: IncludeExcludeFlag.EXCLUDE,
-    });
-    const issues = await validationResult;
-    function* merge() {
-        let i = 0;
-        for (const r of result) {
-            if (i >= issues.length || issues[i].offset >= r.endPos) {
-                yield r;
-                continue;
-            }
-            const span = { ...r };
-            while (i < issues.length && issues[i].offset < span.endPos) {
-                const issue = issues[i];
-                const endPos = issue.offset;
-                const text = span.text.slice(0, endPos - span.startPos);
-                const endPosError = issue.offset + issue.text.length;
-                yield { ...span, text, endPos };
-                yield {
-                    ...span,
-                    isError: true,
-                    startPos: issue.offset,
-                    endPos: endPosError,
-                    text: issue.text,
-                };
-                span.text = span.text.slice(endPosError - span.startPos);
-                span.startPos = endPosError;
-                i += 1;
-            }
-            yield span;
-        }
-    }
-    return {
-        text,
-        items: [...merge()].filter((i) => i.startPos < i.endPos),
-    };
-}
-exports.checkText = checkText;
+exports.validateText = exports.IncludeExcludeFlag = exports.checkText = void 0;
+var textValidation_1 = require("./textValidation");
+Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return textValidation_1.checkText; } });
+Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return textValidation_1.IncludeExcludeFlag; } });
+Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return textValidation_1.validateText; } });
 //# sourceMappingURL=validator.js.map

package/dist/wordListHelper.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];
@@ -21,10 +25,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitLineIntoWords = exports.splitLineIntoCodeWords = exports.splitCodeWords = exports.splitLine = exports.loadWordsNoError = void 0;
 // cSpell:enableCompoundWords
-const Text = __importStar(require("./util/text"));
 const fileReader_1 = require("./util/fileReader");
 const iterableIteratorLib_1 = require("./util/iterableIteratorLib");
 const logger_1 = require("./util/logger");
+const Text = __importStar(require("./util/text"));
 const regExpWordsWithSpaces = /^\s*\p{L}+(?:\s+\p{L}+){0,3}$/u;
 /**
  * Reads words from a file. It will not throw and error.
@@ -35,9 +39,7 @@ function loadWordsNoError(filename) {
 }
 exports.loadWordsNoError = loadWordsNoError;
 function splitLine(line) {
-    return Text.extractWordsFromText(line)
-        .map(({ text }) => text)
-        .toArray();
+    return [...Text.extractWordsFromText(line)].map(({ text }) => text);
 }
 exports.splitLine = splitLine;
 function splitCodeWords(words) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "5.18.5",
+  "version": "5.19.0",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -48,22 +48,24 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "^5.18.5",
-    "@cspell/cspell-types": "^5.18.5",
+    "@cspell/cspell-bundled-dicts": "^5.19.0",
+    "@cspell/cspell-pipe": "^5.19.0",
+    "@cspell/cspell-types": "^5.19.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.2",
     "configstore": "^5.0.1",
     "cosmiconfig": "^7.0.1",
-    "cspell-glob": "^5.18.5",
-    "cspell-io": "^5.18.5",
-    "cspell-trie-lib": "^5.18.5",
+    "cspell-glob": "^5.19.0",
+    "cspell-io": "^5.19.0",
+    "cspell-trie-lib": "^5.19.0",
     "fast-equals": "^3.0.0",
     "find-up": "^5.0.0",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^10.0.1",
     "gensequence": "^3.1.1",
     "import-fresh": "^3.3.0",
     "resolve-from": "^5.0.0",
     "resolve-global": "^1.0.0",
+    "vscode-languageserver-textdocument": "^1.0.4",
     "vscode-uri": "^3.0.3"
   },
   "engines": {
@@ -73,22 +75,22 @@
     "@cspell/dict-cpp": "^1.1.40",
     "@cspell/dict-csharp": "^1.0.11",
     "@cspell/dict-css": "^1.0.13",
-    "@cspell/dict-fa-ir": "^1.0.17",
+    "@cspell/dict-fa-ir": "^2.0.0",
     "@cspell/dict-fr-fr": "^2.0.1",
     "@cspell/dict-html": "^1.1.9",
-    "@cspell/dict-nl-nl": "^2.2.2",
+    "@cspell/dict-nl-nl": "^2.2.3",
     "@cspell/dict-python": "^2.0.6",
     "@types/configstore": "^5.0.1",
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^27.4.0",
-    "@types/node": "^17.0.18",
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.21",
     "cspell-dict-nl-nl": "^1.1.2",
     "jest": "^27.5.1",
     "lorem-ipsum": "^2.0.4",
     "rimraf": "^3.0.2",
-    "rollup": "^2.67.2",
-    "rollup-plugin-dts": "^4.1.0",
+    "rollup": "^2.70.0",
+    "rollup-plugin-dts": "^4.2.0",
     "ts-jest": "^27.1.3"
   },
-  "gitHead": "bff6b01340bde5ca7a89860868e179592eaa7520"
+  "gitHead": "7873efe40a3287d3e025f705e1712c12d3cb392e"
 }

package/dist/SpellingDictionary/DictionaryLoaderTypes.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=DictionaryLoaderTypes.d.ts.map

package/dist/SpellingDictionary/DictionaryLoaderTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=DictionaryLoaderTypes.js.map