@cspell/cspell-types 10.4.0 → 10.4.1

package/README.md

@@ -12,7 +12,7 @@ If our spell checkers save you time, please consider supporting their developmen
 
 Please show your support through one of the following sites:
 
-[![GitHub Sponsor](https://cspell.org/img/sponsor/github-sponsor-176px.png)](https://github.com/sponsors/streetsidesoftware) [![PayPal](https://cspell.org/img/sponsor/paypal-176px.png)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) [![Open Collective](https://cspell.org/img/sponsor/open-collective-176px.png)](https://opencollective.com/cspell) [![CSpell](https://cspell.org/img/sponsor/cspell-176px.png)](https://streetsidesoftware.com/sponsor/)
+[![GitHub Sponsor](https://cspell.org/img/sponsor/github-sponsor-176px.png)](https://github.com/sponsors/streetsidesoftware) [![PayPal](https://cspell.org/img/sponsor/paypal-176px.png)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) [![Open Collective](https://cspell.org/img/sponsor/open-collective-176px.png)](https://opencollective.com/cspell) [![CSpell](https://cspell.org/img/sponsor/cspell-176px.png)](https://streetsidesoftware.com/sponsor/)
 
 <!--- @@inject-end: ../../static/sponsor.md --->
 

package/cspell.schema.json

@@ -1985,8 +1985,8 @@
       "type": "object"
     },
     "SoftWordBreakPattern": {
-      "description": "Defines a word break rule based on a string.\n\nFormat:\n- `\"before|after\"` -- Matches a word break between `before` and `after`\n- `\"before|after$\"` -- Matches a word break between `before` and `after` at the end of a word\n- `\"^before|after\"` -- Matches a word break between `before` at the start of a word and `after`\n- `\"^before|after$\"` -- Matches a word break between `before` at the start of a word and `after` at the end of a word\n- `\"before|\"` -- Matches a word break after `before`\n- `\"^before|\"` -- Matches a word break after `before` at the start of a word\n- `\"|after\"` -- Matches a word break before `after`\n- `\"|after$\"` -- Matches a word break before `after` at the end of a word\n\n\nWhere `before` is the text before the word break and `after` is the text after the word break.\n\nSpecial characters like `|`, `^`, and `$` have specific meanings.\n- `|` -- Represents the position of the word break\n- `^` -- Indicates the start of a word\n- `$` -- Indicates the end of a word\n\nFor more complicated word break rules, consider using regular expressions with the  {@link  SoftWordBreakRegExp }  type.\n\nExamples:\n- `\"^ptr|\"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.\n- `\"^I|\"` -- Would help with interface definitions starting with `I`, such as `IERROR`.",
-      "markdownDescription": "Defines a word break rule based on a string.\n\nFormat:\n- `\"before|after\"` -- Matches a word break between `before` and `after`\n- `\"before|after$\"` -- Matches a word break between `before` and `after` at the end of a word\n- `\"^before|after\"` -- Matches a word break between `before` at the start of a word and `after`\n- `\"^before|after$\"` -- Matches a word break between `before` at the start of a word and `after` at the end of a word\n- `\"before|\"` -- Matches a word break after `before`\n- `\"^before|\"` -- Matches a word break after `before` at the start of a word\n- `\"|after\"` -- Matches a word break before `after`\n- `\"|after$\"` -- Matches a word break before `after` at the end of a word\n\n\nWhere `before` is the text before the word break and `after` is the text after the word break.\n\nSpecial characters like `|`, `^`, and `$` have specific meanings.\n- `|` -- Represents the position of the word break\n- `^` -- Indicates the start of a word\n- `$` -- Indicates the end of a word\n\nFor more complicated word break rules, consider using regular expressions with the  {@link  SoftWordBreakRegExp }  type.\n\nExamples:\n- `\"^ptr|\"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.\n- `\"^I|\"` -- Would help with interface definitions starting with `I`, such as `IERROR`.",
+      "description": "Defines a word break rule based on a string.\n\nFormat:\n- `\"before|after\"` -- Matches a word break between `before` and `after`\n- `\"before|after$\"` -- Matches a word break between `before` and `after` at the end of a word\n- `\"^before|after\"` -- Matches a word break between `before` at the start of a word and `after`\n- `\"^before|after$\"` -- Matches a word break between `before` at the start of a word and `after` at the end of a word\n- `\"before|\"` -- Matches a word break after `before`\n- `\"^before|\"` -- Matches a word break after `before` at the start of a word\n- `\"|after\"` -- Matches a word break before `after`\n- `\"|after$\"` -- Matches a word break before `after` at the end of a word\n\n\nWhere `before` is the text before the word break and `after` is the text after the word break.\n\nSpecial characters like `|`, `^`, and `$` have specific meanings.\n- `|` -- Represents the position of the word break\n- `^` -- Indicates the start of a word\n- `$` -- Indicates the end of a word\n\nExamples:\n- `\"^ptr|\"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.\n- `\"^I|\"` -- Would help with interface definitions starting with `I`, such as `IERROR`.",
+      "markdownDescription": "Defines a word break rule based on a string.\n\nFormat:\n- `\"before|after\"` -- Matches a word break between `before` and `after`\n- `\"before|after$\"` -- Matches a word break between `before` and `after` at the end of a word\n- `\"^before|after\"` -- Matches a word break between `before` at the start of a word and `after`\n- `\"^before|after$\"` -- Matches a word break between `before` at the start of a word and `after` at the end of a word\n- `\"before|\"` -- Matches a word break after `before`\n- `\"^before|\"` -- Matches a word break after `before` at the start of a word\n- `\"|after\"` -- Matches a word break before `after`\n- `\"|after$\"` -- Matches a word break before `after` at the end of a word\n\n\nWhere `before` is the text before the word break and `after` is the text after the word break.\n\nSpecial characters like `|`, `^`, and `$` have specific meanings.\n- `|` -- Represents the position of the word break\n- `^` -- Indicates the start of a word\n- `$` -- Indicates the end of a word\n\nExamples:\n- `\"^ptr|\"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.\n- `\"^I|\"` -- Would help with interface definitions starting with `I`, such as `IERROR`.",
       "since": "10.3.1",
       "type": "string"
     },

package/dist/Parser/index.d.mts

@@ -1,2 +1,2 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-eOBgsj8d.mjs";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-BVAK5kk5.mjs";
 export type { DelegateInfo, DocumentParser, MappedText, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap, TextDocument, TextDocumentFragment };

package/dist/Parser/index.d.ts

@@ -1,2 +1,2 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-eOBgsj8d.js";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-BVAK5kk5.js";
 export type { DelegateInfo, DocumentParser, MappedText, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap, TextDocument, TextDocumentFragment };

package/dist/{index-eOBgsj8d.d.ts → index-BVAK5kk5.d.mts}

@@ -1,4 +1,3 @@
-//#region src/Parser/types.d.ts
 /**
  * A SourceMap is used to map or transform the location of a piece of text back to its original offsets.
  * This is necessary in order to report the correct location of a spelling issue.
@@ -51,7 +50,7 @@ type SourceMap = number[];
 type Range = readonly [start: number, end: number];
 /**
  * Interface used to pass documents to the parser.
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface TextDocument {
   /**
@@ -67,7 +66,7 @@ interface TextDocument {
 }
 /**
  * A fragment of a text document, representing a subset of the full document.
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface TextDocumentFragment extends TextDocument {
   /**
@@ -83,8 +82,6 @@ interface TextDocumentFragment extends TextDocument {
    */
   readonly fullText?: string;
 }
-//#endregion
-//#region src/Parser/Mapped.d.ts
 interface Mapped {
   /**
    * The absolute start and end offset of the text in the source.
@@ -105,8 +102,6 @@ interface Mapped {
    */
   map?: SourceMap | undefined;
 }
-//#endregion
-//#region src/Parser/parser.d.ts
 type ParserOptions = Record<string, unknown>;
 type ParserName = string;
 interface Parser {
@@ -237,8 +232,6 @@ type ParsedTag = boolean | undefined;
 interface ParsedTags {
   readonly [tag: string]: ParsedTag;
 }
-//#endregion
-//#region src/Parser/TextMap.d.ts
 type MappedText = Readonly<TransformedText>;
 interface TransformedText extends Mapped {
   /**
@@ -250,6 +243,5 @@ interface TransformedText extends Mapped {
    */
   rawText?: string | undefined;
 }
-//#endregion
 export { TextDocumentFragment as _, ParsedTag as a, Parser as c, Scope as d, ScopeChain as f, TextDocument as g, SourceMap as h, ParseResult as i, ParserName as l, Range as m, DelegateInfo as n, ParsedTags as o, ScopeString as p, DocumentParser as r, ParsedText as s, MappedText as t, ParserOptions as u };
-//# sourceMappingURL=index-eOBgsj8d.d.ts.map
+//# sourceMappingURL=index-BVAK5kk5.d.mts.map

package/dist/{index-eOBgsj8d.d.mts → index-BVAK5kk5.d.ts}

@@ -1,4 +1,3 @@
-//#region src/Parser/types.d.ts
 /**
  * A SourceMap is used to map or transform the location of a piece of text back to its original offsets.
  * This is necessary in order to report the correct location of a spelling issue.
@@ -51,7 +50,7 @@ type SourceMap = number[];
 type Range = readonly [start: number, end: number];
 /**
  * Interface used to pass documents to the parser.
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface TextDocument {
   /**
@@ -67,7 +66,7 @@ interface TextDocument {
 }
 /**
  * A fragment of a text document, representing a subset of the full document.
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface TextDocumentFragment extends TextDocument {
   /**
@@ -83,8 +82,6 @@ interface TextDocumentFragment extends TextDocument {
    */
   readonly fullText?: string;
 }
-//#endregion
-//#region src/Parser/Mapped.d.ts
 interface Mapped {
   /**
    * The absolute start and end offset of the text in the source.
@@ -105,8 +102,6 @@ interface Mapped {
    */
   map?: SourceMap | undefined;
 }
-//#endregion
-//#region src/Parser/parser.d.ts
 type ParserOptions = Record<string, unknown>;
 type ParserName = string;
 interface Parser {
@@ -237,8 +232,6 @@ type ParsedTag = boolean | undefined;
 interface ParsedTags {
   readonly [tag: string]: ParsedTag;
 }
-//#endregion
-//#region src/Parser/TextMap.d.ts
 type MappedText = Readonly<TransformedText>;
 interface TransformedText extends Mapped {
   /**
@@ -250,6 +243,5 @@ interface TransformedText extends Mapped {
    */
   rawText?: string | undefined;
 }
-//#endregion
 export { TextDocumentFragment as _, ParsedTag as a, Parser as c, Scope as d, ScopeChain as f, TextDocument as g, SourceMap as h, ParseResult as i, ParserName as l, Range as m, DelegateInfo as n, ParsedTags as o, ScopeString as p, DocumentParser as r, ParsedText as s, MappedText as t, ParserOptions as u };
-//# sourceMappingURL=index-eOBgsj8d.d.mts.map
+//# sourceMappingURL=index-BVAK5kk5.d.ts.map

package/dist/index.d.mts

@@ -1,5 +1,4 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-eOBgsj8d.mjs";
-//#region src/cspell-vfs.d.ts
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-BVAK5kk5.mjs";
 /**
  * Binary data for CSpellVFS file.
  * This can be exported by a JavaScript based CSpell Configuration file.
@@ -59,8 +58,6 @@ type CSpellVFSFileUrl = string;
  * @stability experimental
  */
 type CSpellVFS = Record<CSpellVFSFileUrl, CSpellVFSFileEntry>;
-//#endregion
-//#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
   /**
    * Number of suggestions to make.
@@ -85,8 +82,6 @@ interface SuggestionsConfiguration {
    */
   suggestionNumChanges?: number;
 }
-//#endregion
-//#region src/TextOffset.d.ts
 interface TextOffset {
   /**
    * The text found at the offset. If the text has been transformed, then the length might not match `length`.
@@ -109,8 +104,6 @@ interface TextDocumentOffset extends TextOffset {
   col: number;
   line: TextOffset;
 }
-//#endregion
-//#region src/CSpellReporter.d.ts
 interface Suggestion {
   /**
    * Word to suggest.
@@ -395,8 +388,6 @@ interface UnknownWordsConfiguration {
    */
   unknownWords?: UnknownWordsChoices | undefined;
 }
-//#endregion
-//#region src/CSpellValidation.d.ts
 interface CSpellSettingsValidation {
   /**
    * Control which segments of text emitted by a parser are spell checked, based upon
@@ -428,7 +419,7 @@ interface CSpellSettingsValidation {
    *
    * @default { "*": true }
    * @experimental
-   * @since 10.5.0
+   * @since 11.0.0
    */
   validate?: ValidationTags;
 }
@@ -455,8 +446,6 @@ interface ValidationTags {
    */
   [tag: TagPattern]: boolean | undefined;
 }
-//#endregion
-//#region src/suggestionCostsDef.d.ts
 /**
  * A WeightedMapDef enables setting weights for edits between related characters and substrings.
  *
@@ -543,8 +532,6 @@ interface CostMapDefInsDel extends CostMapDefBase {
 interface CostMapDefSwap extends CostMapDefBase {
   swap: number;
 }
-//#endregion
-//#region src/DictionaryInformation.d.ts
 /**
  * Provides extra information about the dictionary.
  *
@@ -764,8 +751,6 @@ interface PatternAdjustment {
   /** The amount of penalty to apply. */
   penalty: number;
 }
-//#endregion
-//#region src/InlineDictionary.d.ts
 interface InlineDictionary {
   /**
    * List of words to be considered correct.
@@ -818,8 +803,6 @@ interface InlineDictionary {
    */
   suggestWords?: string[];
 }
-//#endregion
-//#region src/DictionaryDefinition.d.ts
 type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | DictionaryDefinitionSimple | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 type DictionaryFileTypes = "S" | "W" | "C" | "T";
 interface DictionaryDefinitionBase {
@@ -1191,8 +1174,6 @@ type DictionaryKindSuggestWords = "suggest-words";
  * - `suggest-words` - A dictionary containing suggested word corrections.
  */
 type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords | DictionaryKindSuggestWords;
-//#endregion
-//#region src/features.d.ts
 /**
  * These are experimental features and are subject to change or removal without notice.
  */
@@ -1233,11 +1214,9 @@ type FeatureEnableOnly = boolean;
 interface FeatureWithConfiguration {
   enable: boolean;
 }
-//#endregion
-//#region src/Plugin/index.d.ts
 type CreateParser<Options = unknown> = (name: string, options?: Options) => Promise<DocumentParser | undefined> | DocumentParser | undefined;
 /**
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface AvailableParsers<Options> {
   /**
@@ -1247,7 +1226,7 @@ interface AvailableParsers<Options> {
   [name: string]: DocumentParser | Parser | CreateParser<Options>;
 }
 /**
- * @since 10.5.0
+ * @since 11.0.0
  */
 type Parsers = (DocumentParser | Parser)[];
 /**
@@ -1275,8 +1254,6 @@ interface CSpellSettingsPlugins {
    */
   plugins?: CSpellPlugin[];
 }
-//#endregion
-//#region src/Substitutions.d.ts
 /**
  * The ID for a substitution definition. This is used to reference the substitution definition in the substitutions array.
  * @since 9.7.0
@@ -1332,11 +1309,7 @@ type SubstitutionDefinitions = SubstitutionDefinition[];
  * This is a collection of substitution entries that can be applied to a document before spell checking.
  */
 type Substitutions = (SubstitutionEntry | SubstitutionID)[];
-//#endregion
-//#region src/types.d.ts
 type Serializable = number | string | boolean | null | object;
-//#endregion
-//#region src/WordSegmentation.d.ts
 interface WordSegmentationSettings {
   /**
    * Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
@@ -1419,8 +1392,6 @@ type SoftWordBreakRegExpString = string;
  * - `^` -- Indicates the start of a word
  * - `$` -- Indicates the end of a word
  *
- * For more complicated word break rules, consider using regular expressions with the {@link SoftWordBreakRegExp} type.
- *
  * Examples:
  * - `"^ptr|"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.
  * - `"^I|"` -- Would help with interface definitions starting with `I`, such as `IERROR`.
@@ -1457,8 +1428,6 @@ interface SoftWordBreakDefinitions {
 interface SoftWordBreaks {
   [name: string]: boolean;
 }
-//#endregion
-//#region src/CSpellSettingsDef.d.ts
 /**
  * These settings come from user and workspace settings.
  */
@@ -2248,25 +2217,16 @@ interface CompatibleEngineVersions {
    */
   [engine: string]: SemVersionPredicate | undefined;
 }
-//#endregion
-//#region src/configFields.d.ts
 type ConfigKeys = Exclude<keyof CSpellUserSettings, "$schema" | "version" | "id">;
 type CSpellUserSettingsFields = { [key in ConfigKeys]: key; };
 export declare const ConfigFields: CSpellUserSettingsFields;
-//#endregion
-//#region src/defaultConfigSettings.d.ts
 export declare const defaultCSpellSettings: {
   readonly ignoreRandomStrings: boolean;
   readonly minRandomLength: number;
 };
-//#endregion
-//#region src/defineConfig.d.ts
 export declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
-//#endregion
-//#region src/merge.d.ts
 export declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
 export declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
 export declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
-//#endregion
 export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, AvailableParsers, BaseSetting, CSpellPackageSettings, CSpellPlugin, CSpellPlugin as Plugin, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CSpellVFS, CSpellVFSBinaryData, CSpellVFSData, CSpellVFSFile, CSpellVFSFileEntry, CSpellVFSFileUrl, CSpellVFSTextData, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, CreateParser, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, DocumentParser, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, OverrideFilterFields, OverrideSettings, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Parsers, Pattern, PatternId, PatternRef, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, Range, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, SoftWordBreak, SoftWordBreakDefinitions, SoftWordBreakPattern, SoftWordBreakRegExp, SoftWordBreakRegExpString, SoftWordBreakRule, SoftWordBreaks, Source, SourceMap, SpellingErrorEmitter, SubstitutionDefinition, SubstitutionDefinitions, SubstitutionEntry, SubstitutionID, Substitutions, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TagPattern, TextDocument, TextDocumentFragment, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, ValidationTags, Version, VersionLatest, VersionLegacy, WordSegmentationSettings, WorkspaceTrustSettings };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-eOBgsj8d.js";
-//#region src/cspell-vfs.d.ts
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-BVAK5kk5.js";
 /**
  * Binary data for CSpellVFS file.
  * This can be exported by a JavaScript based CSpell Configuration file.
@@ -59,8 +58,6 @@ type CSpellVFSFileUrl = string;
  * @stability experimental
  */
 type CSpellVFS = Record<CSpellVFSFileUrl, CSpellVFSFileEntry>;
-//#endregion
-//#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
   /**
    * Number of suggestions to make.
@@ -85,8 +82,6 @@ interface SuggestionsConfiguration {
    */
   suggestionNumChanges?: number;
 }
