cspell-dictionary 6.24.0 → 6.25.0

package/dist/SpellingDictionary/SuggestDictionary.d.ts

@@ -0,0 +1,20 @@
+import type { IgnoreCaseOption, SpellingDictionary } from './SpellingDictionary';
+import { type TypoEntry, type TyposDef } from './Typos';
+export interface SuggestDictionary extends SpellingDictionary {
+    /**
+     * Determine if the word can appear in a list of suggestions.
+     * @param word - word
+     * @param ignoreCaseAndAccents - ignore case.
+     * @returns true if a word is suggested, otherwise false.
+     */
+    isSuggestedWord(word: string, ignoreCaseAndAccents?: IgnoreCaseOption): boolean;
+}
+/**
+ * Create a dictionary where all words are to be forbidden.
+ * @param entries - list of Typos Entries
+ * @param name - name of dictionary
+ * @param source - source
+ * @returns
+ */
+export declare function createSuggestDictionary(entries: readonly string[] | TyposDef | Iterable<TypoEntry>, name: string, source: string): SuggestDictionary;
+//# sourceMappingURL=SuggestDictionary.d.ts.map

package/dist/SpellingDictionary/SuggestDictionary.js

@@ -0,0 +1,120 @@
+"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.createSuggestDictionary = void 0;
+const sync_1 = require("@cspell/cspell-pipe/sync");
+const textMappers_1 = require("../util/textMappers");
+const defaults = __importStar(require("./defaults"));
+const Typos_1 = require("./Typos");
+const util_1 = require("./Typos/util");
+class SuggestDictionaryImpl {
+    constructor(name, source, typosDef) {
+        this.name = name;
+        this.source = source;
+        this.typosDef = typosDef;
+        this.containsNoSuggestWords = false;
+        this.options = {};
+        this.type = 'suggest';
+        this.isDictionaryCaseSensitive = true;
+        this.size = Object.keys(typosDef).length;
+        this.suggestions = (0, util_1.extractAllSuggestions)(typosDef);
+        this.suggestionsLower = new Set((0, sync_1.pipe)(this.suggestions, textMappers_1.mapperRemoveCaseAndAccents));
+    }
+    /**
+     * A Forbidden word list does not "have" valid words.
+     * Therefore it always returns false.
+     * @param _word - the word
+     * @param _options - options
+     * @returns always false
+     */
+    has(_word, _options) {
+        return false;
+    }
+    /** A more detailed search for a word, might take longer than `has` */
+    find(_word, _options) {
+        return undefined;
+    }
+    isForbidden(_word, _ignoreCaseAndAccents) {
+        return false;
+    }
+    isNoSuggestWord(_word, _options) {
+        return false;
+    }
+    /**
+     * Determine if the word can appear in a list of suggestions.
+     * @param word - word
+     * @param ignoreCaseAndAccents - ignore case.
+     * @returns true if a word is suggested, otherwise false.
+     */
+    isSuggestedWord(word, ignoreCaseAndAccents = defaults.isForbiddenIgnoreCaseAndAccents) {
+        if (this.suggestions.has(word))
+            return true;
+        const lcWord = word.toLowerCase();
+        return ignoreCaseAndAccents && (this.suggestions.has(lcWord) || this.suggestionsLower.has(lcWord));
+    }
+    suggest(word) {
+        return this._suggest(word) || this._suggest(word.toLowerCase()) || [];
+    }
+    _suggest(word) {
+        if (!(word in this.typosDef))
+            return undefined;
+        const sug = this.typosDef[word];
+        if (!sug)
+            return [];
+        if (typeof sug === 'string') {
+            return [
+                {
+                    word: sug,
+                    cost: 1,
+                    isPreferred: true,
+                },
+            ];
+        }
+        return sug.map((word, index) => ({ word, cost: index + 1 }));
+    }
+    genSuggestions(collector) {
+        const sugs = this.suggest(collector.word);
+        sugs.forEach((result) => collector.add(result));
+    }
+    mapWord(word) {
+        return word;
+    }
+    getErrors() {
+        return [];
+    }
+}
+/**
+ * Create a dictionary where all words are to be forbidden.
+ * @param entries - list of Typos Entries
+ * @param name - name of dictionary
+ * @param source - source
+ * @returns
+ */
+function createSuggestDictionary(entries, name, source) {
+    const def = (0, Typos_1.processEntriesToTyposDef)(entries);
+    return new SuggestDictionaryImpl(name, source, def);
+}
+exports.createSuggestDictionary = createSuggestDictionary;
+//# sourceMappingURL=SuggestDictionary.js.map

