cspell-lib 6.7.0 → 6.8.0

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,57 @@ 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',
+    'includeRegExp',
+    'ignoreRegExp',
+    'locale',
+    'language',
+    'dictionaries',
+    'enableCompoundWords',
+    'enableAllowCompoundWords',
+    'disableCompoundWords',
+    'disableAllowCompoundWords',
+    'enableCaseSensitive',
+    'disableCaseSensitive',
+];
+const preferredDirectives = [
+    'enable',
+    'disable',
+    'disable-line',
+    'disable-next-line',
+    'words',
+    'ignore',
+    'locale',
+    '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 +86,62 @@ 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?\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, ' '))],
+];
+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);
+    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)
@@ -113,6 +197,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/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;

package/dist/textValidation/checkText.d.ts

@@ -0,0 +1,47 @@
+import { CSpellUserSettings } from '@cspell/cspell-types';
+import { TextDocument } from '../Models/TextDocument';
+import { Document } from '../spellCheckFile';
+import { DocumentValidator, DocumentValidatorOptions } from './docValidator';
+/**
+ * Annotate text with issues and include / exclude zones.
+ * @param text - the text to annotate.
+ * @param settings - the settings to use.
+ * @returns the Check Text result
+ * @deprecated
+ */
+export declare function checkText(text: string, settings: CSpellUserSettings): Promise<CheckTextInfo>;
+/**
+ * Annotate text with issues and include / exclude zones.
+ * @param text - the text to annotate.
+ * @param settings - the settings to use.
+ * @returns the Check Text result
+ * @deprecated
+ */
+export declare function checkTextOld(text: string, settings: CSpellUserSettings): Promise<CheckTextInfo>;
+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 interface CheckTextOptions extends DocumentValidatorOptions {
+}
+/**
+ * Calculate document issues and include / exclude zones.
+ * @param doc - document to check
+ * @param options - check options
+ * @param settings - optional settings
+ * @returns
+ */
+export declare function checkTextDocument(doc: TextDocument | Document, options: CheckTextOptions, settings?: CSpellUserSettings): Promise<CheckTextInfo>;
+export declare function genCheckText(docValidator: DocumentValidator): Promise<CheckTextInfo>;
+//# sourceMappingURL=checkText.d.ts.map

package/dist/textValidation/checkText.js

@@ -0,0 +1,152 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genCheckText = exports.checkTextDocument = exports.IncludeExcludeFlag = exports.checkTextOld = exports.checkText = void 0;
+const assert_1 = __importDefault(require("assert"));
+const TextDocument_1 = require("../Models/TextDocument");
+const Settings = __importStar(require("../Settings"));
+const spellCheckFile_1 = require("../spellCheckFile");
+const util_1 = require("../util/util");
+const docValidator_1 = require("./docValidator");
+const textValidator_1 = require("./textValidator");
+const validator_1 = require("./validator");
+/**
+ * Annotate text with issues and include / exclude zones.
+ * @param text - the text to annotate.
+ * @param settings - the settings to use.
+ * @returns the Check Text result
+ * @deprecated
+ */
+async function checkText(text, settings) {
+    const doc = (0, util_1.clean)({
+        uri: '',
+        text,
+        languageId: settings.languageId || 'plaintext',
+        locale: settings.language,
+    });
+    return checkTextDocument(doc, { noConfigSearch: true }, { loadDefaultConfiguration: false, ...settings });
+}
+exports.checkText = checkText;
+/**
+ * Annotate text with issues and include / exclude zones.
+ * @param text - the text to annotate.
+ * @param settings - the settings to use.
+ * @returns the Check Text result
+ * @deprecated
+ */
+async function checkTextOld(text, settings) {
+    const validationResult = (0, validator_1.validateText)(text, settings);
+    const finalSettings = Settings.finalizeSettings(settings);
+    const includeRanges = (0, textValidator_1.calcTextInclusionRanges)(text, finalSettings);
+    const issues = await validationResult;
+    return genResult(text, issues, includeRanges);
+}
+exports.checkTextOld = checkTextOld;
+var IncludeExcludeFlag;
+(function (IncludeExcludeFlag) {
+    IncludeExcludeFlag["INCLUDE"] = "I";
+    IncludeExcludeFlag["EXCLUDE"] = "E";
+})(IncludeExcludeFlag = exports.IncludeExcludeFlag || (exports.IncludeExcludeFlag = {}));
+/**
+ * Calculate document issues and include / exclude zones.
+ * @param doc - document to check
+ * @param options - check options
+ * @param settings - optional settings
+ * @returns
+ */
+async function checkTextDocument(doc, options, settings = {}) {
+    doc = (0, TextDocument_1.isTextDocument)(doc) ? doc : await (0, spellCheckFile_1.resolveDocumentToTextDocument)(doc);
+    return genCheckText(new docValidator_1.DocumentValidator(doc, options, settings));
+}
+exports.checkTextDocument = checkTextDocument;
+async function genCheckText(docValidator) {
+    await docValidator.prepare();
+    const issues = docValidator.checkDocument(true);
+    const preparations = docValidator._getPreparations();
+    (0, assert_1.default)(preparations);
+    return genResult(docValidator.document.text, issues, preparations.includeRanges);
+}
+exports.genCheckText = genCheckText;
+function genResult(text, issues, includeRanges) {
+    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,
+    });
+    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),
+    };
+}
+//# sourceMappingURL=checkText.js.map