-//#endregion
-//#region src/TextOffset.d.ts
 interface TextOffset {
   /**
    * The text found at the offset. If the text has been transformed, then the length might not match `length`.
@@ -109,8 +104,6 @@ interface TextDocumentOffset extends TextOffset {
   col: number;
   line: TextOffset;
 }
-//#endregion
-//#region src/CSpellReporter.d.ts
 interface Suggestion {
   /**
    * Word to suggest.
@@ -395,8 +388,6 @@ interface UnknownWordsConfiguration {
    */
   unknownWords?: UnknownWordsChoices | undefined;
 }
-//#endregion
-//#region src/CSpellValidation.d.ts
 interface CSpellSettingsValidation {
   /**
    * Control which segments of text emitted by a parser are spell checked, based upon
@@ -428,7 +419,7 @@ interface CSpellSettingsValidation {
    *
    * @default { "*": true }
    * @experimental
-   * @since 10.5.0
+   * @since 11.0.0
    */
   validate?: ValidationTags;
 }
@@ -455,8 +446,6 @@ interface ValidationTags {
    */
   [tag: TagPattern]: boolean | undefined;
 }
-//#endregion
-//#region src/suggestionCostsDef.d.ts
 /**
  * A WeightedMapDef enables setting weights for edits between related characters and substrings.
  *
@@ -543,8 +532,6 @@ interface CostMapDefInsDel extends CostMapDefBase {
 interface CostMapDefSwap extends CostMapDefBase {
   swap: number;
 }
-//#endregion
-//#region src/DictionaryInformation.d.ts
 /**
  * Provides extra information about the dictionary.
  *
@@ -764,8 +751,6 @@ interface PatternAdjustment {
   /** The amount of penalty to apply. */
   penalty: number;
 }
