cspell-lib 6.7.0 → 6.8.2

package/dist/Settings/Controller/configLoader/normalizeRawSettings.js

@@ -0,0 +1,136 @@
+"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.normalizeCacheSettings = exports.normalizeSettingsGlobs = exports.normalizeGitignoreRoot = exports.normalizeLanguageSettings = exports.normalizeReporters = exports.normalizeOverrides = exports.normalizeDictionaryDefs = exports.normalizeRawConfig = void 0;
+const path = __importStar(require("path"));
+const resolveFile_1 = require("../../../util/resolveFile");
+const util = __importStar(require("../../../util/util"));
+const DictionarySettings_1 = require("../../DictionarySettings");
+const toGlobDef_1 = require("./toGlobDef");
+function normalizeRawConfig(config) {
+    if (typeof config.version === 'number') {
+        config.version = config.version.toString();
+    }
+}
+exports.normalizeRawConfig = normalizeRawConfig;
+function normalizeDictionaryDefs(settings, pathToSettingsFile) {
+    const dictionaryDefinitions = (0, DictionarySettings_1.mapDictDefsToInternal)(settings.dictionaryDefinitions, pathToSettingsFile);
+    const languageSettings = settings.languageSettings?.map((langSetting) => util.clean({
+        ...langSetting,
+        dictionaryDefinitions: (0, DictionarySettings_1.mapDictDefsToInternal)(langSetting.dictionaryDefinitions, pathToSettingsFile),
+    }));
+    return util.clean({
+        dictionaryDefinitions,
+        languageSettings,
+    });
+}
+exports.normalizeDictionaryDefs = normalizeDictionaryDefs;
+function normalizeOverrides(settings, pathToSettingsFile) {
+    const { globRoot = path.dirname(pathToSettingsFile) } = settings;
+    const overrides = settings.overrides?.map((override) => {
+        const filename = (0, toGlobDef_1.toGlobDef)(override.filename, globRoot, pathToSettingsFile);
+        const { dictionaryDefinitions, languageSettings } = normalizeDictionaryDefs(override, pathToSettingsFile);
+        return util.clean({
+            ...override,
+            filename,
+            dictionaryDefinitions,
+            languageSettings: normalizeLanguageSettings(languageSettings),
+        });
+    });
+    return overrides ? { overrides } : {};
+}
+exports.normalizeOverrides = normalizeOverrides;
+function normalizeReporters(settings, pathToSettingsFile) {
+    if (settings.reporters === undefined)
+        return {};
+    const folder = path.dirname(pathToSettingsFile);
+    function resolve(s) {
+        const r = (0, resolveFile_1.resolveFile)(s, folder);
+        if (!r.found) {
+            throw new Error(`Not found: "${s}"`);
+        }
+        return r.filename;
+    }
+    function resolveReporter(s) {
+        if (typeof s === 'string') {
+            return resolve(s);
+        }
+        if (!Array.isArray(s) || typeof s[0] !== 'string')
+            throw new Error('Invalid Reporter');
+        // Preserve the shape of Reporter Setting while resolving the reporter file.
+        const [r, ...rest] = s;
+        return [resolve(r), ...rest];
+    }
+    return {
+        reporters: settings.reporters.map(resolveReporter),
+    };
+}
+exports.normalizeReporters = normalizeReporters;
+function normalizeLanguageSettings(languageSettings) {
+    if (!languageSettings)
+        return undefined;
+    function fixLocale(s) {
+        const { local: locale, ...rest } = s;
+        return util.clean({ locale, ...rest });
+    }
+    return languageSettings.map(fixLocale);
+}
+exports.normalizeLanguageSettings = normalizeLanguageSettings;
+function normalizeGitignoreRoot(settings, pathToSettingsFile) {
+    const { gitignoreRoot } = settings;
+    if (!gitignoreRoot)
+        return {};
+    const dir = path.dirname(pathToSettingsFile);
+    const roots = Array.isArray(gitignoreRoot) ? gitignoreRoot : [gitignoreRoot];
+    return {
+        gitignoreRoot: roots.map((p) => path.resolve(dir, p)),
+    };
+}
+exports.normalizeGitignoreRoot = normalizeGitignoreRoot;
+function normalizeSettingsGlobs(settings, pathToSettingsFile) {
+    const { globRoot } = settings;
+    if (settings.ignorePaths === undefined)
+        return {};
+    const ignorePaths = (0, toGlobDef_1.toGlobDef)(settings.ignorePaths, globRoot, pathToSettingsFile);
+    return {
+        ignorePaths,
+    };
+}
+exports.normalizeSettingsGlobs = normalizeSettingsGlobs;
+function normalizeCacheSettings(settings, pathToSettingsDir) {
+    const { cache } = settings;
+    if (cache === undefined)
+        return {};
+    const { cacheLocation } = cache;
+    if (cacheLocation === undefined)
+        return { cache };
+    return { cache: { ...cache, cacheLocation: resolveFilePath(cacheLocation, pathToSettingsDir) } };
+}
+exports.normalizeCacheSettings = normalizeCacheSettings;
+function resolveFilePath(filename, pathToSettingsFile) {
+    const cwd = process.cwd();
+    return path.resolve(pathToSettingsFile, filename.replace('${cwd}', cwd));
+}
+//# sourceMappingURL=normalizeRawSettings.js.map