package/dist/SpellingDictionary/Typos/typosParser.d.ts

@@ -2,6 +2,23 @@ import type { TypoEntry, TyposDef } from './typos';
 export declare function createTyposDefFromEntries(entries: Iterable<TypoEntry>): TyposDef;
 export declare function sanitizeIntoTypoDef(dirtyDef: TyposDef | Record<string, unknown> | unknown): TyposDef | undefined;
 /**
+ * Parse Typos Entries
+ *
+ * Format:
+ * - `word:suggestion`
+ * - `word->suggestion`
+ * - `word: first, second, third suggestions`
+ *
+ * Note:
+ * ```plaintext
+ * yellow:blue, green
+ * ```
+ * Is the same as multiple entries with the same key and different suggestions.
+ * ```plaintext
+ * yellow:blue
+ * yellow:green
+ * ```
+ *
  * Used to process entries found in a `cspell.json` file.
  * @param entries - entries to process
  * @returns a TyposDef

package/dist/SpellingDictionary/Typos/typosParser.js

@@ -62,6 +62,23 @@ function sanitizeIntoTypoDef(dirtyDef) {
 }
 exports.sanitizeIntoTypoDef = sanitizeIntoTypoDef;
 /**
+ * Parse Typos Entries
+ *
+ * Format:
+ * - `word:suggestion`
+ * - `word->suggestion`
+ * - `word: first, second, third suggestions`
+ *
+ * Note:
+ * ```plaintext
+ * yellow:blue, green
+ * ```
+ * Is the same as multiple entries with the same key and different suggestions.
+ * ```plaintext
+ * yellow:blue
+ * yellow:green
+ * ```
+ *
  * Used to process entries found in a `cspell.json` file.
  * @param entries - entries to process
  * @returns a TyposDef

package/dist/SpellingDictionary/Typos/util.d.ts

@@ -1,4 +1,12 @@
 import type { TypoEntry, TyposDef, TyposDefKey, TyposDefValue } from './typos';
+export declare function mergeDefEntry(targetDef: TyposDef, key: string, value: TyposDefValue): TyposDef;
+/**
+ * Merge in place the entries `fromDef` into `targetDef`
+ * @param targetDef - the target
+ * @param fromDef - the source
+ * @returns the target
+ */
+export declare function mergeDef(targetDef: TyposDef, fromDef: TyposDef): TyposDef;
 /**
  * Append an entry to a TyposDef.
  * @param def - modified in place

package/dist/SpellingDictionary/Typos/util.js

@@ -1,7 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractIgnoreValues = exports.extractAllSuggestions = exports.createTyposDef = exports.appendToDef = void 0;
+exports.extractIgnoreValues = exports.extractAllSuggestions = exports.createTyposDef = exports.appendToDef = exports.mergeDef = exports.mergeDefEntry = void 0;
 const sync_1 = require("@cspell/cspell-pipe/sync");
+function normalizeTyposDefValue(value) {
+    if (!value)
+        return false;
+    if (typeof value === 'string')
+        return value;
+    const unique = [...new Set(value)];
+    return unique.length > 1 ? unique : unique.length === 1 ? unique[0] : false;
+}
+function mergeDefEntry(targetDef, key, value) {
+    const curValue = targetDef[key];
+    if (!curValue) {
+        targetDef[key] = normalizeTyposDefValue(value);
+        return targetDef;
+    }
+    if (!value)
+        return targetDef;
+    const newValue = Array.isArray(curValue) ? curValue : [curValue];
+    if (Array.isArray(value)) {
+        newValue.push(...value);
+    }
+    else {
+        newValue.push(value);
+    }
+    targetDef[key] = normalizeTyposDefValue(newValue);
+    return targetDef;
+}
+exports.mergeDefEntry = mergeDefEntry;
+/**
+ * Merge in place the entries `fromDef` into `targetDef`
+ * @param targetDef - the target
+ * @param fromDef - the source
+ * @returns the target
+ */
+function mergeDef(targetDef, fromDef) {
+    for (const key of Object.keys(fromDef)) {
+        mergeDefEntry(targetDef, key, fromDef[key]);
+    }
+    return targetDef;
+}
+exports.mergeDef = mergeDef;
 /**
  * Append an entry to a TyposDef.
  * @param def - modified in place
@@ -12,7 +52,9 @@ function appendToDef(def, entry) {
     if (!entry)
         return def;
     if (typeof entry === 'string') {
-        def[entry] = false;
+        if (!def[entry]) {
+            def[entry] = false;
+        }
         return def;
     }
     if (Array.isArray(entry)) {
@@ -20,11 +62,9 @@ function appendToDef(def, entry) {
         if (!key)
             return def;
         const s = sugs.map((s) => s.trim()).filter((s) => !!s);
-        def[key] = !s.length ? false : s.length === 1 ? s[0] : s;
-        return def;
+        return mergeDefEntry(def, key, s);
     }
-    Object.assign(def, entry);
-    return def;
+    return mergeDef(def, entry);
 }
 exports.appendToDef = appendToDef;
 function createTyposDef(entries) {

package/dist/SpellingDictionary/createInlineSpellingDictionary.js

@@ -6,12 +6,14 @@ const createSpellingDictionary_1 = require("./createSpellingDictionary");
 const FlagWordsDictionary_1 = require("./FlagWordsDictionary");
 const IgnoreWordsDictionary_1 = require("./IgnoreWordsDictionary");
 const SpellingDictionaryCollection_1 = require("./SpellingDictionaryCollection");
+const SuggestDictionary_1 = require("./SuggestDictionary");
 function createInlineSpellingDictionary(inlineDict, source) {
-    const { words, flagWords, ignoreWords, name } = inlineDict;
+    const { words, flagWords, ignoreWords, suggestWords, name } = inlineDict;
     const dictSources = [
         words && (0, createSpellingDictionary_1.createSpellingDictionary)(words, name + '-words', source, inlineDict),
         flagWords && (0, FlagWordsDictionary_1.createFlagWordsDictionary)(flagWords, name + '-flag-words', source),
         ignoreWords && (0, IgnoreWordsDictionary_1.createIgnoreWordsDictionary)(ignoreWords, name + '-ignore-words', source),
+        suggestWords && (0, SuggestDictionary_1.createSuggestDictionary)(suggestWords, name + '-suggest', source),
     ].filter(util_1.isDefined);
     return (0, SpellingDictionaryCollection_1.createCollection)(dictSources, name);
 }

package/dist/SpellingDictionary/index.d.ts

@@ -6,5 +6,6 @@ export { createIgnoreWordsDictionary } from './IgnoreWordsDictionary';
 export type { DictionaryDefinitionInline, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary';
 export { createCollection, SpellingDictionaryCollection } from './SpellingDictionaryCollection';
 export { createSpellingDictionaryFromTrieFile } from './SpellingDictionaryFromTrie';
+export { createSuggestDictionary } from './SuggestDictionary';
 export { createTyposDictionary } from './TyposDictionary';
 //# sourceMappingURL=index.d.ts.map

package/dist/SpellingDictionary/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTyposDictionary = exports.createSpellingDictionaryFromTrieFile = exports.createCollection = exports.createIgnoreWordsDictionary = exports.createForbiddenWordsDictionary = exports.createFlagWordsDictionary = exports.createSpellingDictionary = exports.createFailedToLoadDictionary = exports.createInlineSpellingDictionary = exports.createCachingDictionary = void 0;
+exports.createTyposDictionary = exports.createSuggestDictionary = exports.createSpellingDictionaryFromTrieFile = exports.createCollection = exports.createIgnoreWordsDictionary = exports.createForbiddenWordsDictionary = exports.createFlagWordsDictionary = exports.createSpellingDictionary = exports.createFailedToLoadDictionary = exports.createInlineSpellingDictionary = exports.createCachingDictionary = void 0;
 var CachingDictionary_1 = require("./CachingDictionary");
 Object.defineProperty(exports, "createCachingDictionary", { enumerable: true, get: function () { return CachingDictionary_1.createCachingDictionary; } });
 var createInlineSpellingDictionary_1 = require("./createInlineSpellingDictionary");
@@ -17,6 +17,8 @@ var SpellingDictionaryCollection_1 = require("./SpellingDictionaryCollection");
 Object.defineProperty(exports, "createCollection", { enumerable: true, get: function () { return SpellingDictionaryCollection_1.createCollection; } });
 var SpellingDictionaryFromTrie_1 = require("./SpellingDictionaryFromTrie");
 Object.defineProperty(exports, "createSpellingDictionaryFromTrieFile", { enumerable: true, get: function () { return SpellingDictionaryFromTrie_1.createSpellingDictionaryFromTrieFile; } });
+var SuggestDictionary_1 = require("./SuggestDictionary");
+Object.defineProperty(exports, "createSuggestDictionary", { enumerable: true, get: function () { return SuggestDictionary_1.createSuggestDictionary; } });
 var TyposDictionary_1 = require("./TyposDictionary");
 Object.defineProperty(exports, "createTyposDictionary", { enumerable: true, get: function () { return TyposDictionary_1.createTyposDictionary; } });
 //# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export type { CachingDictionary, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary';
-export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, } from './SpellingDictionary';
+export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, } from './SpellingDictionary';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSpellingDictionaryFromTrieFile = exports.createSpellingDictionary = exports.createInlineSpellingDictionary = exports.createIgnoreWordsDictionary = exports.createForbiddenWordsDictionary = exports.createFlagWordsDictionary = exports.createFailedToLoadDictionary = exports.createCollection = exports.createCachingDictionary = void 0;
+exports.createSuggestDictionary = exports.createSpellingDictionaryFromTrieFile = exports.createSpellingDictionary = exports.createInlineSpellingDictionary = exports.createIgnoreWordsDictionary = exports.createForbiddenWordsDictionary = exports.createFlagWordsDictionary = exports.createFailedToLoadDictionary = exports.createCollection = exports.createCachingDictionary = void 0;
 var SpellingDictionary_1 = require("./SpellingDictionary");
 Object.defineProperty(exports, "createCachingDictionary", { enumerable: true, get: function () { return SpellingDictionary_1.createCachingDictionary; } });
 Object.defineProperty(exports, "createCollection", { enumerable: true, get: function () { return SpellingDictionary_1.createCollection; } });
@@ -11,4 +11,5 @@ Object.defineProperty(exports, "createIgnoreWordsDictionary", { enumerable: true
 Object.defineProperty(exports, "createInlineSpellingDictionary", { enumerable: true, get: function () { return SpellingDictionary_1.createInlineSpellingDictionary; } });
 Object.defineProperty(exports, "createSpellingDictionary", { enumerable: true, get: function () { return SpellingDictionary_1.createSpellingDictionary; } });
 Object.defineProperty(exports, "createSpellingDictionaryFromTrieFile", { enumerable: true, get: function () { return SpellingDictionary_1.createSpellingDictionaryFromTrieFile; } });
+Object.defineProperty(exports, "createSuggestDictionary", { enumerable: true, get: function () { return SpellingDictionary_1.createSuggestDictionary; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-dictionary",
-  "version": "6.24.0",
+  "version": "6.25.0",
   "description": "A spelling dictionary library useful for checking words and getting suggestions.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -43,11 +43,11 @@
     "ts-jest": "^29.0.5"
   },
   "dependencies": {
-    "@cspell/cspell-pipe": "6.24.0",
-    "@cspell/cspell-types": "6.24.0",
-    "cspell-trie-lib": "6.24.0",
+    "@cspell/cspell-pipe": "6.25.0",
+    "@cspell/cspell-types": "6.25.0",
+    "cspell-trie-lib": "6.25.0",
     "fast-equals": "^4.0.3",
     "gensequence": "^4.0.3"
   },
-  "gitHead": "0d1e8bf9426cd0bfb814df4f61da12d8aee57ddd"
+  "gitHead": "fd7541605e07c43887191097d58ab58d87fac8fd"
 }