cspell-lib 9.6.3 → 9.6.4

package/dist/lib/Settings/DictionaryReferenceCollection.d.ts

@@ -1,10 +1,18 @@
 import type { DictionaryId, DictionaryReference } from '@cspell/cspell-types';
+/**
+ * A collection of dictionary references to determine if a dictionary is enabled or blocked.
+ */
 export interface DictionaryReferenceCollection {
     isEnabled(name: DictionaryId): boolean | undefined;
     isBlocked(name: DictionaryId): boolean | undefined;
     enabled(): DictionaryId[];
     blocked(): DictionaryId[];
-    dictionaryIds: DictionaryId[];
+    readonly dictionaryIds: DictionaryId[];
 }
+/**
+ * Create a collection of dictionary references to be able to easily determine if a dictionary is enabled or blocked.
+ * @param dictionaries - list of dictionary references
+ * @returns DictionaryReferenceCollection
+ */
 export declare function createDictionaryReferenceCollection(dictionaries: DictionaryReference[]): DictionaryReferenceCollection;
 //# sourceMappingURL=DictionaryReferenceCollection.d.ts.map

package/dist/lib/Settings/DictionaryReferenceCollection.js

@@ -1,3 +1,8 @@
+/**
+ * Create a collection of dictionary references to be able to easily determine if a dictionary is enabled or blocked.
+ * @param dictionaries - list of dictionary references
+ * @returns DictionaryReferenceCollection
+ */
 export function createDictionaryReferenceCollection(dictionaries) {
     return new _DictionaryReferenceCollection(dictionaries);
 }

package/dist/lib/Settings/index.d.ts

@@ -7,6 +7,8 @@ export { ImportError } from './Controller/ImportError.js';
 export type { ConfigurationDependencies, ImportFileRefWithError } from './CSpellSettingsServer.js';
 export { extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, toCSpellSettingsWithOutSourceTrace, } from './CSpellSettingsServer.js';
 export { defaultSettingsLoader, getDefaultBundledSettingsAsync, getDefaultSettings } from './DefaultSettings.js';
+export type { DictionaryReferenceCollection } from './DictionaryReferenceCollection.js';
+export { createDictionaryReferenceCollection } from './DictionaryReferenceCollection.js';
 export type { CSpellSettingsInternal, CSpellSettingsInternalFinalized, DictionaryDefinitionInlineInternal, DictionaryDefinitionInternal, DictionaryDefinitionSimpleInternal, DictionaryFileDefinitionInternal, } from './internal/index.js';
 export { calcDictionaryDefsToLoad, createCSpellSettingsInternal, filterDictDefsToLoad, isDictionaryDefinitionInlineInternal, isDictionaryFileDefinitionInternal, mapDictDefToInternal, } from './internal/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/lib/Settings/index.js