package/dist/Settings/Controller/configLoader/readSettings.d.ts

@@ -0,0 +1,23 @@
+import { CSpellSettingsI, CSpellSettingsWST } from './configLoader';
+/**
+ * Read / import a cspell configuration file.
+ * @param filename - the path to the file.
+ *   Supported types: json, yaml, js, and cjs. ES Modules are not supported.
+ *   - absolute path `/absolute/path/to/file`
+ *   - relative path `./path/to/file` (relative to the current working directory)
+ *   - package `@cspell/dict-typescript/cspell-ext.json`
+ */
+export declare function readSettings(filename: string): CSpellSettingsI;
+export declare function readSettings(filename: string, defaultValues: CSpellSettingsWST): CSpellSettingsI;
+/**
+ * Read / import a cspell configuration file.
+ * @param filename - the path to the file.
+ *   Supported types: json, yaml, js, and cjs. ES Modules are not supported.
+ *   - absolute path `/absolute/path/to/file`
+ *   - relative path `./path/to/file` (relative to `relativeTo`)
+ *   - package `@cspell/dict-typescript/cspell-ext.json` searches for node_modules relative to `relativeTo`
+ * @param relativeTo - absolute path to start searching for relative files or node_modules.
+ */
+export declare function readSettings(filename: string, relativeTo: string): CSpellSettingsI;
+export declare function readSettings(filename: string, relativeTo: string, defaultValues: CSpellSettingsWST): CSpellSettingsI;
+//# sourceMappingURL=readSettings.d.ts.map

package/dist/Settings/Controller/configLoader/readSettings.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readSettings = void 0;
+const configLoader_1 = require("./configLoader");
+function readSettings(filename, relativeToOrDefault, defaultValue) {
+    const loader = (0, configLoader_1.getDefaultConfigLoader)();
+    if (typeof relativeToOrDefault !== 'string' || defaultValue === undefined)
+        return loader.readSettings(filename, relativeToOrDefault);
+    return loader.readSettings(filename, relativeToOrDefault, defaultValue);
+}
+exports.readSettings = readSettings;
+//# sourceMappingURL=readSettings.js.map

package/dist/Settings/Controller/configLoader/toGlobDef.d.ts

@@ -0,0 +1,6 @@
+import { Glob, GlobDef } from '@cspell/cspell-types';
+export declare function toGlobDef(g: undefined, root: string | undefined, source: string | undefined): undefined;
+export declare function toGlobDef(g: Glob, root: string | undefined, source: string | undefined): GlobDef;
+export declare function toGlobDef(g: Glob[], root: string | undefined, source: string | undefined): GlobDef[];
+export declare function toGlobDef(g: Glob | Glob[], root: string | undefined, source: string | undefined): GlobDef | GlobDef[];
+//# sourceMappingURL=toGlobDef.d.ts.map

package/dist/Settings/Controller/configLoader/toGlobDef.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toGlobDef = void 0;
+function toGlobDef(g, root, source) {
+    if (g === undefined)
+        return undefined;
+    if (Array.isArray(g)) {
+        return g.map((g) => toGlobDef(g, root, source));
+    }
+    if (typeof g === 'string') {
+        const glob = { glob: g };
+        if (root !== undefined) {
+            glob.root = root;
+        }
+        return toGlobDef(glob, root, source);
+    }
+    if (source) {
+        return { ...g, source };
+    }
+    return g;
+}
+exports.toGlobDef = toGlobDef;
+//# sourceMappingURL=toGlobDef.js.map

package/dist/Settings/InDocSettings.d.ts

@@ -1,7 +1,23 @@
 import type { CSpellUserSettings } from '@cspell/cspell-types';
 import { Sequence } from 'gensequence';
 export declare type CSpellUserSettingsKeys = keyof CSpellUserSettings;
+export interface DirectiveIssue {
+    /**
+     * the start and end offsets within the document of the issue.
+     */
+    range: [start: number, end: number];
+    /**
+     * The text causing the issue.
+     */
+    text: string;
+    message: string;
+    suggestions: string[];
+}
 export declare function getInDocumentSettings(text: string): CSpellUserSettings;
