@cspell/cspell-types 9.6.3 → 9.7.0

package/cspell.schema.json

@@ -1319,6 +1319,18 @@
           "markdownDescription": "Defines a list of patterns that can be used with the  {@link  ignoreRegExpList }  and\n {@link  includeRegExpList }  options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n  {\n    \"name\": \"comment-single-line\",\n    \"pattern\": \"/#.*/g\"\n  },\n  {\n    \"name\": \"comment-multi-line\",\n    \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n  },\n  // You can also combine multiple named patterns into one single named pattern\n  {\n    \"name\": \"comments\",\n    \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n  }\n]\n```",
           "type": "array"
         },
+        "substitutionDefinitions": {
+          "$ref": "#/definitions/SubstitutionDefinitions",
+          "description": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+          "markdownDescription": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+          "since": "9.7.0"
+        },
+        "substitutions": {
+          "$ref": "#/definitions/Substitutions",
+          "description": "The set of substitutions to apply to a document before spell checking.",
+          "markdownDescription": "The set of substitutions to apply to a document before spell checking.",
+          "since": "9.7.0"
+        },
         "suggestWords": {
           "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
           "items": {
@@ -1587,6 +1599,18 @@
           "markdownDescription": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
           "type": "array"
         },
+        "substitutionDefinitions": {
+          "$ref": "#/definitions/SubstitutionDefinitions",
+          "description": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+          "markdownDescription": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+          "since": "9.7.0"
+        },
+        "substitutions": {
+          "$ref": "#/definitions/Substitutions",
+          "description": "The set of substitutions to apply to a document before spell checking.",
+          "markdownDescription": "The set of substitutions to apply to a document before spell checking.",
+          "since": "9.7.0"
+        },
         "suggestWords": {
           "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
           "items": {
@@ -1845,6 +1869,84 @@
       "markdownDescription": "Simple Glob string, the root will be globRoot.",
       "type": "string"
     },
+    "SubstitutionDefinition": {
+      "additionalProperties": false,
+      "description": "Allows for the definition of a substitution set. A substitution set is a collection of substitution entries that can be applied to a document before spell checking. This is useful for converting html entities, url encodings, or other transformations that may be necessary to get the correct text for spell checking.\n\nSubstitutions are applied based upon the longest matching find string. If there are multiple matches of the same `find`, the last one in the list is used. This allows for the overriding of substitutions. For example, if you have a substitution for `&` to `and`, and then a substitution for `&` to `&`, the `&` substitution will be used for the string `&`, and the `&` substitution will be used for the string `&`.",
+      "markdownDescription": "Allows for the definition of a substitution set. A substitution set is a collection of substitution\nentries that can be applied to a document before spell checking. This is useful for converting html entities, url encodings,\nor other transformations that may be necessary to get the correct text for spell checking.\n\nSubstitutions are applied based upon the longest matching find string. If there are multiple matches of the same `find`,\nthe last one in the list is used. This allows for the overriding of substitutions. For example, if you have a substitution\nfor `&` to `and`, and then a substitution for `&` to `&`, the `&` substitution will be used for the string `&`,\nand the `&` substitution will be used for the string `&`.",
+      "properties": {
+        "description": {
+          "description": "An optional description of the substitution definition. This is not used for anything, but can be useful for documentation purposes.",
+          "markdownDescription": "An optional description of the substitution definition. This is not used for anything, but can be useful for\ndocumentation purposes.",
+          "type": "string"
+        },
+        "entries": {
+          "description": "The entries for the substitution definition. This is a collection of substitution entries that can be applied to a document before spell checking.",
+          "items": {
+            "$ref": "#/definitions/SubstitutionEntry"
+          },
+          "markdownDescription": "The entries for the substitution definition. This is a collection of substitution entries that can be applied to a\ndocument before spell checking.",
+          "type": "array"
+        },
+        "name": {
+          "$ref": "#/definitions/SubstitutionID",
+          "description": "The name of the substitution definition. This is used to reference the substitution definition in the substitutions array.",
+          "markdownDescription": "The name of the substitution definition. This is used to reference the substitution definition in the substitutions array."
+        }
+      },
+      "required": [
+        "name",
+        "entries"
+      ],
+      "since": "9.7.0",
+      "type": "object"
+    },
+    "SubstitutionDefinitions": {
+      "description": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+      "items": {
+        "$ref": "#/definitions/SubstitutionDefinition"
+      },
+      "markdownDescription": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document\nbefore spell checking.",
+      "type": "array"
+    },
+    "SubstitutionEntry": {
+      "description": "A substitution entry is a tuple of the form `[find, replacement]`. The find string is the string to find, and the replacement string is the string to replace it with.\n\n- `find` - The string to find. This is the string that will be replaced in the text. Only an exact match will be replaced.   The find string is not treated as a regular expression.\n- `replacement` - The string to replace the `find` string with. This is the string that will be used to replace the `find`   string in the text.",
+      "items": [
+        {
+          "title": "find",
+          "type": "string"
+        },
+        {
+          "title": "replacement",
+          "type": "string"
+        }
+      ],
+      "markdownDescription": "A substitution entry is a tuple of the form `[find, replacement]`. The find string is the string to find,\nand the replacement string is the string to replace it with.\n\n- `find` - The string to find. This is the string that will be replaced in the text. Only an exact match will be replaced.\n  The find string is not treated as a regular expression.\n- `replacement` - The string to replace the `find` string with. This is the string that will be used to replace the `find`\n  string in the text.",
+      "maxItems": 2,
+      "minItems": 2,
+      "since": "9.7.0",
+      "type": "array"
+    },
+    "SubstitutionID": {
+      "description": "The ID for a substitution definition. This is used to reference the substitution definition in the substitutions array.",
+      "markdownDescription": "The ID for a substitution definition. This is used to reference the substitution definition in the substitutions array.",
+      "since": "9.7.0",
+      "type": "string"
+    },
+    "Substitutions": {
+      "description": "The set of substitutions to apply to a document before spell checking. This is a collection of substitution entries that can be applied to a document before spell checking.",
+      "items": {
+        "anyOf": [
+          {
+            "$ref": "#/definitions/SubstitutionEntry"
+          },
+          {
+            "$ref": "#/definitions/SubstitutionID"
+          }
+        ]
+      },
+      "markdownDescription": "The set of substitutions to apply to a document before spell checking.\nThis is a collection of substitution entries that can be applied to a document before spell checking.",
+      "type": "array"
+    },
     "SuggestionCostMapDef": {
       "anyOf": [
         {
@@ -2236,6 +2338,18 @@
       "markdownDescription": "Delay in ms after a document has changed before checking it for spelling errors.",
       "type": "number"
     },
+    "substitutionDefinitions": {
+      "$ref": "#/definitions/SubstitutionDefinitions",
+      "description": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+      "markdownDescription": "The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.",
+      "since": "9.7.0"
+    },
+    "substitutions": {
+      "$ref": "#/definitions/Substitutions",
+      "description": "The set of substitutions to apply to a document before spell checking.",
+      "markdownDescription": "The set of substitutions to apply to a document before spell checking.",
+      "since": "9.7.0"
+    },
     "suggestWords": {
       "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
       "items": {

package/dist/Parser/index.d.mts

@@ -1,129 +1,2 @@
-//#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
+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 "../TextMap-Cs2Bypvi.mjs";
+export { type DelegateInfo, type MappedText, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Range, type Scope, type ScopeChain, type ScopeString, type SourceMap };

package/dist/Parser/index.d.ts

@@ -1,129 +1,2 @@
-//#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
+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 "../TextMap-B1Fq1qVW.js";
+export { type DelegateInfo, type MappedText, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Range, type Scope, type ScopeChain, type ScopeString, type SourceMap };

package/dist/TextMap-B1Fq1qVW.d.ts

@@ -0,0 +1,176 @@
+//#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.
+* An empty source map indicates that it was a 1:1 transformation.
+*
+* Non-1:1 transformations are considered to be a single segment and cannot be split.
+*
+* A partial index into a non-linear segment will get mapped to the start of the segment.
+*
+* To signal a non-1:1 transformation a 0,0 pair can be used in the source map. This indicates that the
+* following segment is a non-linear transformation and should not be split.
+*
+* This is important when multiple transformations have been applied to the same text, and the source map
+* is being used to map back to the original text.
+*
+* For example: `\u00e9` might be transformed to `é` in one transformation and then to HTML entity `é`.
+* The resulting sourceMap would be `[..., 0, 0, 6, 6, ...]` to indicate that the 6 character segment should
+* not be split when mapping back to the original text.
+*
+* The values in a source map are number pairs (even, odd) relative to the beginning of each
+* string segment.
+* - even - span length in the source text
+* - odd - span length in the transformed text
+*
+* Offsets start at 0
+*
+* Example:
+*
+* - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
+* - Transformed text: `Grand Café Bjørvika`
+* - Map: [9, 9, 6, 1, 3, 3, 6, 1, 5, 5]
+*
+* | offset | span | original    | offset | span | transformed |
+* | ------ | ---- | ----------- | ------ | ---- | ----------- |
+* | 0-9    |    9 | `Grand Caf` | 0-9    |    9 | `Grand Caf` |
+* | 9-15   |    6 | `\u00e9`    | 9-10   |    1 | `é`         |
+* | 15-18  |    3 | ` Bj`       | 10-13  |    3 | ` Bj`       |
+* | 18-24  |    6 | `\u00f8`    | 13-14  |    1 | `ø`         |
+* | 24-29  |    5 | `rvika`     | 14-19  |    5 | `rvika`     |
+*
+* Note: The trailing 5,5 is not necessary since it is a 1:1 mapping, but it is included for clarity.
+*
+* <!--- cspell:ignore Bjørvika rvika --->
+*/
+type SourceMap = number[];
+/**
+* A range of text in a document.
+* The range is inclusive of the start and exclusive of the end.
+*/
+type Range = readonly [start: number, end: number];
+//#endregion
+//#region src/Parser/Mapped.d.ts
+interface Mapped {
+  /**
+  * The absolute start and end offset of the text in the source.
+  */
+  range: Range;
+  /**
+  * `(i, j)` number pairs where
+  * - `i` is the offset in the source relative to the start of the range
+  * - `j` is the offset in the transformed destination
+  *
+  * Example:
+  * - source text = `"caf\xe9"`
+  * - mapped text = `"café"`
+  * - map = `[3, 3, 4, 1]`
+  *
+  * See: {@link SourceMap}
+  *
+  */
+  map?: SourceMap | undefined;
+}
+//#endregion
+//#region src/Parser/parser.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 extends Readonly<Mapped> {
+  /**
+  * The text extracted and possibly transformed
+  */
+  readonly text: string;
+  /**
+  * The raw text before it has been transformed
+  */
+  readonly rawText?: string | undefined;
+  /**
+  * 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;
+  /**
+  * Used to delegate parsing the contents of `text` to another parser.
+  *
+  */
+  readonly delegate?: DelegateInfo | undefined;
+}
+/**
+* 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
+//#region src/Parser/TextMap.d.ts
+type MappedText = Readonly<TransformedText>;
+interface TransformedText extends Mapped {
+  /**
+  * Transformed text with an optional map.
+  */
+  text: string;
+  /**
+  * The original text
+  */
+  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=TextMap-B1Fq1qVW.d.ts.map