package/dist/textValidation/docValidator.d.ts

@@ -1,4 +1,4 @@
-import type { CSpellUserSettings, MappedText, ParsedText } from '@cspell/cspell-types';
+import { CSpellUserSettings, MappedText, ParsedText } from '@cspell/cspell-types';
 import { CSpellSettingsInternal, CSpellSettingsInternalFinalized } from '../Models/CSpellSettingsInternalDef';
 import { TextDocument } from '../Models/TextDocument';
 import { SpellingDictionaryCollection } from '../SpellingDictionary';
@@ -47,9 +47,24 @@ export declare class DocumentValidator {
      * The amount of time in ms to prepare for validation.
      */
     get prepTime(): number;
+    get validateDirectives(): boolean;
     checkText(range: SimpleRange, _text: string, scope: string[]): ValidationIssue[];
     check(parsedText: ParsedText): ValidationIssue[];
+    /**
+     * Check a Document for Validation Issues.
+     * @param forceCheck - force a check even if the document would normally be excluded.
+     * @returns the validation issues.
+     */
+    checkDocumentAsync(forceCheck?: boolean): Promise<ValidationIssue[]>;
+    /**
+     * Check a Document for Validation Issues.
+     *
+     * Note: The validator must be prepared before calling this method.
+     * @param forceCheck - force a check even if the document would normally be excluded.
+     * @returns the validation issues.
+     */
     checkDocument(forceCheck?: boolean): ValidationIssue[];
+    checkDocumentDirectives(forceCheck?: boolean): ValidationIssue[];
     get document(): TextDocument;
     updateDocumentText(text: string): void;
     private defaultParser;

package/dist/textValidation/docValidator.js

@@ -5,11 +5,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 cspell_types_1 = require("@cspell/cspell-types");
 const assert_1 = __importDefault(require("assert"));
 const cspell_glob_1 = require("cspell-glob");
 const TextDocument_1 = require("../Models/TextDocument");
 const Settings_1 = require("../Settings");
 const configLoader_1 = require("../Settings/Controller/configLoader");
+const InDocSettings_1 = require("../Settings/InDocSettings");
 const SpellingDictionary_1 = require("../SpellingDictionary");
 const errors_1 = require("../util/errors");
 const Memorizer_1 = require("../util/Memorizer");
@@ -162,6 +164,9 @@ class DocumentValidator {
     get prepTime() {
         return this._preparationTime;
     }
+    get validateDirectives() {
+        return this.options.validateDirectives ?? this._preparations?.config.validateDirectives ?? false;
+    }
     checkText(range, _text, scope) {
         const text = this._document.text.slice(range[0], range[1]);
         return this.check({ text, range, scope: scope.join(' ') });
@@ -197,10 +202,47 @@ class DocumentValidator {
         });
         return withSugs;
     }
+    /**
+     * Check a Document for Validation Issues.
+     * @param forceCheck - force a check even if the document would normally be excluded.
+     * @returns the validation issues.
+     */
+    async checkDocumentAsync(forceCheck) {
+        await this.prepare();
+        return this.checkDocument(forceCheck);
+    }
+    /**
+     * Check a Document for Validation Issues.
+     *
+     * Note: The validator must be prepared before calling this method.
+     * @param forceCheck - force a check even if the document would normally be excluded.
+     * @returns the validation issues.
+     */
     checkDocument(forceCheck = false) {
         (0, assert_1.default)(this._ready);
         (0, assert_1.default)(this._preparations, ERROR_NOT_PREPARED);
-        return forceCheck || this.shouldCheckDocument() ? [...this._checkParsedText(this._parse())] : [];
+        const spellingIssues = forceCheck || this.shouldCheckDocument() ? [...this._checkParsedText(this._parse())] : [];
+        const directiveIssues = this.checkDocumentDirectives();
+        const allIssues = spellingIssues.concat(directiveIssues).sort((a, b) => a.offset - b.offset);
+        return allIssues;
+    }
+    checkDocumentDirectives(forceCheck = false) {
+        (0, assert_1.default)(this._ready);
+        (0, assert_1.default)(this._preparations, ERROR_NOT_PREPARED);
+        const validateDirectives = forceCheck || this.validateDirectives;
+        if (!validateDirectives)
+            return [];
+        const document = this.document;
+        const issueType = cspell_types_1.IssueType.directive;
+        function toValidationIssue(dirIssue) {
+            const { text, range, suggestions, message } = dirIssue;
+            const offset = range[0];
+            const pos = document.positionAt(offset);
+            const line = document.getLine(pos.line);
+            const issue = { text, offset, line, suggestions, message, issueType };
+            return issue;
+        }
+        return [...(0, InDocSettings_1.validateInDocumentSettings)(this.document.text, this._preparations.config)].map(toValidationIssue);
     }
     get document() {
         return this._document;

package/dist/textValidation/index.d.ts

@@ -1,8 +1,10 @@
-export { calcTextInclusionRanges } from './textValidator';
-export type { CheckOptions, IncludeExcludeOptions, ValidationOptions, ValidationResult } from './ValidationTypes';
-export { checkText, IncludeExcludeFlag, validateText } from './validator';
-export type { CheckTextInfo, TextInfoItem, ValidateTextOptions, ValidationIssue } from './validator';
+export { checkText, checkTextDocument, IncludeExcludeFlag } from './checkText';
+export type { CheckTextInfo, TextInfoItem } from './checkText';
 export { DocumentValidator } from './docValidator';
 export type { DocumentValidatorOptions } from './docValidator';
 export type { Offset, SimpleRange } from './parsedText';
+export { calcTextInclusionRanges } from './textValidator';
+export type { CheckOptions, IncludeExcludeOptions, ValidationOptions, ValidationResult } from './ValidationTypes';
+export { validateText } from './validator';
+export type { ValidateTextOptions, ValidationIssue } from './validator';
 //# sourceMappingURL=index.d.ts.map

package/dist/textValidation/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentValidator = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.calcTextInclusionRanges = void 0;
+exports.validateText = exports.calcTextInclusionRanges = exports.DocumentValidator = exports.IncludeExcludeFlag = exports.checkTextDocument = exports.checkText = void 0;
+var checkText_1 = require("./checkText");
+Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return checkText_1.checkText; } });
+Object.defineProperty(exports, "checkTextDocument", { enumerable: true, get: function () { return checkText_1.checkTextDocument; } });
+Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return checkText_1.IncludeExcludeFlag; } });
+var docValidator_1 = require("./docValidator");
+Object.defineProperty(exports, "DocumentValidator", { enumerable: true, get: function () { return docValidator_1.DocumentValidator; } });
 var textValidator_1 = require("./textValidator");
 Object.defineProperty(exports, "calcTextInclusionRanges", { enumerable: true, get: function () { return textValidator_1.calcTextInclusionRanges; } });
 var validator_1 = require("./validator");
-Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return validator_1.checkText; } });
-Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return validator_1.IncludeExcludeFlag; } });
 Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return validator_1.validateText; } });
-var docValidator_1 = require("./docValidator");
-Object.defineProperty(exports, "DocumentValidator", { enumerable: true, get: function () { return docValidator_1.DocumentValidator; } });
 //# sourceMappingURL=index.js.map

package/dist/textValidation/validator.d.ts

@@ -1,4 +1,4 @@
-import type { CSpellUserSettings } from '@cspell/cspell-types';
+import { CSpellUserSettings } from '@cspell/cspell-types';
 import { CSpellSettingsInternalFinalized } from '../Models/CSpellSettingsInternalDef';
 import type { ValidationOptions, ValidationResult } from './ValidationTypes';
 export declare const diagSource = "cSpell Checker";
@@ -6,10 +6,18 @@ export interface ValidationIssue extends ValidationResult {
     suggestions?: string[];
 }
 export interface ValidateTextOptions {
-    /** Generate suggestions where there are spelling issues. */
+    /**
+     * Generate suggestions where there are spelling issues.
+     */
     generateSuggestions?: boolean;
-    /** The number of suggestions to generate. The higher the number the longer it takes. */
+    /**
+     * The number of suggestions to generate. The higher the number the longer it takes.
+     */
     numSuggestions?: number;
+    /**
+     * Verify that the in-document directives are correct.
+     */
+    validateDirectives?: boolean;
 }
 /**
  * @deprecated
@@ -17,20 +25,4 @@ export interface ValidateTextOptions {
  */
 export declare function validateText(text: string, settings: CSpellUserSettings, options?: ValidateTextOptions): Promise<ValidationIssue[]>;
 export declare function settingsToValidateOptions(settings: CSpellSettingsInternalFinalized): 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>;
 //# sourceMappingURL=validator.d.ts.map