@@ -5,5 +5,6 @@ export { clearCachedSettingsFiles, createConfigLoader, defaultConfigFilenames, d
 export { ImportError } from './Controller/ImportError.js';
 export { extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, toCSpellSettingsWithOutSourceTrace, } from './CSpellSettingsServer.js';
 export { defaultSettingsLoader, getDefaultBundledSettingsAsync, getDefaultSettings } from './DefaultSettings.js';
+export { createDictionaryReferenceCollection } from './DictionaryReferenceCollection.js';
 export { calcDictionaryDefsToLoad, createCSpellSettingsInternal, filterDictDefsToLoad, isDictionaryDefinitionInlineInternal, isDictionaryFileDefinitionInternal, mapDictDefToInternal, } from './internal/index.js';
 //# sourceMappingURL=index.js.map

package/dist/lib/index.d.ts

@@ -12,9 +12,8 @@ export type { CreateTextDocumentParams, TextDocument, TextDocumentLine, TextDocu
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
 export type { PerfTimer } from './perf/index.js';
 export { createPerfTimer } from './perf/index.js';
-export type { ConfigurationDependencies, CSpellConfigFile, ICSpellConfigFile, ImportFileRefWithError, } from './Settings/index.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, toCSpellSettingsWithOutSourceTrace, } from './Settings/index.js';
-export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
+export type { ConfigurationDependencies, CSpellConfigFile, DictionaryReferenceCollection, ICSpellConfigFile, ImportFileRefWithError, } from './Settings/index.js';
+export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, createDictionaryReferenceCollection, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultFileName as defaultSettingsFilename, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, toCSpellSettingsWithOutSourceTrace, } from './Settings/index.js';
 export * as Link from './Settings/index.link.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';
 export { determineFinalDocumentSettings, type DetermineFinalDocumentSettingsResult, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, type SpellCheckFileOptions, type SpellCheckFilePerf, type SpellCheckFileResult, } from './spellCheckFile.js';

package/dist/lib/index.js

@@ -7,8 +7,7 @@ export { getLanguagesForBasename as getLanguageIdsForBaseFilename, getLanguagesF
 export { getDictionary } from './getDictionary.js';
 export { createTextDocument, updateTextDocument } from './Models/TextDocument.js';
 export { createPerfTimer } from './perf/index.js';
-export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, toCSpellSettingsWithOutSourceTrace, } from './Settings/index.js';
-export { defaultFileName as defaultSettingsFilename } from './Settings/index.js';
+export { calcOverrideSettings, checkFilenameMatchesGlob, createConfigLoader, createDictionaryReferenceCollection, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultFileName as defaultSettingsFilename, ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, finalizeSettings, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getGlobalSettings, getGlobalSettingsAsync, getSources, ImportError, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readRawSettings, readSettings, readSettingsFiles, resolveConfigFileImports, searchForConfig, sectionCSpell, toCSpellSettingsWithOutSourceTrace, } from './Settings/index.js';
 export * as Link from './Settings/index.link.js';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings.js';
 export { determineFinalDocumentSettings, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, } from './spellCheckFile.js';

package/dist/lib/trace.d.ts

@@ -5,6 +5,8 @@ import type { DictionaryTraceResult, WordSplits } from './textValidation/traceWo
 export interface TraceResult extends DictionaryTraceResult {
     /** True if the dictionary is currently active. */
     dictActive: boolean;
+    /** True if the dictionary is blocked from use. */
+    dictBlocked: boolean;
 }
 export interface TraceOptions {
     languageId?: LanguageId | LanguageId[];

package/dist/lib/trace.js

@@ -1,7 +1,7 @@
 import { satisfiesCSpellConfigFile } from 'cspell-config-lib';
 import { genSequence } from 'gensequence';
 import { toInternalSettings } from './Settings/CSpellSettingsServer.js';
-import { finalizeSettings, mergeSettings, resolveConfigFileImports } from './Settings/index.js';
+import { createDictionaryReferenceCollection, finalizeSettings, mergeSettings, resolveConfigFileImports, } from './Settings/index.js';
 import { calcSettingsForLanguageId } from './Settings/LanguageSettings.js';
 import { getDictionaryInternal, refreshDictionaryCache } from './SpellingDictionary/index.js';
 import { traceWord } from './textValidation/traceWord.js';
@@ -26,28 +26,33 @@ export async function* traceWordsAsync(words, settingsOrConfig, options) {
         }));
         const withLanguageId = calcSettingsForLanguageId(withLocale, languageId ?? withLocale.languageId ?? 'plaintext');
         const settings = finalizeSettings(withLanguageId);