+export declare function validateInDocumentSettings(docText: string, _settings: CSpellUserSettings): Iterable<DirectiveIssue>;
+export declare const regExSpellingGuardBlock: RegExp;
+export declare const regExSpellingGuardNext: RegExp;
+export declare const regExSpellingGuardLine: RegExp;
 declare function parseCompoundWords(match: string): CSpellUserSettings;
 declare function parseWords(match: string): CSpellUserSettings;
 declare function parseIgnoreWords(match: string): CSpellUserSettings;

package/dist/Settings/InDocSettings.js

@@ -23,14 +23,70 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.internal = exports.getIgnoreRegExpFromDocument = exports.getIgnoreWordsFromDocument = exports.getInDocumentSettings = void 0;
+exports.internal = exports.getIgnoreRegExpFromDocument = exports.getIgnoreWordsFromDocument = exports.regExSpellingGuardLine = exports.regExSpellingGuardNext = exports.regExSpellingGuardBlock = exports.validateInDocumentSettings = exports.getInDocumentSettings = void 0;
+const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const gensequence_1 = require("gensequence");
+const SpellingDictionary_1 = require("../SpellingDictionary");
 const Text = __importStar(require("../util/text"));
 const util_1 = require("../util/util");
 const CSpellSettingsServer_1 = require("./CSpellSettingsServer");
 // cspell:ignore gimuy
 const regExMatchRegEx = /\/.*\/[gimuy]*/;