-//#endregion
-//#region src/InlineDictionary.d.ts
 interface InlineDictionary {
   /**
    * List of words to be considered correct.
@@ -818,8 +803,6 @@ interface InlineDictionary {
    */
   suggestWords?: string[];
 }
-//#endregion
-//#region src/DictionaryDefinition.d.ts
 type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | DictionaryDefinitionSimple | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 type DictionaryFileTypes = "S" | "W" | "C" | "T";
 interface DictionaryDefinitionBase {
@@ -1191,8 +1174,6 @@ type DictionaryKindSuggestWords = "suggest-words";
  * - `suggest-words` - A dictionary containing suggested word corrections.
  */
 type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords | DictionaryKindSuggestWords;
-//#endregion
-//#region src/features.d.ts
 /**
  * These are experimental features and are subject to change or removal without notice.
  */
@@ -1233,11 +1214,9 @@ type FeatureEnableOnly = boolean;
 interface FeatureWithConfiguration {
   enable: boolean;
 }
-//#endregion
-//#region src/Plugin/index.d.ts
 type CreateParser<Options = unknown> = (name: string, options?: Options) => Promise<DocumentParser | undefined> | DocumentParser | undefined;
 /**
- * @since 10.5.0
+ * @since 11.0.0
  */
 interface AvailableParsers<Options> {
   /**
@@ -1247,7 +1226,7 @@ interface AvailableParsers<Options> {
   [name: string]: DocumentParser | Parser | CreateParser<Options>;
 }
 /**
- * @since 10.5.0
+ * @since 11.0.0
  */
 type Parsers = (DocumentParser | Parser)[];
 /**
@@ -1275,8 +1254,6 @@ interface CSpellSettingsPlugins {
    */
   plugins?: CSpellPlugin[];
 }
-//#endregion
-//#region src/Substitutions.d.ts
 /**
  * The ID for a substitution definition. This is used to reference the substitution definition in the substitutions array.
  * @since 9.7.0
@@ -1332,11 +1309,7 @@ type SubstitutionDefinitions = SubstitutionDefinition[];
  * This is a collection of substitution entries that can be applied to a document before spell checking.
  */
 type Substitutions = (SubstitutionEntry | SubstitutionID)[];
-//#endregion
-//#region src/types.d.ts
 type Serializable = number | string | boolean | null | object;
-//#endregion
-//#region src/WordSegmentation.d.ts
 interface WordSegmentationSettings {
   /**
    * Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
@@ -1419,8 +1392,6 @@ type SoftWordBreakRegExpString = string;
  * - `^` -- Indicates the start of a word
  * - `$` -- Indicates the end of a word
  *
- * For more complicated word break rules, consider using regular expressions with the {@link SoftWordBreakRegExp} type.
- *
  * Examples:
  * - `"^ptr|"` -- Would help with pointer definitions starting with `ptr`, such as `ptrvalue`.
  * - `"^I|"` -- Would help with interface definitions starting with `I`, such as `IERROR`.
@@ -1457,8 +1428,6 @@ interface SoftWordBreakDefinitions {
 interface SoftWordBreaks {
   [name: string]: boolean;
 }
-//#endregion
-//#region src/CSpellSettingsDef.d.ts
 /**
  * These settings come from user and workspace settings.
  */
@@ -2248,25 +2217,16 @@ interface CompatibleEngineVersions {
    */
   [engine: string]: SemVersionPredicate | undefined;
 }
-//#endregion
-//#region src/configFields.d.ts
 type ConfigKeys = Exclude<keyof CSpellUserSettings, "$schema" | "version" | "id">;
 type CSpellUserSettingsFields = { [key in ConfigKeys]: key; };
 export declare const ConfigFields: CSpellUserSettingsFields;
-//#endregion
-//#region src/defaultConfigSettings.d.ts
 export declare const defaultCSpellSettings: {
   readonly ignoreRandomStrings: boolean;
   readonly minRandomLength: number;
 };
-//#endregion
-//#region src/defineConfig.d.ts
 export declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
-//#endregion
-//#region src/merge.d.ts
 export declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
 export declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
 export declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
-//#endregion
 export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, AvailableParsers, BaseSetting, CSpellPackageSettings, CSpellPlugin, CSpellPlugin as Plugin, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CSpellVFS, CSpellVFSBinaryData, CSpellVFSData, CSpellVFSFile, CSpellVFSFileEntry, CSpellVFSFileUrl, CSpellVFSTextData, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, CreateParser, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, DocumentParser, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, OverrideFilterFields, OverrideSettings, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Parsers, Pattern, PatternId, PatternRef, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, Range, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, SoftWordBreak, SoftWordBreakDefinitions, SoftWordBreakPattern, SoftWordBreakRegExp, SoftWordBreakRegExpString, SoftWordBreakRule, SoftWordBreaks, Source, SourceMap, SpellingErrorEmitter, SubstitutionDefinition, SubstitutionDefinitions, SubstitutionEntry, SubstitutionID, Substitutions, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TagPattern, TextDocument, TextDocumentFragment, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, ValidationTags, Version, VersionLatest, VersionLegacy, WordSegmentationSettings, WorkspaceTrustSettings };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/configFields.ts
+// src/configFields.ts
 const ConfigFields = {
 	allowCompoundWords: "allowCompoundWords",
 	cache: "cache",
@@ -62,8 +62,7 @@ const ConfigFields = {
 	words: "words",
 	parser: "parser"
 };
-//#endregion
-//#region src/CSpellReporter.ts
+// src/CSpellReporter.ts
 let IssueType = /* @__PURE__ */ function(IssueType) {
 	IssueType[IssueType["spelling"] = 0] = "spelling";
 	IssueType[IssueType["directive"] = 1] = "directive";
@@ -80,19 +79,16 @@ const unknownWordsChoices = {
 	ReportCommonTypos: "report-common-typos",
 	ReportFlagged: "report-flagged"
 };
-//#endregion
-//#region src/defaultConfigSettings.ts
+// src/defaultConfigSettings.ts
 const defaultCSpellSettings = {
 	ignoreRandomStrings: true,
 	minRandomLength: 40
 };
-//#endregion
-//#region src/defineConfig.ts
+// src/defineConfig.ts
 function defineConfig(config) {
 	return config;
 }
-//#endregion
-//#region src/merge.ts
+// src/merge.ts
 /** Merge Append Arrays */
 const mArr = mergeAppendArrays;
 /** Merge Records */
@@ -209,7 +205,6 @@ function recKV(key, value) {
 	if (value === void 0) return void 0;
 	return { [key]: value };
 }
-//#endregion
 exports.ConfigFields = ConfigFields;
 exports.IssueType = IssueType;
 exports.MessageTypes = MessageTypes;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-//#region src/configFields.ts
+// src/configFields.ts
 const ConfigFields = {
 	allowCompoundWords: "allowCompoundWords",
 	cache: "cache",
@@ -61,8 +61,7 @@ const ConfigFields = {
 	words: "words",
 	parser: "parser"
 };
-//#endregion
-//#region src/CSpellReporter.ts
+// src/CSpellReporter.ts
 let IssueType = /* @__PURE__ */ function(IssueType) {
 	IssueType[IssueType["spelling"] = 0] = "spelling";
 	IssueType[IssueType["directive"] = 1] = "directive";
@@ -79,19 +78,16 @@ const unknownWordsChoices = {
 	ReportCommonTypos: "report-common-typos",
 	ReportFlagged: "report-flagged"
 };
-//#endregion
-//#region src/defaultConfigSettings.ts
+// src/defaultConfigSettings.ts
 const defaultCSpellSettings = {
 	ignoreRandomStrings: true,
 	minRandomLength: 40
 };
-//#endregion
-//#region src/defineConfig.ts
+// src/defineConfig.ts
 function defineConfig(config) {
 	return config;
 }
-//#endregion
-//#region src/merge.ts
+// src/merge.ts
 /** Merge Append Arrays */
 const mArr = mergeAppendArrays;
 /** Merge Records */
@@ -208,7 +204,6 @@ function recKV(key, value) {
 	if (value === void 0) return void 0;
 	return { [key]: value };
 }
-//#endregion
 export { ConfigFields, IssueType, MessageTypes, defaultCSpellSettings, defineConfig, mergeConfig, unknownWordsChoices };
 
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-types",
-  "version": "10.4.0",
+  "version": "10.4.1",
   "description": "Types for cspell and cspell-lib",
   "publishConfig": {
     "access": "public",
@@ -88,5 +88,5 @@
   "engines": {
     "node": ">=22.18.0"
   },
-  "gitHead": "7e2bbb5e866c827ac5d2cf6b84bf3e1a016d0823"
+  "gitHead": "ddb1699a4bfc2766675c2c97412a813d775772eb"
 }