-        const dictionaries = [
+        const rawDictionaryRefs = [
             ...(settings.dictionaries || []),
             ...(settings.dictionaryDefinitions || []).map((d) => d.name),
-        ].filter(util.uniqueFn);
+        ];
+        const dictionaryReferenceCollection = createDictionaryReferenceCollection(rawDictionaryRefs);
+        const dictionaries = [...dictionaryReferenceCollection.enabled(), ...dictionaryReferenceCollection.blocked()];
         const dictSettings = toInternalSettings({ ...settings, dictionaries });
         const dictBase = await getDictionaryInternal(settings);
         const dicts = await getDictionaryInternal(dictSettings);
         const activeDictionaries = dictBase.dictionaries.map((d) => d.name);
         return {
             activeDictionaries,
+            dictionaryReferenceCollection,
             config: settings,
             dicts,
         };
     }
     await refreshDictionaryCache();
-    const { config, dicts, activeDictionaries } = await finalize(settings);
+    const { activeDictionaries, config, dicts, dictionaryReferenceCollection } = await finalize(settings);
     const setOfActiveDicts = new Set(activeDictionaries);
+    const setOfExcludedDicts = new Set(dictionaryReferenceCollection.blocked());
     function processWord(word) {
         const results = traceWord(word, dicts, { ...config, ignoreCase, compoundSeparator });
         const r = results.map((r) => ({
             ...r,
             dictActive: setOfActiveDicts.has(r.dictName),
+            dictBlocked: setOfExcludedDicts.has(r.dictName),
             dictSource: toFilePathOrHref(r.dictSource),
             configSource: r.configSource || config.name || '',
             splits: results.splits,

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.6.3",
+  "version": "9.6.4",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -76,23 +76,23 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "9.6.3",
-    "@cspell/cspell-performance-monitor": "9.6.3",
-    "@cspell/cspell-pipe": "9.6.3",
-    "@cspell/cspell-resolver": "9.6.3",
-    "@cspell/cspell-types": "9.6.3",
-    "@cspell/dynamic-import": "9.6.3",
-    "@cspell/filetypes": "9.6.3",
-    "@cspell/rpc": "9.6.3",
-    "@cspell/strong-weak-map": "9.6.3",
-    "@cspell/url": "9.6.3",
+    "@cspell/cspell-bundled-dicts": "9.6.4",
+    "@cspell/cspell-performance-monitor": "9.6.4",
+    "@cspell/cspell-pipe": "9.6.4",
+    "@cspell/cspell-resolver": "9.6.4",
+    "@cspell/cspell-types": "9.6.4",
+    "@cspell/dynamic-import": "9.6.4",
+    "@cspell/filetypes": "9.6.4",
+    "@cspell/rpc": "9.6.4",
+    "@cspell/strong-weak-map": "9.6.4",
+    "@cspell/url": "9.6.4",
     "clear-module": "^4.1.2",
-    "cspell-config-lib": "9.6.3",
-    "cspell-dictionary": "9.6.3",
-    "cspell-glob": "9.6.3",
-    "cspell-grammar": "9.6.3",
-    "cspell-io": "9.6.3",
-    "cspell-trie-lib": "9.6.3",
+    "cspell-config-lib": "9.6.4",
+    "cspell-dictionary": "9.6.4",
+    "cspell-glob": "9.6.4",
+    "cspell-grammar": "9.6.4",
+    "cspell-io": "9.6.4",
+    "cspell-trie-lib": "9.6.4",
     "env-paths": "^4.0.0",
     "gensequence": "^8.0.8",
     "import-fresh": "^3.3.1",
@@ -105,7 +105,7 @@
     "node": ">=20"
   },
   "devDependencies": {
-    "@cspell/cspell-tools": "9.6.3",
+    "@cspell/cspell-tools": "9.6.4",
     "@cspell/dict-cpp": "^7.0.2",
     "@cspell/dict-csharp": "^4.0.8",
     "@cspell/dict-css": "^4.0.19",
@@ -123,5 +123,5 @@
     "lorem-ipsum": "^2.0.8",
     "perf-insight": "^2.0.1"
   },
-  "gitHead": "500b996b6c0a6ff025c42ef98db44776f43a9e72"
+  "gitHead": "e126c7f5708d4258ada35ba1d29d18952d7f0886"
 }