package/dist/textValidation/validator.js

@@ -23,8 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkText = exports.IncludeExcludeFlag = exports.settingsToValidateOptions = exports.validateText = exports.diagSource = void 0;
+exports.settingsToValidateOptions = exports.validateText = exports.diagSource = void 0;
+const cspell_types_1 = require("@cspell/cspell-types");
+const TextDocument_1 = require("../Models/TextDocument");
 const Settings = __importStar(require("../Settings"));
+const InDocSettings_1 = require("../Settings/InDocSettings");
 const SpellingDictionary_1 = require("../SpellingDictionary");
 const Memorizer_1 = require("../util/Memorizer");
 const util_1 = require("../util/util");
@@ -37,7 +40,11 @@ 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 = [...(0, textValidator_1.validateText)(text, dict, settingsToValidateOptions(finalSettings))];
+    const spellingIssues = [...(0, textValidator_1.validateText)(text, dict, settingsToValidateOptions(finalSettings))];
+    const validationIssues = options.validateDirectives || finalSettings.validateDirectives
+        ? (0, InDocSettings_1.validateInDocumentSettings)(text, settings)
+        : [];
+    const issues = spellingIssues.concat(mapValidationIssues(text, validationIssues));
     if (!options.generateSuggestions) {
         return issues;
     }
@@ -58,6 +65,22 @@ async function validateText(text, settings, options = {}) {
     return withSugs;
 }
 exports.validateText = validateText;
