@cspell/cspell-types 9.4.0 → 9.6.0

package/README.md

@@ -8,13 +8,13 @@ This package contains no dependencies to avoid any security issues.
 
 <!--- @@inject: ../../static/sponsor.md --->
 
-- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](https://github.com/sponsors/streetsidesoftware)
-- [![PayPal](https://img.shields.io/badge/-black?style=social&logo=paypal&label=PayPal%20Donate%3A%20Street%20Side%20Software)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
-- [![Open Collective](https://img.shields.io/badge/-black?style=social&logo=opencollective&label=Open%20Collective%3A%20CSpell)](https://opencollective.com/cspell)
+[![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)
 
-<!---
-- [![Patreon](https://img.shields.io/badge/-black?style=social&logo=patreon&label=Patreon%3A%20Street%20Side%20Software)](https://patreon.com/streetsidesoftware)
-  --->
+[![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)
 
 <!--- @@inject-end: ../../static/sponsor.md --->
 

package/cspell.schema.json

@@ -200,9 +200,9 @@
       "type": "object"
     },
     "CustomDictionaryPath": {
-      "$ref": "#/definitions/FsDictionaryPath",
-      "description": "A File System Path to a dictionary file.",
-      "markdownDescription": "A File System Path to a dictionary file."
+      "description": "A path or url to a custom dictionary file.",
+      "markdownDescription": "A path or url to a custom dictionary file.",
+      "type": "string"
     },
     "CustomDictionaryScope": {
       "description": "Specifies the scope of a dictionary.",
@@ -239,7 +239,7 @@
     "DictionaryDefinitionAlternate": {
       "additionalProperties": false,
       "deprecated": true,
-      "deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.",
+      "deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.\nThis will be removed in a future release.",
       "description": "Only for legacy dictionary definitions.",
       "markdownDescription": "Only for legacy dictionary definitions.",
       "properties": {
@@ -304,6 +304,12 @@
       "description": "Used to provide extra data related to the dictionary",
       "markdownDescription": "Used to provide extra data related to the dictionary",
       "properties": {
+        "btrie": {
+          "$ref": "#/definitions/DictionaryPathToBTrie",
+          "description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
+          "markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
+          "since": "9.6.0"
+        },
         "description": {
           "description": "Optional description of the contents / purpose of the dictionary.",
           "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
@@ -329,8 +335,8 @@
         },
         "path": {
           "$ref": "#/definitions/DictionaryPath",
-          "description": "Path to the file.",
-          "markdownDescription": "Path to the file."
+          "description": "Path or url to the dictionary file.",
+          "markdownDescription": "Path or url to the dictionary file."
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
@@ -371,6 +377,12 @@
           "markdownDescription": "When `true`, let's the spell checker know that words can be added to this dictionary.",
           "type": "boolean"
         },
+        "btrie": {
+          "$ref": "#/definitions/DictionaryPathToBTrie",
+          "description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
+          "markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
+          "since": "9.6.0"
+        },
         "description": {
           "description": "Optional description of the contents / purpose of the dictionary.",
           "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
@@ -393,8 +405,8 @@
         },
         "path": {
           "$ref": "#/definitions/CustomDictionaryPath",
-          "description": "Path to custom dictionary text file.",
-          "markdownDescription": "Path to custom dictionary text file."
+          "description": "A file path or url to a custom dictionary file.",
+          "markdownDescription": "A file path or url to a custom dictionary file."
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
@@ -695,6 +707,12 @@
     "DictionaryDefinitionPreferred": {
       "additionalProperties": false,
       "properties": {
+        "btrie": {
+          "$ref": "#/definitions/DictionaryPathToBTrie",
+          "description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
+          "markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
+          "since": "9.6.0"
+        },
         "description": {
           "description": "Optional description of the contents / purpose of the dictionary.",
           "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
@@ -717,8 +735,8 @@
         },
         "path": {
           "$ref": "#/definitions/DictionaryPath",
-          "description": "Path to the file.",
-          "markdownDescription": "Path to the file."
+          "description": "Path or url to the dictionary file.",
+          "markdownDescription": "Path or url to the dictionary file."
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
@@ -870,8 +888,14 @@
       "type": "string"
     },
     "DictionaryPath": {
-      "description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
-      "markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
+      "description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
+      "markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
+      "type": "string"
+    },
+    "DictionaryPathToBTrie": {
+      "description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
+      "markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
+      "since": "9.6.0",
       "type": "string"
     },
     "DictionaryRef": {
@@ -948,11 +972,6 @@
       },
       "type": "object"
     },
-    "FsDictionaryPath": {
-      "description": "A File System Path. Relative paths are relative to the configuration file.",
-      "markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
-      "type": "string"
-    },
     "FsPath": {
       "description": "A File System Path. Relative paths are relative to the configuration file.",
       "markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",

package/dist/Parser/index.d.mts

@@ -1,2 +1,129 @@
-import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-TAd2zi6U.mjs";
-export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };
+//#region src/Parser/index.d.ts
+type ParserOptions = Record<string, unknown>;
+type ParserName = string;
+interface Parser {
+  /** Name of parser */
+  readonly name: ParserName;
+  /**
+  * Parse Method
+  * @param content - full content of the file
+  * @param filename - filename
+  */
+  parse(content: string, filename: string): ParseResult;
+}
+interface ParseResult {
+  readonly content: string;
+  readonly filename: string;
+  readonly parsedTexts: Iterable<ParsedText>;
+}
+interface ParsedText {
+  /**
+  * The text extracted and possibly transformed
+  */
+  readonly text: string;
+  /**
+  * The raw text before it has been transformed
+  */
+  readonly rawText?: string | undefined;
+  /**
+  * start and end offsets of the text
+  */
+  readonly range: Range;
+  /**
+  * The Scope annotation for a segment of text.
+  * Used by the spell checker to apply spell checking options
+  * based upon the value of the scope.
+  */
+  readonly scope?: Scope | undefined;
+  /**
+  * The source map is used to support text transformations.
+  *
+  * See: {@link SourceMap}
+  */
+  readonly map?: SourceMap | undefined;
+  /**
+  * Used to delegate parsing the contents of `text` to another parser.
+  *
+  */
+  readonly delegate?: DelegateInfo | undefined;
+}
+/**
+* A SourceMap is used to map transform a piece of text back to its original text.
+* This is necessary in order to report the correct location of a spelling issue.
+* An empty source map indicates that it was a 1:1 transformation.
+*
+* The values in a source map are number pairs (even, odd) relative to the beginning of each
+* string segment.
+* - even - offset in the source text
+* - odd - offset in the transformed text
+*
+* Offsets start a 0
+*
+* Example:
+*
+* - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
+* - Transformed text: `Grand Café Bjørvika`
+* - Map: [9, 9, 15, 10, 18, 13, 24, 14]
+*
+* | offset | original    | offset | transformed |
+* | ------ | ----------- | ------ | ----------- |
+* | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
+* | 9-15   | `\u00e9`    | 9-10   | `é`         |
+* | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
+* | 18-24  | `\u00f8`    | 13-14  | `ø`         |
+* | 24-29  | `rvika`     | 14-19  | `rvika`     |
+*
+* <!--- cspell:ignore Bjørvika rvika --->
+*/
+type SourceMap = number[];
+type Range = readonly [start: number, end: number];
+/**
+* DelegateInfo is used by a parser to delegate parsing a subsection of a document to
+* another parser. The following information is used by the spell checker to match
+* the parser.
+*/
+interface DelegateInfo {
+  /**
+  * Proposed virtual file name including the extension.
+  * Format: `./${source_filename}/${block_number}.${ext}
+  * Example: `./README.md/1.js`
+  */
+  readonly filename: string;
+  /**
+  * The filename of the origin of the virtual file block.
+  * Example: `./README.md`
+  */
+  readonly originFilename: string;
+  /**
+  * Proposed file extension
+  * Example: `.js`
+  */
+  readonly extension: string;
+  /**
+  * Filetype to use
+  * Example: `javascript`
+  */
+  readonly fileType?: string;
+}
+/**
+* Scope - chain of scope going from local to global
+*
+* Example:
+* ```
+* `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
+* ```
+*/
+interface ScopeChain {
+  readonly value: string;
+  readonly parent?: ScopeChain | undefined;
+}
+/**
+* A string representing a scope chain separated by spaces
+*
+* Example: `comment.block.documentation.ts meta.interface.ts source.ts`
+*/
+type ScopeString = string;
+type Scope = ScopeChain | ScopeString;
+//#endregion
+export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };
+//# sourceMappingURL=index.d.mts.map

package/dist/Parser/index.d.ts

@@ -1,2 +1,129 @@
-import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-BtvDF-9G.js";
-export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };
+//#region src/Parser/index.d.ts
+type ParserOptions = Record<string, unknown>;
+type ParserName = string;
+interface Parser {
+  /** Name of parser */
+  readonly name: ParserName;
+  /**
+  * Parse Method
+  * @param content - full content of the file
+  * @param filename - filename
+  */
+  parse(content: string, filename: string): ParseResult;
+}
+interface ParseResult {
+  readonly content: string;
+  readonly filename: string;
+  readonly parsedTexts: Iterable<ParsedText>;
+}
+interface ParsedText {
+  /**
+  * The text extracted and possibly transformed
+  */
+  readonly text: string;
+  /**
+  * The raw text before it has been transformed
+  */
+  readonly rawText?: string | undefined;
+  /**
+  * start and end offsets of the text
+  */
+  readonly range: Range;
+  /**
+  * The Scope annotation for a segment of text.
+  * Used by the spell checker to apply spell checking options
+  * based upon the value of the scope.
+  */
+  readonly scope?: Scope | undefined;
+  /**
+  * The source map is used to support text transformations.
+  *
+  * See: {@link SourceMap}
+  */
+  readonly map?: SourceMap | undefined;
+  /**
+  * Used to delegate parsing the contents of `text` to another parser.
+  *
+  */
+  readonly delegate?: DelegateInfo | undefined;
+}
+/**
+* A SourceMap is used to map transform a piece of text back to its original text.
+* This is necessary in order to report the correct location of a spelling issue.
+* An empty source map indicates that it was a 1:1 transformation.
+*
+* The values in a source map are number pairs (even, odd) relative to the beginning of each
+* string segment.
+* - even - offset in the source text
+* - odd - offset in the transformed text
+*
+* Offsets start a 0
+*
+* Example:
+*
+* - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
+* - Transformed text: `Grand Café Bjørvika`
+* - Map: [9, 9, 15, 10, 18, 13, 24, 14]
+*
+* | offset | original    | offset | transformed |
+* | ------ | ----------- | ------ | ----------- |
+* | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
+* | 9-15   | `\u00e9`    | 9-10   | `é`         |
+* | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
+* | 18-24  | `\u00f8`    | 13-14  | `ø`         |
+* | 24-29  | `rvika`     | 14-19  | `rvika`     |
+*
+* <!--- cspell:ignore Bjørvika rvika --->
+*/
+type SourceMap = number[];
+type Range = readonly [start: number, end: number];
+/**
+* DelegateInfo is used by a parser to delegate parsing a subsection of a document to
+* another parser. The following information is used by the spell checker to match
+* the parser.
+*/
+interface DelegateInfo {
+  /**
+  * Proposed virtual file name including the extension.
+  * Format: `./${source_filename}/${block_number}.${ext}
+  * Example: `./README.md/1.js`
+  */
+  readonly filename: string;
+  /**
+  * The filename of the origin of the virtual file block.
+  * Example: `./README.md`
+  */
+  readonly originFilename: string;
+  /**
+  * Proposed file extension
+  * Example: `.js`
+  */
+  readonly extension: string;
+  /**
+  * Filetype to use
+  * Example: `javascript`
+  */
+  readonly fileType?: string;
+}
+/**
+* Scope - chain of scope going from local to global
+*
+* Example:
+* ```
+* `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
+* ```
+*/
+interface ScopeChain {
+  readonly value: string;
+  readonly parent?: ScopeChain | undefined;
+}
+/**
+* A string representing a scope chain separated by spaces
+*
+* Example: `comment.block.documentation.ts meta.interface.ts source.ts`
+*/
+type ScopeString = string;
+type Scope = ScopeChain | ScopeString;
+//#endregion
+export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-TAd2zi6U.mjs";
+import { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from "./Parser/index.mjs";
 
 //#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
@@ -750,9 +750,18 @@ interface DictionaryDefinitionBase {
   supportNonStrictSearches?: boolean | undefined;
 }
 interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
-  /** Path to the file. */
+  /**
+  * Path or url to the dictionary file.
+  */
   path: DictionaryPath;
   /**
+  * An alternative path to a bTrie dictionary file.
+  * It will be used in place of `path` if the version of CSpell being used
+  * supports btrie files.
+  * @since 9.6.0
+  */
+  btrie?: DictionaryPathToBTrie | undefined;
+  /**
   * Only for legacy dictionary definitions.
   * @deprecated true
   * @deprecationMessage Use {@link path} instead.
@@ -760,10 +769,25 @@ interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
   */
   file?: undefined;
 }
+interface HiddenPaths {
+  /**
+  * @hide
+  */
+  path?: string | undefined;
+  /**
+  * @hide
+  */
+  btrie?: string | undefined;
+  /**
+  * @hide
+  */
+  file?: undefined;
+}
+interface DictionaryDefinitionBaseWithPathsHidden extends DictionaryDefinitionBase, HiddenPaths {}
 /**
 * An Empty Dictionary Definition
 */
-interface DictionaryDefinitionSimple extends DictionaryDefinitionBase {
+interface DictionaryDefinitionSimple extends DictionaryDefinitionBaseWithPathsHidden {
   /**
   * @hide
   */
@@ -784,14 +808,6 @@ interface DictionaryDefinitionSimple extends DictionaryDefinitionBase {
   * @hide
   */
   type?: DictionaryFileTypes | undefined;
-  /**
-  * @hide
-  */
-  path?: string | undefined;
-  /**
-  * @hide
-  */
-  file?: undefined;
 }
 /**
 * Used to provide extra data related to the dictionary
@@ -809,6 +825,11 @@ interface HiddenFields {
   * Not used
   * @hide
   */
+  btrie?: string | undefined;
+  /**
+  * Not used
+  * @hide
+  */
   file?: undefined;
   /**
   * Not used
@@ -862,12 +883,9 @@ type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDe
 * Only for legacy dictionary definitions.
 * @deprecated true
 * @deprecationMessage Use {@link DictionaryDefinitionPreferred} instead.
+* This will be removed in a future release.
 */
-interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
-  /**
-  * @hidden
-  */
-  path?: undefined;
+interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase, Omit<HiddenPaths, "file"> {
   /**
   * Path to the file, only for legacy dictionary definitions.
   * @deprecated true
@@ -881,9 +899,11 @@ interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
 }
 /**
 * @deprecated true
+* @deprecationMessage Use {@link DictionaryDefinitionPreferred} instead.
+* This will be removed in a future release.
 * @hidden
 */
-interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
+interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase, Omit<HiddenPaths, "file" | "path"> {
   /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
   path?: FsDictionaryPath;
   /**
@@ -922,7 +942,9 @@ type CustomDictionaryScope = "user" | "workspace" | "folder";
 * Note: only plain text files with one word per line are supported at this moment.
 */
 interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
-  /** Path to custom dictionary text file. */
+  /**
+  * A file path or url to a custom dictionary file.
+  */
   path: CustomDictionaryPath;
   /**
   * Defines the scope for when words will be added to the dictionary.
@@ -956,13 +978,19 @@ type ReplaceMap = ReplaceEntry[];
 type FsDictionaryPath = string;
 /**
 * A File System Path to a dictionary file.
-* Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$`
+* Pattern: `^.*\.(?:txt|trie|btrie|dic)(?:\.gz)?$`
 */
 type DictionaryPath = string;
 /**
 * A File System Path to a dictionary file.
+* Pattern: `^.*\.(?:btrie)(?:\.gz)?$`
+* @since 9.6.0
+*/
+type DictionaryPathToBTrie = string;
+/**
+* A path or url to a custom dictionary file.
 */
-type CustomDictionaryPath = FsDictionaryPath;
+type CustomDictionaryPath = string;
 /**
 * Reference to a dictionary by name.
 * One of:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-BtvDF-9G.js";
+import { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from "./Parser/index.js";
 
 //#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
@@ -750,9 +750,18 @@ interface DictionaryDefinitionBase {
   supportNonStrictSearches?: boolean | undefined;
 }
 interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
-  /** Path to the file. */
+  /**
+  * Path or url to the dictionary file.
+  */
   path: DictionaryPath;
   /**
+  * An alternative path to a bTrie dictionary file.
+  * It will be used in place of `path` if the version of CSpell being used
+  * supports btrie files.
+  * @since 9.6.0
+  */
+  btrie?: DictionaryPathToBTrie | undefined;
+  /**
   * Only for legacy dictionary definitions.
   * @deprecated true
   * @deprecationMessage Use {@link path} instead.
@@ -760,10 +769,25 @@ interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
   */
   file?: undefined;
 }
+interface HiddenPaths {
+  /**
+  * @hide
+  */
+  path?: string | undefined;
+  /**
+  * @hide
+  */
+  btrie?: string | undefined;
+  /**
+  * @hide
+  */
+  file?: undefined;
+}
+interface DictionaryDefinitionBaseWithPathsHidden extends DictionaryDefinitionBase, HiddenPaths {}
 /**
 * An Empty Dictionary Definition
 */
-interface DictionaryDefinitionSimple extends DictionaryDefinitionBase {
+interface DictionaryDefinitionSimple extends DictionaryDefinitionBaseWithPathsHidden {
   /**
   * @hide
   */
@@ -784,14 +808,6 @@ interface DictionaryDefinitionSimple extends DictionaryDefinitionBase {
   * @hide
   */
   type?: DictionaryFileTypes | undefined;
-  /**
-  * @hide
-  */
-  path?: string | undefined;
-  /**
-  * @hide
-  */
-  file?: undefined;
 }
 /**
 * Used to provide extra data related to the dictionary
@@ -809,6 +825,11 @@ interface HiddenFields {
   * Not used
   * @hide
   */
+  btrie?: string | undefined;
+  /**
+  * Not used
+  * @hide
+  */
   file?: undefined;
   /**
   * Not used
@@ -862,12 +883,9 @@ type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDe
 * Only for legacy dictionary definitions.
 * @deprecated true
 * @deprecationMessage Use {@link DictionaryDefinitionPreferred} instead.
+* This will be removed in a future release.
 */
-interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
-  /**
-  * @hidden
-  */
-  path?: undefined;
+interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase, Omit<HiddenPaths, "file"> {
   /**
   * Path to the file, only for legacy dictionary definitions.
   * @deprecated true
@@ -881,9 +899,11 @@ interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
 }
 /**
 * @deprecated true
+* @deprecationMessage Use {@link DictionaryDefinitionPreferred} instead.
+* This will be removed in a future release.
 * @hidden
 */
-interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
+interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase, Omit<HiddenPaths, "file" | "path"> {
   /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
   path?: FsDictionaryPath;
   /**
@@ -922,7 +942,9 @@ type CustomDictionaryScope = "user" | "workspace" | "folder";
 * Note: only plain text files with one word per line are supported at this moment.
 */
 interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
-  /** Path to custom dictionary text file. */
+  /**
+  * A file path or url to a custom dictionary file.
+  */
   path: CustomDictionaryPath;
   /**
   * Defines the scope for when words will be added to the dictionary.
@@ -956,13 +978,19 @@ type ReplaceMap = ReplaceEntry[];
 type FsDictionaryPath = string;
 /**
 * A File System Path to a dictionary file.
-* Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$`
+* Pattern: `^.*\.(?:txt|trie|btrie|dic)(?:\.gz)?$`
 */
 type DictionaryPath = string;
 /**
 * A File System Path to a dictionary file.
+* Pattern: `^.*\.(?:btrie)(?:\.gz)?$`
+* @since 9.6.0
+*/
+type DictionaryPathToBTrie = string;
+/**
+* A path or url to a custom dictionary file.
 */
-type CustomDictionaryPath = FsDictionaryPath;
+type CustomDictionaryPath = string;
 /**
 * Reference to a dictionary by name.
 * One of:

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.4.0",
+  "version": "9.6.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -86,5 +86,5 @@
     "node": ">=20"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "12dba3d8b880384d1401c765cb2186647f5a266f"
+  "gitHead": "163793ddf2a0ad90bc7c90351698a106003297af"
 }

package/dist/index-BtvDF-9G.d.ts

@@ -1,129 +0,0 @@
-//#region src/Parser/index.d.ts
-type ParserOptions = Record<string, unknown>;
-type ParserName = string;
-interface Parser {
-  /** Name of parser */
-  readonly name: ParserName;
-  /**
-  * Parse Method
-  * @param content - full content of the file
-  * @param filename - filename
-  */
-  parse(content: string, filename: string): ParseResult;
-}
-interface ParseResult {
-  readonly content: string;
-  readonly filename: string;
-  readonly parsedTexts: Iterable<ParsedText>;
-}
-interface ParsedText {
-  /**
-  * The text extracted and possibly transformed
-  */
-  readonly text: string;
-  /**
-  * The raw text before it has been transformed
-  */
-  readonly rawText?: string | undefined;
-  /**
-  * start and end offsets of the text
-  */
-  readonly range: Range;
-  /**
-  * The Scope annotation for a segment of text.
-  * Used by the spell checker to apply spell checking options
-  * based upon the value of the scope.
-  */
-  readonly scope?: Scope | undefined;
-  /**
-  * The source map is used to support text transformations.
-  *
-  * See: {@link SourceMap}
-  */
-  readonly map?: SourceMap | undefined;
-  /**
-  * Used to delegate parsing the contents of `text` to another parser.
-  *
-  */
-  readonly delegate?: DelegateInfo | undefined;
-}
-/**
-* A SourceMap is used to map transform a piece of text back to its original text.
-* This is necessary in order to report the correct location of a spelling issue.
-* An empty source map indicates that it was a 1:1 transformation.
-*
-* The values in a source map are number pairs (even, odd) relative to the beginning of each
-* string segment.
-* - even - offset in the source text
-* - odd - offset in the transformed text
-*
-* Offsets start a 0
-*
-* Example:
-*
-* - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
-* - Transformed text: `Grand Café Bjørvika`
-* - Map: [9, 9, 15, 10, 18, 13, 24, 14]
-*
-* | offset | original    | offset | transformed |
-* | ------ | ----------- | ------ | ----------- |
-* | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
-* | 9-15   | `\u00e9`    | 9-10   | `é`         |
-* | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
-* | 18-24  | `\u00f8`    | 13-14  | `ø`         |
-* | 24-29  | `rvika`     | 14-19  | `rvika`     |
-*
-* <!--- cspell:ignore Bjørvika rvika --->
-*/
-type SourceMap = number[];
-type Range = readonly [start: number, end: number];
-/**
-* DelegateInfo is used by a parser to delegate parsing a subsection of a document to
-* another parser. The following information is used by the spell checker to match
-* the parser.
-*/
-interface DelegateInfo {
-  /**
-  * Proposed virtual file name including the extension.
-  * Format: `./${source_filename}/${block_number}.${ext}
-  * Example: `./README.md/1.js`
-  */
-  readonly filename: string;
-  /**
-  * The filename of the origin of the virtual file block.
-  * Example: `./README.md`
-  */
-  readonly originFilename: string;
-  /**
-  * Proposed file extension
-  * Example: `.js`
-  */
-  readonly extension: string;
-  /**
-  * Filetype to use
-  * Example: `javascript`
-  */
-  readonly fileType?: string;
-}
-/**
-* Scope - chain of scope going from local to global
-*
-* Example:
-* ```
-* `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
-* ```
-*/
-interface ScopeChain {
-  readonly value: string;
-  readonly parent?: ScopeChain | undefined;
-}
-/**
-* A string representing a scope chain separated by spaces
-*
-* Example: `comment.block.documentation.ts meta.interface.ts source.ts`
-*/
-type ScopeString = string;
-type Scope = ScopeChain | ScopeString;
-//#endregion
-export { ParserName as a, Scope as c, SourceMap as d, Parser as i, ScopeChain as l, ParseResult as n, ParserOptions as o, ParsedText as r, Range as s, DelegateInfo as t, ScopeString as u };
-//# sourceMappingURL=index-BtvDF-9G.d.ts.map

package/dist/index-TAd2zi6U.d.mts

@@ -1,129 +0,0 @@
-//#region src/Parser/index.d.ts
-type ParserOptions = Record<string, unknown>;
-type ParserName = string;
-interface Parser {
-  /** Name of parser */
-  readonly name: ParserName;
-  /**
-  * Parse Method
-  * @param content - full content of the file
-  * @param filename - filename
-  */
-  parse(content: string, filename: string): ParseResult;
-}
-interface ParseResult {
-  readonly content: string;
-  readonly filename: string;
-  readonly parsedTexts: Iterable<ParsedText>;
-}
-interface ParsedText {
-  /**
-  * The text extracted and possibly transformed
-  */
-  readonly text: string;
-  /**
-  * The raw text before it has been transformed
-  */
-  readonly rawText?: string | undefined;
-  /**
-  * start and end offsets of the text
-  */
-  readonly range: Range;
-  /**
-  * The Scope annotation for a segment of text.
-  * Used by the spell checker to apply spell checking options
-  * based upon the value of the scope.
-  */
-  readonly scope?: Scope | undefined;
-  /**
-  * The source map is used to support text transformations.
-  *
-  * See: {@link SourceMap}
-  */
-  readonly map?: SourceMap | undefined;
-  /**
-  * Used to delegate parsing the contents of `text` to another parser.
-  *
-  */
-  readonly delegate?: DelegateInfo | undefined;
-}
-/**
-* A SourceMap is used to map transform a piece of text back to its original text.
-* This is necessary in order to report the correct location of a spelling issue.
-* An empty source map indicates that it was a 1:1 transformation.
-*
-* The values in a source map are number pairs (even, odd) relative to the beginning of each
-* string segment.
-* - even - offset in the source text
-* - odd - offset in the transformed text
-*
-* Offsets start a 0
-*
-* Example:
-*
-* - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
-* - Transformed text: `Grand Café Bjørvika`
-* - Map: [9, 9, 15, 10, 18, 13, 24, 14]
-*
-* | offset | original    | offset | transformed |
-* | ------ | ----------- | ------ | ----------- |
-* | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
-* | 9-15   | `\u00e9`    | 9-10   | `é`         |
-* | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
-* | 18-24  | `\u00f8`    | 13-14  | `ø`         |
-* | 24-29  | `rvika`     | 14-19  | `rvika`     |
-*
-* <!--- cspell:ignore Bjørvika rvika --->
-*/
-type SourceMap = number[];
-type Range = readonly [start: number, end: number];
-/**
-* DelegateInfo is used by a parser to delegate parsing a subsection of a document to
-* another parser. The following information is used by the spell checker to match
-* the parser.
-*/
-interface DelegateInfo {
-  /**
-  * Proposed virtual file name including the extension.
-  * Format: `./${source_filename}/${block_number}.${ext}
-  * Example: `./README.md/1.js`
-  */
-  readonly filename: string;
-  /**
-  * The filename of the origin of the virtual file block.
-  * Example: `./README.md`
-  */
-  readonly originFilename: string;
-  /**
-  * Proposed file extension
-  * Example: `.js`
-  */
-  readonly extension: string;
-  /**
-  * Filetype to use
-  * Example: `javascript`
-  */
-  readonly fileType?: string;
-}
-/**
-* Scope - chain of scope going from local to global
-*
-* Example:
-* ```
-* `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
-* ```
-*/
-interface ScopeChain {
-  readonly value: string;
-  readonly parent?: ScopeChain | undefined;
-}
-/**
-* A string representing a scope chain separated by spaces
-*
-* Example: `comment.block.documentation.ts meta.interface.ts source.ts`
-*/
-type ScopeString = string;
-type Scope = ScopeChain | ScopeString;
-//#endregion
-export { ParserName as a, Scope as c, SourceMap as d, Parser as i, ScopeChain as l, ParseResult as n, ParserOptions as o, ParsedText as r, Range as s, DelegateInfo as t, ScopeString as u };
-//# sourceMappingURL=index-TAd2zi6U.d.mts.map