-const regExInFileSettings = [/(?:spell-?checker|c?spell)::?(.*)/gi, /(LocalWords:?.*)/g];
+const regExCSpellInDocDirective = /(?:spell-?checker|c?spell)::?(.*)/gi;
+const regExCSpellDirectiveKey = /(?<=(?:spell-?checker|c?spell)::?)(?!:)(.*)/i;
+const regExInFileSettings = [regExCSpellInDocDirective, /(LocalWords:?.*)/g];
+const officialDirectives = [
+    'enable',
+    'disable',
+    'disable-line',
+    'disable-next',
+    'disable-next-line',
+    'word',
+    'words',
+    'ignore',
+    'ignoreWord',
+    'ignoreWords',
+    'ignore-word',
+    'ignore-words',
+    'includeRegExp',
+    'ignoreRegExp',
+    'local',
+    'locale',
+    'language',
+    'dictionaries',
+    'dictionary',
+    'forbid',
+    'forbidWord',
+    'forbid-word',
+    'flag',
+    'flagWord',
+    'flag-word',
+    'enableCompoundWords',
+    'enableAllowCompoundWords',
+    'disableCompoundWords',
+    'disableAllowCompoundWords',
+    'enableCaseSensitive',
+    'disableCaseSensitive',
+];
+const noSuggestDirectives = new Set(['local']);
+const preferredDirectives = [
+    'enable',
+    'disable',
+    'disable-line',
+    'disable-next-line',
+    'words',
+    'ignore',
+    'forbid',
+    'locale',
+    'dictionary',
+    'dictionaries',
+    'enableCaseSensitive',
+    'disableCaseSensitive',
+];
+const allDirectives = new Set(preferredDirectives.concat(officialDirectives));
+const dictInDocSettings = (0, SpellingDictionary_1.createSpellingDictionary)(allDirectives, 'Directives', 'Directive List', {
+    supportNonStrictSearches: false,
+});
 const EmptyWords = [];
 Object.freeze(EmptyWords);
 function getInDocumentSettings(text) {
@@ -43,21 +99,66 @@ function getInDocumentSettings(text) {
     return settings;
 }
 exports.getInDocumentSettings = getInDocumentSettings;
+function validateInDocumentSettings(docText, _settings) {
+    return (0, cspell_pipe_1.pipeSync)(getPossibleInDocSettings(docText), (0, cspell_pipe_1.opMap)(parseSettingMatchValidation), (0, cspell_pipe_1.opFilter)(util_1.isDefined));
+}
+exports.validateInDocumentSettings = validateInDocumentSettings;
+const settingParsers = [
+    [/^(?:enable|disable)(?:allow)?CompoundWords\b(?!-)/i, parseCompoundWords],
+    [/^(?:enable|disable)CaseSensitive\b(?!-)/i, parseCaseSensitive],
+    [/^enable\b(?!-)/i, parseEnable],
+    [/^disable(-line|-next(-line)?)?\b(?!-)/i, parseDisable],
+    [/^words?\b(?!-)/i, parseWords],
+    [/^ignore(?:-?words?)?\b(?!-)/i, parseIgnoreWords],
+    [/^(?:flag|forbid)(?:-?words?)?\b(?!-)/i, parseFlagWords],
+    [/^ignore_?Reg_?Exp\s+.+$/i, parseIgnoreRegExp],
+    [/^include_?Reg_?Exp\s+.+$/i, parseIncludeRegExp],
+    [/^locale?\b(?!-)/i, parseLocale],
+    [/^language\s\b(?!-)/i, parseLocale],
+    [/^dictionar(?:y|ies)\b(?!-)/i, parseDictionaries],
+    [/^LocalWords:/, (w) => parseWords(w.replace(/^LocalWords:?/gi, ' '))],
+];
+exports.regExSpellingGuardBlock = /(\bc?spell(?:-?checker)?::?)\s*disable(?!-line|-next)\b[\s\S]*?((?:\1\s*enable\b)|$)/gi;
+exports.regExSpellingGuardNext = /\bc?spell(?:-?checker)?::?\s*disable-next\b.*\s\s?.*/gi;
+exports.regExSpellingGuardLine = /^.*\bc?spell(?:-?checker)?::?\s*disable-line\b.*/gim;
+const issueMessages = {
+    unknownDirective: 'Unknown CSpell directive',
+};
+function parseSettingMatchValidation(matchArray) {
+    const [fullMatch = ''] = matchArray;
+    const directiveMatch = fullMatch.match(regExCSpellDirectiveKey);
+    if (!directiveMatch)
+        return undefined;
+    const match = directiveMatch[1];
+    const possibleSetting = match.trim();
+    if (!possibleSetting)
+        return undefined;
+    const start = (matchArray.index || 0) + (directiveMatch.index || 0) + (match.length - match.trimStart().length);
+    const text = possibleSetting.replace(/^([-\w]+)?.*/, '$1');
+    const end = start + text.length;
+    if (!text)
+        return undefined;
+    const matchingParsers = settingParsers.filter(([regex]) => regex.test(possibleSetting));
+    if (matchingParsers.length > 0)
+        return undefined;
+    // No matches were found, let make some suggestions.
+    const dictSugs = dictInDocSettings
+        .suggest(text, { ignoreCase: false })
+        .map((sug) => sug.word)
+        .filter((a) => !noSuggestDirectives.has(a));
+    const sugs = new Set((0, cspell_pipe_1.pipeSync)(dictSugs, (0, cspell_pipe_1.opAppend)(allDirectives)));
+    const suggestions = [...sugs].slice(0, 8);
+    const issue = {
+        range: [start, end],
+        text,
+        message: issueMessages.unknownDirective,
+        suggestions,
+    };
+    return issue;
+}
 function parseSettingMatch(matchArray) {
     const [, match = ''] = matchArray;
     const possibleSetting = match.trim();
-    const settingParsers = [
-        [/^(?:enable|disable)(?:allow)?CompoundWords/i, parseCompoundWords],
-        [/^(?:enable|disable)CaseSensitive/i, parseCaseSensitive],
-        [/^words?\s/i, parseWords],
-        [/^ignore(?:words?)?\s/i, parseIgnoreWords],
-        [/^ignore_?Reg_?Exp\s+.+$/i, parseIgnoreRegExp],
-        [/^include_?Reg_?Exp\s+.+$/i, parseIncludeRegExp],
-        [/^locale?\s/i, parseLocale],
-        [/^language\s/i, parseLocale],
-        [/^dictionaries\s/i, parseDictionaries],
-        [/^LocalWords:/, (w) => parseWords(w.replace(/LocalWords:?/gi, ' '))],
-    ];
     return settingParsers
         .filter(([regex]) => regex.test(possibleSetting))
         .map(([, fn]) => fn)
@@ -72,7 +173,11 @@ function parseCaseSensitive(match) {
     return { id: 'in-doc-caseSensitive', caseSensitive };
 }
 function parseWords(match) {
-    const words = match.split(/[,\s]+/g).slice(1);
+    const words = match
+        // .replace(/[@#$%^&={}/"]/g, ' ')
+        .split(/[,\s;]+/g)
+        .slice(1)
+        .filter((a) => !!a);
     return { id: 'in-doc-words', words };
 }
 function parseLocale(match) {
@@ -84,6 +189,10 @@ function parseIgnoreWords(match) {
     const wordsSetting = parseWords(match);
     return (0, util_1.clean)({ id: 'in-doc-ignore', ignoreWords: wordsSetting.words });
 }
+function parseFlagWords(match) {
+    const wordsSetting = parseWords(match);
+    return (0, util_1.clean)({ id: 'in-doc-forbid', flagWords: wordsSetting.words });
+}
 function parseRegEx(match) {
     const patterns = [match.replace(/^[^\s]+\s+/, '')].map((a) => {
         const m = a.match(regExMatchRegEx);
@@ -113,6 +222,14 @@ function getWordsFromDocument(text) {
     const { words = EmptyWords } = getInDocumentSettings(text);
     return words;
 }
+function parseEnable(_match) {
+    // Do nothing. Enable / Disable is handled in a different way.
+    return {};
+}
+function parseDisable(_match) {
+    // Do nothing. Enable / Disable is handled in a different way.
+    return {};
+}
 function getIgnoreWordsFromDocument(text) {
     const { ignoreWords = EmptyWords } = getInDocumentSettings(text);
     return ignoreWords;

package/dist/Settings/RegExpPatterns.js

@@ -12,7 +12,7 @@ exports.regExCStyleHexValue = /\b0x[0-9a-f]+\b/gi;
 exports.regExCSSHexValue = /#[0-9a-f]{3,8}\b/gi;
 exports.regExUUID = /\b[0-9a-fx]{8}-[0-9a-fx]{4}-[0-9a-fx]{4}-[0-9a-fx]{4}-[0-9a-fx]{12}\b/gi; // x - represents placeholder values
 exports.regExUnicodeRef = /\bU\+[0-9a-f]{4,5}(?:-[0-9a-f]{4,5})?/gi;
-exports.regExSpellingGuardBlock = /(\bc?spell(?:-?checker)?::?)\s*disable(?!-line|-next)\b[\s\S]*?((?:\1\s*enable\b)|$)/gi;
+exports.regExSpellingGuardBlock = /(\bc?spell(?:-?checker)?::?)\s*disable(?!-line|-next)\b(?!-)[\s\S]*?((?:\1\s*enable\b)|$)/gi;
 exports.regExSpellingGuardNext = /\bc?spell(?:-?checker)?::?\s*disable-next\b.*\s\s?.*/gi;
 exports.regExSpellingGuardLine = /^.*\bc?spell(?:-?checker)?::?\s*disable-line\b.*/gim;
 exports.regExIgnoreSpellingDirectives = /\bc?spell(?:-?checker)?::?\s*ignoreRegExp.*/gim;

package/dist/Settings/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const configSettingsFileVersion0_1 = "0.1";
+export declare const configSettingsFileVersion0_2 = "0.2";
+export declare const currentSettingsFileVersion = "0.2";
+export declare const ENV_CSPELL_GLOB_ROOT = "CSPELL_GLOB_ROOT";
+//# sourceMappingURL=constants.d.ts.map

package/dist/Settings/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV_CSPELL_GLOB_ROOT = exports.currentSettingsFileVersion = exports.configSettingsFileVersion0_2 = exports.configSettingsFileVersion0_1 = void 0;
+exports.configSettingsFileVersion0_1 = '0.1';
+exports.configSettingsFileVersion0_2 = '0.2';
+exports.currentSettingsFileVersion = exports.configSettingsFileVersion0_2;
+exports.ENV_CSPELL_GLOB_ROOT = 'CSPELL_GLOB_ROOT';
+//# sourceMappingURL=constants.js.map

package/dist/Settings/index.d.ts

@@ -1,5 +1,6 @@
 export { clearCachedSettingsFiles, defaultConfigFilenames, defaultFileName, extractImportErrors, getCachedFileSize, getGlobalSettings, loadConfig, loadPnP, loadPnPSync, readRawSettings, readSettings, readSettingsFiles, searchForConfig, sectionCSpell, } from './Controller/configLoader';
-export { calcOverrideSettings, checkFilenameMatchesGlob, currentSettingsFileVersion, ENV_CSPELL_GLOB_ROOT, extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, } from './CSpellSettingsServer';
+export { calcOverrideSettings, checkFilenameMatchesGlob, extractDependencies, finalizeSettings, getSources, mergeInDocSettings, mergeSettings, } from './CSpellSettingsServer';
+export { currentSettingsFileVersion, ENV_CSPELL_GLOB_ROOT } from './constants';
 export type { ConfigurationDependencies, ImportFileRefWithError } from './CSpellSettingsServer';
 export { getDefaultSettings, getDefaultBundledSettings } from './DefaultSettings';
 export { ImportError } from './Controller/ImportError';

package/dist/Settings/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportError = exports.getDefaultBundledSettings = exports.getDefaultSettings = exports.mergeSettings = exports.mergeInDocSettings = exports.getSources = exports.finalizeSettings = exports.extractDependencies = exports.ENV_CSPELL_GLOB_ROOT = exports.currentSettingsFileVersion = exports.checkFilenameMatchesGlob = exports.calcOverrideSettings = exports.sectionCSpell = exports.searchForConfig = exports.readSettingsFiles = exports.readSettings = exports.readRawSettings = exports.loadPnPSync = exports.loadPnP = exports.loadConfig = exports.getGlobalSettings = exports.getCachedFileSize = exports.extractImportErrors = exports.defaultFileName = exports.defaultConfigFilenames = exports.clearCachedSettingsFiles = void 0;
+exports.ImportError = exports.getDefaultBundledSettings = exports.getDefaultSettings = exports.ENV_CSPELL_GLOB_ROOT = exports.currentSettingsFileVersion = exports.mergeSettings = exports.mergeInDocSettings = exports.getSources = exports.finalizeSettings = exports.extractDependencies = exports.checkFilenameMatchesGlob = exports.calcOverrideSettings = exports.sectionCSpell = exports.searchForConfig = exports.readSettingsFiles = exports.readSettings = exports.readRawSettings = exports.loadPnPSync = exports.loadPnP = exports.loadConfig = exports.getGlobalSettings = exports.getCachedFileSize = exports.extractImportErrors = exports.defaultFileName = exports.defaultConfigFilenames = exports.clearCachedSettingsFiles = void 0;
 var configLoader_1 = require("./Controller/configLoader");
 Object.defineProperty(exports, "clearCachedSettingsFiles", { enumerable: true, get: function () { return configLoader_1.clearCachedSettingsFiles; } });
 Object.defineProperty(exports, "defaultConfigFilenames", { enumerable: true, get: function () { return configLoader_1.defaultConfigFilenames; } });
@@ -19,13 +19,14 @@ Object.defineProperty(exports, "sectionCSpell", { enumerable: true, get: functio
 var CSpellSettingsServer_1 = require("./CSpellSettingsServer");
 Object.defineProperty(exports, "calcOverrideSettings", { enumerable: true, get: function () { return CSpellSettingsServer_1.calcOverrideSettings; } });
 Object.defineProperty(exports, "checkFilenameMatchesGlob", { enumerable: true, get: function () { return CSpellSettingsServer_1.checkFilenameMatchesGlob; } });
-Object.defineProperty(exports, "currentSettingsFileVersion", { enumerable: true, get: function () { return CSpellSettingsServer_1.currentSettingsFileVersion; } });
-Object.defineProperty(exports, "ENV_CSPELL_GLOB_ROOT", { enumerable: true, get: function () { return CSpellSettingsServer_1.ENV_CSPELL_GLOB_ROOT; } });
 Object.defineProperty(exports, "extractDependencies", { enumerable: true, get: function () { return CSpellSettingsServer_1.extractDependencies; } });
 Object.defineProperty(exports, "finalizeSettings", { enumerable: true, get: function () { return CSpellSettingsServer_1.finalizeSettings; } });
 Object.defineProperty(exports, "getSources", { enumerable: true, get: function () { return CSpellSettingsServer_1.getSources; } });
 Object.defineProperty(exports, "mergeInDocSettings", { enumerable: true, get: function () { return CSpellSettingsServer_1.mergeInDocSettings; } });
 Object.defineProperty(exports, "mergeSettings", { enumerable: true, get: function () { return CSpellSettingsServer_1.mergeSettings; } });
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "currentSettingsFileVersion", { enumerable: true, get: function () { return constants_1.currentSettingsFileVersion; } });
+Object.defineProperty(exports, "ENV_CSPELL_GLOB_ROOT", { enumerable: true, get: function () { return constants_1.ENV_CSPELL_GLOB_ROOT; } });
 var DefaultSettings_1 = require("./DefaultSettings");
 Object.defineProperty(exports, "getDefaultSettings", { enumerable: true, get: function () { return DefaultSettings_1.getDefaultSettings; } });
 Object.defineProperty(exports, "getDefaultBundledSettings", { enumerable: true, get: function () { return DefaultSettings_1.getDefaultBundledSettings; } });

package/dist/SpellingDictionary/SpellingDictionary.d.ts

@@ -48,10 +48,23 @@ export declare type HasOptions = SearchOptions;
 export interface SpellingDictionaryOptions {
     repMap?: ReplaceMap;
     useCompounds?: boolean;
+    /**
+     * The dictionary is case aware.
+     */
     caseSensitive?: boolean;
     noSuggest?: boolean;
     weightMap?: WeightMap | undefined;
     dictionaryInformation?: DictionaryInformation;
+    /**
+     * Strip Case and Accents to allow for case insensitive searches and
+     * words without accents.
+     *
+     * Note: this setting only applies to word lists. It has no-impact on trie
+     * dictionaries.
+     *
+     * @default true
+     */
+    supportNonStrictSearches?: boolean;
 }
 export interface SpellingDictionary {
     readonly name: string;

package/dist/SpellingDictionary/createSpellingDictionary.js

@@ -34,7 +34,8 @@ exports.createSpellingDictionary = createSpellingDictionary;
 function _createSpellingDictionary(params) {
     const [wordList, name, source, options] = params;
     // console.log(`createSpellingDictionary ${name} ${source}`);
-    const words = (0, cspell_trie_lib_1.parseDictionaryLines)(wordList);
+    const parseOptions = { stripCaseAndAccents: options?.supportNonStrictSearches ?? true };
+    const words = (0, cspell_trie_lib_1.parseDictionaryLines)(wordList, parseOptions);
     const trie = (0, cspell_trie_lib_1.buildTrieFast)(words);
     const opts = { ...(options || defaultOptions) };
     if (opts.weightMap === undefined && opts.dictionaryInformation) {

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export type { CreateTextDocumentParams, TextDocument, TextDocumentLine } from '.
 export * from './Settings';
 export { defaultFileName as defaultSettingsFilename } from './Settings';
 export { combineTextAndLanguageSettings, combineTextAndLanguageSettings as constructSettingsForText, } from './Settings/TextDocumentSettings';
-export { determineFinalDocumentSettings, DetermineFinalDocumentSettingsResult, Document, fileToDocument, isBinaryFile, spellCheckDocument, spellCheckFile, SpellCheckFileOptions, SpellCheckFileResult, } from './spellCheckFile';
+export { determineFinalDocumentSettings, DetermineFinalDocumentSettingsResult, Document, fileToDocument, fileToTextDocument, isBinaryFile, spellCheckDocument, spellCheckFile, SpellCheckFileOptions, SpellCheckFileResult, } from './spellCheckFile';
 export { CompoundWordsMethod, createSpellingDictionary, isSpellingDictionaryLoadError, refreshDictionaryCache, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryLoadError, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary';
 export { SuggestionError, suggestionsForWord, suggestionsForWords } from './suggestions';
 export type { SuggestedWord, SuggestionOptions, SuggestionsForWordResult } from './suggestions';
@@ -21,7 +21,7 @@ export { traceWords, traceWordsAsync } from './trace';
 export type { TraceOptions, TraceResult } from './trace';
 export { getLogger, Logger, setLogger } from './util/logger';
 export { resolveFile } from './util/resolveFile';
-export { checkText, CheckTextInfo, IncludeExcludeFlag, IncludeExcludeOptions, TextInfoItem, validateText, ValidationIssue, } from './validator';
+export { checkText, checkTextDocument, CheckTextInfo, IncludeExcludeFlag, IncludeExcludeOptions, TextInfoItem, validateText, ValidationIssue, } from './validator';
 export { Text, Link };
 export { ExclusionHelper };
 export declare function clearCachedFiles(): Promise<void>;

package/dist/index.js

@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.traceWordsAsync = exports.traceWords = exports.DocumentValidator = exports.suggestionsForWords = exports.suggestionsForWord = exports.SuggestionError = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.updateTextDocument = exports.createTextDocument = exports.getLanguagesForExt = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = exports.asyncIterableToArray = void 0;
+exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkTextDocument = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.traceWordsAsync = exports.traceWords = exports.DocumentValidator = exports.suggestionsForWords = exports.suggestionsForWord = exports.SuggestionError = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToTextDocument = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.updateTextDocument = exports.createTextDocument = exports.getLanguagesForExt = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = exports.asyncIterableToArray = void 0;
 const ExclusionHelper = __importStar(require("./exclusionHelper"));
 exports.ExclusionHelper = ExclusionHelper;
 const Settings_1 = require("./Settings");
@@ -58,6 +58,7 @@ Object.defineProperty(exports, "constructSettingsForText", { enumerable: true, g
 var spellCheckFile_1 = require("./spellCheckFile");
 Object.defineProperty(exports, "determineFinalDocumentSettings", { enumerable: true, get: function () { return spellCheckFile_1.determineFinalDocumentSettings; } });
 Object.defineProperty(exports, "fileToDocument", { enumerable: true, get: function () { return spellCheckFile_1.fileToDocument; } });
+Object.defineProperty(exports, "fileToTextDocument", { enumerable: true, get: function () { return spellCheckFile_1.fileToTextDocument; } });
 Object.defineProperty(exports, "isBinaryFile", { enumerable: true, get: function () { return spellCheckFile_1.isBinaryFile; } });
 Object.defineProperty(exports, "spellCheckDocument", { enumerable: true, get: function () { return spellCheckFile_1.spellCheckDocument; } });
 Object.defineProperty(exports, "spellCheckFile", { enumerable: true, get: function () { return spellCheckFile_1.spellCheckFile; } });
@@ -84,6 +85,7 @@ var resolveFile_1 = require("./util/resolveFile");
 Object.defineProperty(exports, "resolveFile", { enumerable: true, get: function () { return resolveFile_1.resolveFile; } });
 var validator_1 = require("./validator");
 Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return validator_1.checkText; } });
+Object.defineProperty(exports, "checkTextDocument", { enumerable: true, get: function () { return validator_1.checkTextDocument; } });
 Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return validator_1.IncludeExcludeFlag; } });
 Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return validator_1.validateText; } });
 async function clearCachedFiles() {

package/dist/spellCheckFile.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { CSpellSettingsWithSourceTrace, CSpellUserSettings } from '@cspell/cspell-types';
 import { URI } from 'vscode-uri';
+import { TextDocument } from './Models/TextDocument';
 import { ValidateTextOptions, ValidationIssue } from './validator';
 export interface SpellCheckFileOptions extends ValidateTextOptions {
     /**
@@ -78,4 +79,6 @@ export declare function isBinaryFile(filenameUri: URI, languageId?: string | str
 export declare function fileToDocument(file: string): Document;
 export declare function fileToDocument(file: string, text: string, languageId?: string, locale?: string): DocumentWithText;
 export declare function fileToDocument(file: string, text?: string, languageId?: string, locale?: string): Document | DocumentWithText;
+export declare function fileToTextDocument(file: string): Promise<TextDocument>;
+export declare function resolveDocumentToTextDocument(doc: Document): Promise<TextDocument>;
 //# sourceMappingURL=spellCheckFile.d.ts.map

package/dist/spellCheckFile.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileToDocument = exports.isBinaryFile = exports.isBinaryDoc = exports.determineFinalDocumentSettings = exports.spellCheckDocument = exports.spellCheckFile = void 0;
+exports.resolveDocumentToTextDocument = exports.fileToTextDocument = exports.fileToDocument = exports.isBinaryFile = exports.isBinaryDoc = exports.determineFinalDocumentSettings = exports.spellCheckDocument = exports.spellCheckFile = void 0;
 const fs_extra_1 = require("fs-extra");
 const vscode_uri_1 = require("vscode-uri");
 const LanguageIds_1 = require("./LanguageIds");
@@ -59,8 +59,7 @@ async function spellCheckDocument(document, options, settings) {
 }
 exports.spellCheckDocument = spellCheckDocument;
 async function spellCheckFullDocument(document, options, settings) {
-    const { uri, text: content, languageId, locale } = document;
-    const doc = (0, TextDocument_1.createTextDocument)({ uri, content, languageId, locale });
+    const doc = documentToTextDocument(document);
     const docValOptions = options;
     const docValidator = new textValidation_1.DocumentValidator(doc, docValOptions, settings);
     await docValidator.prepare();
@@ -159,4 +158,16 @@ function fileToDocument(file, text, languageId, locale) {
     });
 }
 exports.fileToDocument = fileToDocument;
+async function fileToTextDocument(file) {
+    return documentToTextDocument(await resolveDocument(fileToDocument(file)));
+}
+exports.fileToTextDocument = fileToTextDocument;
+function documentToTextDocument(document) {
+    const { uri, text: content, languageId, locale } = document;
+    return (0, TextDocument_1.createTextDocument)({ uri, content, languageId, locale });
+}
+async function resolveDocumentToTextDocument(doc) {
+    return documentToTextDocument(await resolveDocument(doc));
+}
+exports.resolveDocumentToTextDocument = resolveDocumentToTextDocument;
 //# sourceMappingURL=spellCheckFile.js.map

package/dist/textValidation/ValidationTypes.d.ts

@@ -1,4 +1,4 @@
-import { MappedText, TextOffset as TextOffsetRW } from '@cspell/cspell-types';
+import { MappedText, TextOffset as TextOffsetRW, Issue } from '@cspell/cspell-types';
 export declare type TextOffsetRO = Readonly<TextOffsetRW>;
 export interface ValidationOptions extends IncludeExcludeOptions {
     maxNumberOfProblems?: number;
@@ -22,7 +22,7 @@ export interface WordRangeAcc {
     isIncluded: boolean;
     rangePos: number;
 }
-export interface ValidationResult extends TextOffsetRW {
+export interface ValidationResult extends TextOffsetRW, Pick<Issue, 'message' | 'issueType'> {
     line: TextOffsetRW;
     isFlagged?: boolean | undefined;
     isFound?: boolean | undefined;