+function mapValidationIssues(text, valIssues) {
+    const issues = [...valIssues];
+    if (!issues.length)
+        return [];
+    const document = (0, TextDocument_1.createTextDocument)({ uri: '', content: text });
+    const issueType = cspell_types_1.IssueType.directive;
+    function toValidationIssue(dirIssue) {
+        const { text, range, suggestions, message } = dirIssue;
+        const offset = range[0];
+        const pos = document.positionAt(offset);
+        const line = document.getLine(pos.line);
+        const issue = { text, offset, line, suggestions, message, issueType };
+        return issue;
+    }
+    return issues.map(toValidationIssue);
+}
 function settingsToValidateOptions(settings) {
     const opt = {
         ...settings,
@@ -66,71 +89,4 @@ function settingsToValidateOptions(settings) {
     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 = (0, textValidator_1.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;
 //# sourceMappingURL=validator.js.map

package/dist/validator.d.ts

@@ -1,3 +1,3 @@
-export { checkText, IncludeExcludeFlag, validateText } from './textValidation';
+export { checkText, checkTextDocument, IncludeExcludeFlag, validateText } from './textValidation';
 export type { CheckTextInfo, IncludeExcludeOptions, TextInfoItem, ValidateTextOptions, ValidationIssue, } from './textValidation';
 //# sourceMappingURL=validator.d.ts.map

package/dist/validator.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateText = exports.IncludeExcludeFlag = exports.checkText = void 0;
+exports.validateText = exports.IncludeExcludeFlag = exports.checkTextDocument = exports.checkText = void 0;
 var textValidation_1 = require("./textValidation");
 Object.defineProperty(exports, "checkText", { enumerable: true, get: function () { return textValidation_1.checkText; } });
+Object.defineProperty(exports, "checkTextDocument", { enumerable: true, get: function () { return textValidation_1.checkTextDocument; } });
 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -48,17 +48,17 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "^6.7.0",
-    "@cspell/cspell-pipe": "^6.7.0",
-    "@cspell/cspell-types": "^6.7.0",
+    "@cspell/cspell-bundled-dicts": "^6.8.0",
+    "@cspell/cspell-pipe": "^6.8.0",
+    "@cspell/cspell-types": "^6.8.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
     "configstore": "^5.0.1",
     "cosmiconfig": "^7.0.1",
-    "cspell-glob": "^6.7.0",
-    "cspell-grammar": "^6.7.0",
-    "cspell-io": "^6.7.0",
-    "cspell-trie-lib": "^6.7.0",
+    "cspell-glob": "^6.8.0",
+    "cspell-grammar": "^6.8.0",
+    "cspell-io": "^6.8.0",
+    "cspell-trie-lib": "^6.8.0",
     "fast-equals": "^4.0.1",
     "find-up": "^5.0.0",
     "fs-extra": "^10.1.0",
@@ -77,21 +77,21 @@
     "@cspell/dict-csharp": "^3.0.1",
     "@cspell/dict-css": "^1.0.13",
     "@cspell/dict-fa-ir": "^2.0.0",
-    "@cspell/dict-fr-fr": "^2.1.0",
+    "@cspell/dict-fr-fr": "^2.1.1",
     "@cspell/dict-html": "^1.1.9",
-    "@cspell/dict-nl-nl": "^2.2.5",
+    "@cspell/dict-nl-nl": "^2.2.6",
     "@cspell/dict-python": "^2.0.6",
     "@types/configstore": "^5.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^28.1.7",
-    "@types/node": "^18.7.6",
+    "@types/node": "^18.7.8",
     "cspell-dict-nl-nl": "^1.1.2",
     "jest": "^28.1.3",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2",
-    "rollup": "^2.78.0",
+    "rollup": "^2.78.1",
     "rollup-plugin-dts": "^4.2.2",
     "ts-jest": "^28.0.8"
   },
-  "gitHead": "3a7312a15d2df1507d9e01863ec5842f5a99e0cc"
+  "gitHead": "8a1bd03222ffc9776c2cdd09180db6150abb3f25"
 }