@cspell/cspell-types 10.3.1-alpha.1 → 10.3.2-alpha.0

package/README.md

@@ -8,13 +8,11 @@ This package contains no dependencies to avoid any security issues.
 
 <!--- @@inject: ../../static/sponsor.md --->
 
-[![GitHub Sponsors](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=githubsponsors&label=GitHub%20Sponsor%3A)](https://github.com/sponsors/streetsidesoftware)
+If our spell checkers save you time, please consider supporting their development.
 
-[![Open Collective](https://img.shields.io/badge/-CSpell-black?style=for-the-badge&logo=opencollective&label=Open%20Collective%3A)](https://opencollective.com/cspell)
-
-[![Street Side Software](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fstreetsidesoftware%2Fcspell%2Frefs%2Fheads%2Fmain%2Fstatic%2Fcspell-badge.json)](https://streetsidesoftware.com/sponsor/)
-
-[![PayPal](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=paypal&label=PayPal%20Donate%3A)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
+<p align="left">
+  <a href="https://github.com/sponsors/streetsidesoftware" title="GitHub Sponsor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/github-sponsor-dark.png" /><img alt="GitHub Sponsor" src="https://cspell.org/img/sponsor/github-sponsor.png" width="180" /></picture></a> &nbsp; <a href="https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY" title="PayPal"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/paypal-dark.png" /><img alt="PayPal" src="https://cspell.org/img/sponsor/paypal.png" width="180" /></picture></a> &nbsp; <a href="https://opencollective.com/cspell" title="Open Collective"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/open-collective-dark.png" /><img alt="Open Collective" src="https://cspell.org/img/sponsor/open-collective.png" width="180" /></picture></a> &nbsp; <a href="https://streetsidesoftware.com/sponsor/" title="Street Side Software"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/cspell-dark.png" /><img alt="CSpell" src="https://cspell.org/img/sponsor/cspell.png" width="180" /></picture></a>
+</p>
 
 <!--- @@inject-end: ../../static/sponsor.md --->
 
@@ -26,7 +24,7 @@ npm i -S @cspell/cspell-types
 
 ## Usage
 
-Can be use to make writing `cspell.config.js` files easier.
+Can be used to make writing `cspell.config.js` files easier.
 
 ```js
 'use strict';
@@ -61,7 +59,7 @@ module.exports = cspell;
 
 ## API
 
-`CSpellSettings` alias `CSpellUserSettings` is the formal definition of the configuration that controls the spell checker.
+`CSpellSettings` (aliased as `CSpellUserSettings`) is the formal definition of the configuration that controls the spell checker.
 
 ## CSpell for Enterprise
 

package/cspell.schema.json

@@ -88,9 +88,9 @@
         },
         "cacheStrategy": {
           "$ref": "#/definitions/CacheStrategy",
-          "default": "metadata",
-          "description": "Strategy to use for detecting changed files, default: metadata",
-          "markdownDescription": "Strategy to use for detecting changed files, default: metadata"
+          "default": "content",
+          "description": "Strategy to use for detecting changed files, default: content",
+          "markdownDescription": "Strategy to use for detecting changed files, default: content"
         },
         "useCache": {
           "default": false,
@@ -1417,8 +1417,8 @@
           "since": "9.1.0"
         },
         "useIntlWordSegmentation": {
-          "description": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
-          "markdownDescription": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
+          "description": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
+          "markdownDescription": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
           "since": "10.2.0",
           "type": "boolean"
         },
@@ -1491,11 +1491,11 @@
           "type": "array"
         },
         "enableFiletypes": {
-          "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
+          "description": "Enable / Disable checking file types (languageIds).\n\nThese are in addition to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`.\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
           "items": {
             "$ref": "#/definitions/LanguageIdSingle"
           },
-          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
+          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in addition to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`.\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
           "scope": "resource",
           "title": "Enable File Types",
           "type": "array",
@@ -1727,8 +1727,8 @@
           "since": "9.1.0"
         },
         "useIntlWordSegmentation": {
-          "description": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
-          "markdownDescription": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
+          "description": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
+          "markdownDescription": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
           "since": "10.2.0",
           "type": "boolean"
         },
@@ -2198,11 +2198,11 @@
       "type": "array"
     },
     "enableFiletypes": {
-      "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
+      "description": "Enable / Disable checking file types (languageIds).\n\nThese are in addition to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`.\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
       "items": {
         "$ref": "#/definitions/LanguageIdSingle"
       },
-      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
+      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in addition to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`.\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
       "scope": "resource",
       "title": "Enable File Types",
       "type": "array",
@@ -2291,8 +2291,8 @@
     },
     "globRoot": {
       "$ref": "#/definitions/FSPathResolvable",
-      "description": "The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file.",
-      "markdownDescription": "The root to use for glob patterns found in this configuration.\nDefault: location of the configuration file.\n  For compatibility reasons, config files with version 0.1, the glob root will\n  default to be `${cwd}`.\n\nUse `globRoot` to define a different location.\n`globRoot` can be relative to the location of this configuration file.\nDefining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
+      "description": "The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, for config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file.",
+      "markdownDescription": "The root to use for glob patterns found in this configuration.\nDefault: location of the configuration file.\n  For compatibility reasons, for config files with version 0.1, the glob root will\n  default to be `${cwd}`.\n\nUse `globRoot` to define a different location.\n`globRoot` can be relative to the location of this configuration file.\nDefining globRoot does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
     },
     "id": {
       "description": "Optional identifier.",
@@ -2354,8 +2354,8 @@
     },
     "languageId": {
       "$ref": "#/definitions/MatchingFileType",
-      "description": "Forces the spell checker to assume a give language id. Used mainly as an Override.",
-      "markdownDescription": "Forces the spell checker to assume a give language id. Used mainly as an Override."
+      "description": "Forces the spell checker to assume a given language id. Used mainly as an Override.",
+      "markdownDescription": "Forces the spell checker to assume a given language id. Used mainly as an Override."
     },
     "languageSettings": {
       "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
@@ -2544,8 +2544,8 @@
       "type": "boolean"
     },
     "useIntlWordSegmentation": {
-      "description": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
-      "markdownDescription": "Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
+      "description": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the  {@link  language  }  setting.",
+      "markdownDescription": "Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.\nThe locale used for the segmentation is based on the  {@link  language  }  setting.",
       "since": "10.2.0",
       "type": "boolean"
     },

package/dist/Parser/index.d.mts

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

package/dist/Parser/index.d.ts

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

package/dist/{index-BXiGhX2J.d.ts → index-CWMq17j-.d.mts}

@@ -105,6 +105,10 @@ interface ParsedText extends Readonly<Mapped> {
    * based upon the value of the scope.
    */
   readonly scope?: Scope | undefined;
+  /**
+   * The tags associated with this segment of text.
+   */
+  readonly tags?: ParsedTags | undefined;
   /**
    * Used to delegate parsing the contents of `text` to another parser.
    *
@@ -158,6 +162,17 @@ interface ScopeChain {
  */
 type ScopeString = string;
 type Scope = ScopeChain | ScopeString;
+type ParsedTag = boolean | string | undefined;
+/**
+ * ParsedTags represents a collection of tags associated with a segment of text. Each tag can have a boolean, string, or undefined value.
+ *
+ * - `undefined` represents a tag that is not set.
+ * - `boolean` represents a tag that is either true or false.
+ * - `string` represents a tag with a string value.
+ */
+interface ParsedTags {
+  readonly [tag: string]: ParsedTag;
+}
 //#endregion
 //#region src/Parser/TextMap.d.ts
 type MappedText = Readonly<TransformedText>;
@@ -172,5 +187,5 @@ interface TransformedText extends Mapped {
   rawText?: string | undefined;
 }
 //#endregion
-export { Parser as a, Scope as c, Range as d, SourceMap as f, ParsedText as i, ScopeChain as l, DelegateInfo as n, ParserName as o, ParseResult as r, ParserOptions as s, MappedText as t, ScopeString as u };
-//# sourceMappingURL=index-BXiGhX2J.d.ts.map
+export { ParsedTags as a, ParserName as c, ScopeChain as d, ScopeString as f, ParsedTag as i, ParserOptions as l, SourceMap as m, DelegateInfo as n, ParsedText as o, Range as p, ParseResult as r, Parser as s, MappedText as t, Scope as u };
+//# sourceMappingURL=index-CWMq17j-.d.mts.map

package/dist/{index-BXiGhX2J.d.mts → index-CWMq17j-.d.ts}

@@ -105,6 +105,10 @@ interface ParsedText extends Readonly<Mapped> {
    * based upon the value of the scope.
    */
   readonly scope?: Scope | undefined;
+  /**
+   * The tags associated with this segment of text.
+   */
+  readonly tags?: ParsedTags | undefined;
   /**
    * Used to delegate parsing the contents of `text` to another parser.
    *
@@ -158,6 +162,17 @@ interface ScopeChain {
  */
 type ScopeString = string;
 type Scope = ScopeChain | ScopeString;
+type ParsedTag = boolean | string | undefined;
+/**
+ * ParsedTags represents a collection of tags associated with a segment of text. Each tag can have a boolean, string, or undefined value.
+ *
+ * - `undefined` represents a tag that is not set.
+ * - `boolean` represents a tag that is either true or false.
+ * - `string` represents a tag with a string value.
+ */
+interface ParsedTags {
+  readonly [tag: string]: ParsedTag;
+}
 //#endregion
 //#region src/Parser/TextMap.d.ts
 type MappedText = Readonly<TransformedText>;
@@ -172,5 +187,5 @@ interface TransformedText extends Mapped {
   rawText?: string | undefined;
 }
 //#endregion
-export { Parser as a, Scope as c, Range as d, SourceMap as f, ParsedText as i, ScopeChain as l, DelegateInfo as n, ParserName as o, ParseResult as r, ParserOptions as s, MappedText as t, ScopeString as u };
-//# sourceMappingURL=index-BXiGhX2J.d.mts.map
+export { ParsedTags as a, ParserName as c, ScopeChain as d, ScopeString as f, ParsedTag as i, ParserOptions as l, SourceMap as m, DelegateInfo as n, ParsedText as o, Range as p, ParseResult as r, Parser as s, MappedText as t, Scope as u };
+//# sourceMappingURL=index-CWMq17j-.d.ts.map

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { a as Parser, d as Range, f as SourceMap, i as ParsedText, o as ParserName, r as ParseResult, s as ParserOptions, t as MappedText } from "./index-BXiGhX2J.mjs";
+import { a as ParsedTags, c as ParserName, i as ParsedTag, l as ParserOptions, m as SourceMap, o as ParsedText, p as Range, r as ParseResult, s as Parser, t as MappedText } from "./index-CWMq17j-.mjs";
 //#region src/cspell-vfs.d.ts
 /**
  * Binary data for CSpellVFS file.
@@ -1229,7 +1229,7 @@ type Serializable = number | string | boolean | null | object;
 //#region src/WordSegmentation.d.ts
 interface WordSegmentationSettings {
   /**
-   * Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
+   * Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
    * The locale used for the segmentation is based on the {@link language} setting.
    *
    * @since 10.2.0
@@ -1392,12 +1392,12 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   /**
    * The root to use for glob patterns found in this configuration.
    * Default: location of the configuration file.
-   *   For compatibility reasons, config files with version 0.1, the glob root will
+   *   For compatibility reasons, for config files with version 0.1, the glob root will
    *   default to be `${cwd}`.
    *
    * Use `globRoot` to define a different location.
    * `globRoot` can be relative to the location of this configuration file.
-   * Defining globRoot, does not impact imported configurations.
+   * Defining globRoot does not impact imported configurations.
    *
    * Special Values:
    * - `${cwd}` - will be replaced with the current working directory.
@@ -1538,8 +1538,8 @@ interface SpellCheckerExtensionSettings {
   /**
    * Enable / Disable checking file types (languageIds).
    *
-   * These are in additional to the file types specified by {@link Settings.enabledLanguageIds}.
-   * To disable a language, prefix with `!` as in `!json`,
+   * These are in addition to the file types specified by {@link Settings.enabledLanguageIds}.
+   * To disable a language, prefix with `!` as in `!json`.
    *
    *
    * **Example: individual file types**
@@ -1604,7 +1604,7 @@ interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings, Spe
    *
    */
   languageSettings?: LanguageSetting[];
-  /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
+  /** Forces the spell checker to assume a given language id. Used mainly as an Override. */
   languageId?: MatchingFileType;
   /**
    * By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
@@ -1682,8 +1682,8 @@ interface CacheSettings {
    */
   cacheLocation?: FSPathResolvable;
   /**
-   * Strategy to use for detecting changed files, default: metadata
-   * @default 'metadata'
+   * Strategy to use for detecting changed files, default: content
+   * @default 'content'
    */
   cacheStrategy?: CacheStrategy;
   /**
@@ -2173,5 +2173,5 @@ declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
 declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
 declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
 //#endregion
-export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type Range, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type Source, type SourceMap, type SpellingErrorEmitter, type SubstitutionDefinition, type SubstitutionDefinitions, type SubstitutionEntry, type SubstitutionID, type Substitutions, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, mergeConfig, unknownWordsChoices };
+export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedTag, type ParsedTags, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type Range, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type SoftWordBreak, type SoftWordBreakDefinitions, type SoftWordBreakPattern, type SoftWordBreakRegExp, type SoftWordBreakRegExpString, type SoftWordBreakRule, type SoftWordBreaks, type Source, type SourceMap, type SpellingErrorEmitter, type SubstitutionDefinition, type SubstitutionDefinitions, type SubstitutionEntry, type SubstitutionID, type Substitutions, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WordSegmentationSettings, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, mergeConfig, unknownWordsChoices };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as Parser, d as Range, f as SourceMap, i as ParsedText, o as ParserName, r as ParseResult, s as ParserOptions, t as MappedText } from "./index-BXiGhX2J.js";
+import { a as ParsedTags, c as ParserName, i as ParsedTag, l as ParserOptions, m as SourceMap, o as ParsedText, p as Range, r as ParseResult, s as Parser, t as MappedText } from "./index-CWMq17j-.js";
 //#region src/cspell-vfs.d.ts
 /**
  * Binary data for CSpellVFS file.
@@ -1229,7 +1229,7 @@ type Serializable = number | string | boolean | null | object;
 //#region src/WordSegmentation.d.ts
 interface WordSegmentationSettings {
   /**
-   * Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
+   * Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
    * The locale used for the segmentation is based on the {@link language} setting.
    *
    * @since 10.2.0
@@ -1392,12 +1392,12 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   /**
    * The root to use for glob patterns found in this configuration.
    * Default: location of the configuration file.
-   *   For compatibility reasons, config files with version 0.1, the glob root will
+   *   For compatibility reasons, for config files with version 0.1, the glob root will
    *   default to be `${cwd}`.
    *
    * Use `globRoot` to define a different location.
    * `globRoot` can be relative to the location of this configuration file.
-   * Defining globRoot, does not impact imported configurations.
+   * Defining globRoot does not impact imported configurations.
    *
    * Special Values:
    * - `${cwd}` - will be replaced with the current working directory.
@@ -1538,8 +1538,8 @@ interface SpellCheckerExtensionSettings {
   /**
    * Enable / Disable checking file types (languageIds).
    *
-   * These are in additional to the file types specified by {@link Settings.enabledLanguageIds}.
-   * To disable a language, prefix with `!` as in `!json`,
+   * These are in addition to the file types specified by {@link Settings.enabledLanguageIds}.
+   * To disable a language, prefix with `!` as in `!json`.
    *
    *
    * **Example: individual file types**
@@ -1604,7 +1604,7 @@ interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings, Spe
    *
    */
   languageSettings?: LanguageSetting[];
-  /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
+  /** Forces the spell checker to assume a given language id. Used mainly as an Override. */
   languageId?: MatchingFileType;
   /**
    * By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
@@ -1682,8 +1682,8 @@ interface CacheSettings {
    */
   cacheLocation?: FSPathResolvable;
   /**
-   * Strategy to use for detecting changed files, default: metadata
-   * @default 'metadata'
+   * Strategy to use for detecting changed files, default: content
+   * @default 'content'
    */
   cacheStrategy?: CacheStrategy;
   /**
@@ -2173,5 +2173,5 @@ declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
 declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
 declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
 //#endregion
-export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type Range, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type Source, type SourceMap, type SpellingErrorEmitter, type SubstitutionDefinition, type SubstitutionDefinitions, type SubstitutionEntry, type SubstitutionID, type Substitutions, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, mergeConfig, unknownWordsChoices };
+export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedTag, type ParsedTags, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type Range, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type SoftWordBreak, type SoftWordBreakDefinitions, type SoftWordBreakPattern, type SoftWordBreakRegExp, type SoftWordBreakRegExpString, type SoftWordBreakRule, type SoftWordBreaks, type Source, type SourceMap, type SpellingErrorEmitter, type SubstitutionDefinition, type SubstitutionDefinitions, type SubstitutionEntry, type SubstitutionID, type Substitutions, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WordSegmentationSettings, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, mergeConfig, unknownWordsChoices };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.1-alpha.1",
+  "version": "10.3.2-alpha.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -85,5 +85,5 @@
     "node": ">=22.18.0"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "aa0576e5b7e666a7e8645939871bcfe4fa2a7eb5"
+  "gitHead": "c7193065b82df0646e24ab6f6d370c12148f0efc"
 }