@cspell/cspell-types 5.13.4 → 5.14.0-alpha.0

package/cspell.schema.json

@@ -32,22 +32,22 @@
     "DictionaryDefinitionAlternate": {
       "additionalProperties": false,
       "deprecated": true,
-      "deprecationMessage": "Use `DictionaryDefinitionPreferred`",
-      "description": "Only for legacy dictionary definitions",
+      "deprecationMessage": "Use `DictionaryDefinitionPreferred` instead.",
+      "description": "Only for legacy dictionary definitions.",
       "properties": {
         "description": {
-          "description": "Optional description",
+          "description": "Optional description.",
           "type": "string"
         },
         "file": {
           "$ref": "#/definitions/DictionaryPath",
           "deprecated": true,
           "deprecationMessage": "Use `path` instead.",
-          "description": "Path to the file, only for legacy dictionary definitions"
+          "description": "Path to the file, only for legacy dictionary definitions."
         },
         "name": {
           "$ref": "#/definitions/DictionaryId",
-          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`"
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
         },
         "noSuggest": {
           "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
@@ -55,15 +55,15 @@
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
-          "description": "Replacement pairs"
+          "description": "Replacement pairs."
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
-          "description": "Use Compounds",
+          "description": "Use Compounds.",
           "type": "boolean"
         }
       },
@@ -82,12 +82,12 @@
           "type": "boolean"
         },
         "description": {
-          "description": "Optional description",
+          "description": "Optional description.",
           "type": "string"
         },
         "name": {
           "$ref": "#/definitions/DictionaryId",
-          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`"
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
         },
         "noSuggest": {
           "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
@@ -99,7 +99,7 @@
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
-          "description": "Replacement pairs"
+          "description": "Replacement pairs."
         },
         "scope": {
           "anyOf": [
@@ -113,15 +113,15 @@
               "type": "array"
             }
           ],
-          "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`"
+          "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
-          "description": "Use Compounds",
+          "description": "Use Compounds.",
           "type": "boolean"
         }
       },
@@ -136,12 +136,12 @@
       "additionalProperties": false,
       "properties": {
         "description": {
-          "description": "Optional description",
+          "description": "Optional description.",
           "type": "string"
         },
         "name": {
           "$ref": "#/definitions/DictionaryId",
-          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`"
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
         },
         "noSuggest": {
           "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
@@ -149,19 +149,19 @@
         },
         "path": {
           "$ref": "#/definitions/DictionaryPath",
-          "description": "Path to the file"
+          "description": "Path to the file."
         },
         "repMap": {
           "$ref": "#/definitions/ReplaceMap",
-          "description": "Replacement pairs"
+          "description": "Replacement pairs."
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
-          "description": "Use Compounds",
+          "description": "Use Compounds.",
           "type": "boolean"
         }
       },
@@ -181,12 +181,12 @@
       "type": "string"
     },
     "DictionaryId": {
-      "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`",
+      "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
       "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
       "type": "string"
     },
     "DictionaryNegRef": {
-      "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`    Overrides `!!<dictionary_name>`.",
+      "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.",
       "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
       "type": "string"
     },
@@ -211,12 +211,12 @@
       "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
     },
     "FsPath": {
-      "description": "A File System Path",
+      "description": "A File System Path.",
       "type": "string"
     },
     "Glob": {
       "$ref": "#/definitions/SimpleGlob",
-      "description": "These are glob expressions"
+      "description": "These are glob expressions."
     },
     "LanguageId": {
       "anyOf": [
@@ -260,7 +260,7 @@
           "type": "boolean"
         },
         "description": {
-          "description": "Optional description of configuration",
+          "description": "Optional description of configuration.",
           "type": "string"
         },
         "dictionaries": {
@@ -271,7 +271,7 @@
           "type": "array"
         },
         "dictionaryDefinitions": {
-          "description": "Define additional available dictionaries",
+          "description": "Define additional available dictionaries.",
           "items": {
             "$ref": "#/definitions/DictionaryDefinition"
           },
@@ -279,23 +279,23 @@
         },
         "enabled": {
           "default": true,
-          "description": "Is the spell checker enabled",
+          "description": "Is the spell checker enabled.",
           "type": "boolean"
         },
         "flagWords": {
-          "description": "list of words to always be considered incorrect.",
+          "description": "List of words to always be considered incorrect.",
           "items": {
             "type": "string"
           },
           "type": "array"
         },
         "id": {
-          "description": "Optional identifier",
+          "description": "Optional identifier.",
           "type": "string"
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href"
+          "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href."
         },
         "ignoreWords": {
           "description": "List of words to be ignored. An Ignored word will not show up as an error even if it is also in the `flagWords`.",
@@ -320,7 +320,7 @@
               "type": "array"
             }
           ],
-          "description": "The language id.  Ex: \"typescript\", \"html\", or \"php\".  \"*\" -- will match all languages"
+          "description": "The language id.  Ex: \"typescript\", \"html\", or \"php\".  \"*\" -- will match all languages."
         },
         "local": {
           "anyOf": [
@@ -335,7 +335,7 @@
             }
           ],
           "deprecated": true,
-          "deprecationMessage": "Use `locale` instead",
+          "deprecationMessage": "Use `locale` instead.",
           "description": "Deprecated - The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
         },
         "locale": {
@@ -353,7 +353,7 @@
           "description": "The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
         },
         "name": {
-          "description": "Optional name of configuration",
+          "description": "Optional name of configuration.",
           "type": "string"
         },
         "noSuggestDictionaries": {
@@ -364,14 +364,14 @@
           "type": "array"
         },
         "patterns": {
-          "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList",
+          "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList.",
           "items": {
             "$ref": "#/definitions/RegExpPatternDefinition"
           },
           "type": "array"
         },
         "words": {
-          "description": "list of words to be always considered correct",
+          "description": "List of words to be always considered correct.",
           "items": {
             "type": "string"
           },
@@ -401,7 +401,7 @@
           "type": "boolean"
         },
         "description": {
-          "description": "Optional description of configuration",
+          "description": "Optional description of configuration.",
           "type": "string"
         },
         "dictionaries": {
@@ -412,7 +412,7 @@
           "type": "array"
         },
         "dictionaryDefinitions": {
-          "description": "Define additional available dictionaries",
+          "description": "Define additional available dictionaries.",
           "items": {
             "$ref": "#/definitions/DictionaryDefinition"
           },
@@ -430,7 +430,7 @@
         },
         "enabled": {
           "default": true,
-          "description": "Is the spell checker enabled",
+          "description": "Is the spell checker enabled.",
           "type": "boolean"
         },
         "enabledLanguageIds": {
@@ -452,22 +452,22 @@
               "type": "array"
             }
           ],
-          "description": "Glob pattern or patterns to match against"
+          "description": "Glob pattern or patterns to match against."
         },
         "flagWords": {
-          "description": "list of words to always be considered incorrect.",
+          "description": "List of words to always be considered incorrect.",
           "items": {
             "type": "string"
           },
           "type": "array"
         },
         "id": {
-          "description": "Optional identifier",
+          "description": "Optional identifier.",
           "type": "string"
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href"
+          "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href."
         },
         "ignoreWords": {
           "description": "List of words to be ignored. An Ignored word will not show up as an error even if it is also in the `flagWords`.",
@@ -482,11 +482,11 @@
         },
         "language": {
           "$ref": "#/definitions/LocaleId",
-          "description": "Sets the locale"
+          "description": "Sets the locale."
         },
         "languageId": {
           "$ref": "#/definitions/LanguageId",
-          "description": "Sets the programming language id"
+          "description": "Sets the programming language id."
         },
         "languageSettings": {
           "description": "Additional settings for individual languages.",
@@ -511,7 +511,7 @@
           "type": "number"
         },
         "name": {
-          "description": "Optional name of configuration",
+          "description": "Optional name of configuration.",
           "type": "string"
         },
         "noSuggestDictionaries": {
@@ -523,11 +523,11 @@
         },
         "numSuggestions": {
           "default": 10,
-          "description": "Number of suggestions to make",
+          "description": "Number of suggestions to make.",
           "type": "number"
         },
         "patterns": {
-          "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList",
+          "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList.",
           "items": {
             "$ref": "#/definitions/RegExpPatternDefinition"
           },
@@ -560,7 +560,7 @@
           "type": "boolean"
         },
         "words": {
-          "description": "list of words to be always considered correct",
+          "description": "List of words to be always considered correct.",
           "items": {
             "type": "string"
           },
@@ -576,7 +576,7 @@
       "type": "string"
     },
     "PatternId": {
-      "description": "This matches the name in a pattern definition",
+      "description": "This matches the name in a pattern definition.",
       "type": "string"
     },
     "PatternRef": {
@@ -645,7 +645,7 @@
               "type": "array"
             }
           ],
-          "description": "RegExp pattern or array of RegExp patterns"
+          "description": "RegExp pattern or array of RegExp patterns."
         }
       },
       "required": [
@@ -655,7 +655,7 @@
       "type": "object"
     },
     "RegExpPatternList": {
-      "description": "A list of pattern names or regular expressions",
+      "description": "A list of pattern names or regular expressions.",
       "items": {
         "$ref": "#/definitions/PatternRef"
       },
@@ -700,10 +700,10 @@
           "type": "array"
         }
       ],
-      "description": "reporter name or reporter name + reporter config"
+      "description": "Reporter name or reporter name + reporter config."
     },
     "SimpleGlob": {
-      "description": "Simple Glob string, the root will be globRoot",
+      "description": "Simple Glob string, the root will be globRoot.",
       "type": "string"
     },
     "Version": {
@@ -718,14 +718,14 @@
     },
     "VersionLatest": {
       "const": "0.2",
-      "description": "Configuration File Version",
+      "description": "Configuration File Version.",
       "type": "string"
     },
     "VersionLegacy": {
       "const": "0.1",
       "deprecated": true,
-      "deprecationMessage": "Use `0.2`",
-      "description": "Legacy Configuration File Versions",
+      "deprecationMessage": "Use `0.2` instead.",
+      "description": "Legacy Configuration File Versions.",
       "type": "string"
     }
   },
@@ -744,7 +744,7 @@
       "type": "boolean"
     },
     "description": {
-      "description": "Optional description of configuration",
+      "description": "Optional description of configuration.",
       "type": "string"
     },
     "dictionaries": {
@@ -755,7 +755,7 @@
       "type": "array"
     },
     "dictionaryDefinitions": {
-      "description": "Define additional available dictionaries",
+      "description": "Define additional available dictionaries.",
       "items": {
         "$ref": "#/definitions/DictionaryDefinition"
       },
@@ -778,7 +778,7 @@
     },
     "enabled": {
       "default": true,
-      "description": "Is the spell checker enabled",
+      "description": "Is the spell checker enabled.",
       "type": "boolean"
     },
     "enabledLanguageIds": {
@@ -796,7 +796,7 @@
       "type": "array"
     },
     "flagWords": {
-      "description": "list of words to always be considered incorrect.",
+      "description": "List of words to always be considered incorrect.",
       "items": {
         "type": "string"
       },
@@ -818,14 +818,14 @@
     },
     "globRoot": {
       "$ref": "#/definitions/FsPath",
-      "description": "The root to use for glop 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."
+      "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."
     },
     "id": {
-      "description": "Optional identifier",
+      "description": "Optional identifier.",
       "type": "string"
     },
     "ignorePaths": {
-      "description": "Glob patterns of files to be ignored Glob patterns are relative to the `globRoot` of the configuration file that defines them.",
+      "description": "Glob patterns of files to be ignored. Glob patterns are relative to the `globRoot` of the configuration file that defines them.",
       "items": {
         "$ref": "#/definitions/Glob"
       },
@@ -833,7 +833,7 @@
     },
     "ignoreRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
-      "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href"
+      "description": "List of RegExp patterns or Pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href."
     },
     "ignoreWords": {
       "description": "List of words to be ignored. An Ignored word will not show up as an error even if it is also in the `flagWords`.",
@@ -854,7 +854,7 @@
           "type": "array"
         }
       ],
-      "description": "Other settings files to be included"
+      "description": "Other settings files to be included."
     },
     "includeRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
@@ -863,7 +863,7 @@
     "language": {
       "$ref": "#/definitions/LocaleId",
       "default": "en",
-      "description": "Current active spelling language.\n\nExample: \"en-GB\" for British English\n\nExample: \"en,nl\" to enable both English and Dutch"
+      "description": "Current active spelling language.\n\nExample: \"en-GB\" for British English.\n\nExample: \"en,nl\" to enable both English and Dutch."
     },
     "languageId": {
       "$ref": "#/definitions/LanguageId",
@@ -892,7 +892,7 @@
       "type": "number"
     },
     "name": {
-      "description": "Optional name of configuration",
+      "description": "Optional name of configuration.",
       "type": "string"
     },
     "noConfigSearch": {
@@ -909,7 +909,7 @@
     },
     "numSuggestions": {
       "default": 10,
-      "description": "Number of suggestions to make",
+      "description": "Number of suggestions to make.",
       "type": "number"
     },
     "overrides": {
@@ -920,7 +920,7 @@
       "type": "array"
     },
     "patterns": {
-      "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList",
+      "description": "Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList.",
       "items": {
         "$ref": "#/definitions/RegExpPatternDefinition"
       },
@@ -943,7 +943,7 @@
       "type": "boolean"
     },
     "reporters": {
-      "description": "Custom reporters configuration",
+      "description": "Custom reporters configuration.",
       "items": {
         "$ref": "#/definitions/ReporterSettings"
       },
@@ -951,7 +951,7 @@
     },
     "showStatus": {
       "deprecated": true,
-      "description": "Show status",
+      "description": "Show status.",
       "type": "boolean"
     },
     "spellCheckDelayMs": {
@@ -992,7 +992,7 @@
       "description": "Configuration format version of the settings file."
     },
     "words": {
-      "description": "list of words to be always considered correct",
+      "description": "List of words to be always considered correct.",
       "items": {
         "type": "string"
       },

package/dist/CSpellSettingsDef.d.ts

@@ -26,10 +26,10 @@ export interface FileSettings extends ExtendableSettings {
     version?: Version;
     /** Words to add to global dictionary -- should only be in the user config file. */
     userWords?: string[];
-    /** Other settings files to be included */
+    /** Other settings files to be included. */
     import?: FsPath | FsPath[];
     /**
-     * The root to use for glop patterns found in this configuration.
+     * 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}`.
@@ -57,7 +57,7 @@ export interface FileSettings extends ExtendableSettings {
      */
     enableGlobDot?: boolean;
     /**
-     * Glob patterns of files to be ignored
+     * Glob patterns of files to be ignored.
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
      */
     ignorePaths?: Glob[];
@@ -74,7 +74,7 @@ export interface FileSettings extends ExtendableSettings {
      */
     readonly?: boolean;
     /**
-     * Custom reporters configuration
+     * Custom reporters configuration.
      */
     reporters?: ReporterSettings[];
     /**
@@ -95,9 +95,9 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
     /**
      * Current active spelling language.
      *
-     * Example: "en-GB" for British English
+     * Example: "en-GB" for British English.
      *
-     * Example: "en,nl" to enable both English and Dutch
+     * Example: "en,nl" to enable both English and Dutch.
      * @default "en"
      */
     language?: LocaleId;
@@ -144,7 +144,7 @@ export interface ReportingConfiguration extends SuggestionsConfiguration {
 }
 export interface SuggestionsConfiguration {
     /**
-     * Number of suggestions to make
+     * Number of suggestions to make.
      * @default 10
      */
     numSuggestions?: number;
@@ -195,27 +195,27 @@ export interface PnPSettings {
  */
 export interface WorkspaceTrustSettings {
     /**
-     * Glob patterns of locations that contain ALWAYS trusted files
+     * Glob patterns of locations that contain ALWAYS trusted files.
      */
     trustedFiles?: Glob[];
     /**
-     * Glob patterns of locations that contain NEVER trusted files
+     * Glob patterns of locations that contain NEVER trusted files.
      */
     untrustedFiles?: Glob[];
     /**
-     * Sets the default trust level
+     * Sets the default trust level.
      * @default "trusted"
      */
     trustLevel?: TrustLevel;
 }
 /**
- * VS Code Spell Checker Settings
- * To be Removed
+ * VS Code Spell Checker Settings.
+ * To be Removed.
  * @deprecated true
  */
 export interface LegacySettings {
     /**
-     * Show status
+     * Show status.
      * @deprecated true
      */
     showStatus?: boolean;
@@ -226,30 +226,30 @@ export interface LegacySettings {
     spellCheckDelayMs?: number;
 }
 export interface OverrideSettings extends Settings, OverrideFilterFields {
-    /** Sets the programming language id */
+    /** Sets the programming language id. */
     languageId?: LanguageId;
-    /** Sets the locale */
+    /** Sets the locale. */
     language?: LocaleId;
 }
 export interface OverrideFilterFields {
-    /** Glob pattern or patterns to match against */
+    /** Glob pattern or patterns to match against. */
     filename: Glob | Glob[];
 }
 export interface BaseSetting {
-    /** Optional identifier */
+    /** Optional identifier. */
     id?: string;
-    /** Optional name of configuration */
+    /** Optional name of configuration. */
     name?: string;
-    /** Optional description of configuration */
+    /** Optional description of configuration. */
     description?: string;
     /**
-     * Is the spell checker enabled
+     * Is the spell checker enabled.
      * @default true
      */
     enabled?: boolean;
-    /** list of words to be always considered correct */
+    /** List of words to be always considered correct. */
     words?: string[];
-    /** list of words to always be considered incorrect. */
+    /** List of words to always be considered incorrect. */
     flagWords?: string[];
     /** List of words to be ignored. An Ignored word will not show up as an error even if it is also in the `flagWords`. */
     ignoreWords?: string[];
@@ -268,7 +268,7 @@ export interface BaseSetting {
      * @default false
      */
     caseSensitive?: boolean;
-    /** Define additional available dictionaries */
+    /** Define additional available dictionaries. */
     dictionaryDefinitions?: DictionaryDefinition[];
     /**
      * Optional list of dictionaries to use.
@@ -290,7 +290,7 @@ export interface BaseSetting {
     /**
      * List of RegExp patterns or Pattern names to exclude from spell checking.
      *
-     * Example: ["href"] - to exclude html href
+     * Example: ["href"] - to exclude html href.
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
@@ -298,7 +298,7 @@ export interface BaseSetting {
      * If includeRegExpList is defined, ONLY, text matching the included patterns will be checked.
      */
     includeRegExpList?: RegExpPatternList;
-    /** Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList */
+    /** Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList. */
     patterns?: RegExpPatternDefinition[];
 }
 export declare type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
@@ -309,17 +309,17 @@ export interface DictionaryDefinitionBase {
      *
      * Name Format:
      * - Must contain at least 1 number or letter.
-     * - spaces are allowed.
+     * - Spaces are allowed.
      * - Leading and trailing space will be removed.
-     * - Names ARE case-sensitive
-     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`
+     * - Names ARE case-sensitive.
+     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
      */
     name: DictionaryId;
-    /** Optional description */
+    /** Optional description. */
     description?: string;
-    /** Replacement pairs */
+    /** Replacement pairs. */
     repMap?: ReplaceMap;
-    /** Use Compounds */
+    /** Use Compounds. */
     useCompounds?: boolean;
     /**
      * Indicate that suggestions should not come from this dictionary.
@@ -335,18 +335,18 @@ export interface DictionaryDefinitionBase {
      * Type of file:
      * S - single word per line,
      * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed)
-     * Default is S
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
      * @default "S"
      */
     type?: DictionaryFileTypes;
 }
 export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
-    /** Path to the file */
+    /** Path to the file. */
     path: DictionaryPath;
     /**
-     * Only for legacy dictionary definitions
+     * Only for legacy dictionary definitions.
      * @deprecated true
      * @deprecationMessage Use `path` instead.
      * @hidden
@@ -354,15 +354,15 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
     file?: undefined;
 }
 /**
- * Only for legacy dictionary definitions
+ * Only for legacy dictionary definitions.
  * @deprecated true
- * @deprecationMessage Use `DictionaryDefinitionPreferred`
+ * @deprecationMessage Use `DictionaryDefinitionPreferred` instead.
  */
 export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
     /** @hidden */
     path?: undefined;
     /**
-     * Path to the file, only for legacy dictionary definitions
+     * Path to the file, only for legacy dictionary definitions.
      * @deprecated true
      * @deprecationMessage Use `path` instead.
      */
@@ -373,20 +373,20 @@ export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase
  * @hidden
  */
 export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
-    /** Path to the file, if undefined the path to the extension dictionaries is assumed */
+    /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
     path?: FsPath;
     /**
-     * File name
+     * File name.
      * @deprecated true
-     * @deprecationMessage Use path instead.
+     * @deprecationMessage Use `path` instead.
      */
     file: FsPath;
     /**
      * Type of file:
      * S - single word per line,
      * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed)
-     * Default is S
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
      * @default "S"
      */
@@ -408,7 +408,7 @@ export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferre
     path: CustomDictionaryPath;
     /**
      * Defines the scope for when words will be added to the dictionary.
-     * Scope values: `user`, `workspace`, `folder`
+     * Scope values: `user`, `workspace`, `folder`.
      */
     scope?: CustomDictionaryScope | CustomDictionaryScope[];
     /**
@@ -421,18 +421,18 @@ export interface LanguageSetting extends LanguageSettingFilterFields, BaseSettin
 export interface LanguageSettingFilterFields extends LanguageSettingFilterFieldsPreferred, LanguageSettingFilterFieldsDeprecated {
 }
 export interface LanguageSettingFilterFieldsPreferred {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
+    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
     languageId: LanguageId | LanguageIdSingle[];
     /** The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. */
     locale?: LocaleId | LocaleId[];
 }
 export interface LanguageSettingFilterFieldsDeprecated {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
+    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
     languageId: LanguageId | LanguageIdSingle[];
     /**
      * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
      * @deprecated true
-     * @deprecationMessage Use `locale` instead
+     * @deprecationMessage Use `locale` instead.
      */
     local?: LocaleId | LocaleId[];
 }
@@ -440,21 +440,21 @@ export interface LanguageSettingFilterFieldsDeprecated {
 declare type InternalRegExp = RegExp;
 export declare type Pattern = string | InternalRegExp;
 export declare type PredefinedPatterns = 'Base64' | 'CStyleComment' | 'CStyleHexValue' | 'CSSHexValue' | 'CommitHash' | 'CommitHashLink' | 'Email' | 'EscapeCharacters' | 'HexValues' | 'href' | 'PhpHereDoc' | 'PublicKey' | 'RsaCert' | 'SHA' | 'SpellCheckerDisable' | 'SpellCheckerDisableBlock' | 'SpellCheckerDisableLine' | 'SpellCheckerDisableNext' | 'SpellCheckerIgnoreInDocSetting' | 'string' | 'UnicodeRef' | 'Urls' | 'UUID' | 'Everything';
-/** This matches the name in a pattern definition */
+/** This matches the name in a pattern definition. */
 export declare type PatternId = string;
 /** A PatternRef is a Pattern or PatternId. */
 export declare type PatternRef = Pattern | PatternId | PredefinedPatterns;
-/** A list of pattern names or regular expressions */
+/** A list of pattern names or regular expressions. */
 export declare type RegExpPatternList = PatternRef[];
 /**
  * This is the name of a dictionary.
  *
  * Name Format:
  * - Must contain at least 1 number or letter.
- * - spaces are allowed.
+ * - Spaces are allowed.
  * - Leading and trailing space will be removed.
- * - Names ARE case-sensitive
- * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`
+ * - Names ARE case-sensitive.
+ * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
  *
  * @pattern ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
@@ -470,10 +470,10 @@ export declare type DictionaryRef = DictionaryId;
  * It is used to exclude or include a dictionary by name.
  *
  * The reference starts with 1 or more `!`.
- * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`
- * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`
+ * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
+ * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.
  *    Overrides `!<dictionary_name>`.
- * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`
+ * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.
  *    Overrides `!!<dictionary_name>`.
  *
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
@@ -489,24 +489,24 @@ export declare type DictionaryReference = DictionaryRef | DictionaryNegRef;
 /** This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. */
 export declare type LocaleId = string;
 /**
- * Configuration File Version
+ * Configuration File Version.
  */
 export declare type VersionLatest = '0.2';
 /**
- * Legacy Configuration File Versions
+ * Legacy Configuration File Versions.
  * @deprecated true
- * @deprecationMessage Use `0.2`
+ * @deprecationMessage Use `0.2` instead.
  */
 export declare type VersionLegacy = '0.1';
 export declare type Version = VersionLatest | VersionLegacy;
 /**
  * @deprecated true
- * @deprecationMessage Use LocaleId instead
+ * @deprecationMessage Use `LocaleId` instead.
  */
 export declare type LocalId = LocaleId;
-/** These are glob expressions */
+/** These are glob expressions. */
 export declare type Glob = SimpleGlob | GlobDef;
-/** Simple Glob string, the root will be globRoot */
+/** Simple Glob string, the root will be globRoot. */
 export declare type SimpleGlob = string;
 /**
  * Used to define fully qualified glob patterns.
@@ -515,7 +515,7 @@ export declare type SimpleGlob = string;
  * @hidden
  */
 export interface GlobDef {
-    /** Glob pattern to match */
+    /** Glob pattern to match. */
     glob: string;
     /** Optional root to use when matching the glob. Defaults to current working dir. */
     root?: string;
@@ -541,9 +541,9 @@ export declare type LanguageIdMultiple = string;
  */
 export declare type LanguageIdMultipleNeg = string;
 export declare type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
-/** A File System Path */
+/** A File System Path. */
 export declare type FsPath = string;
-/** Trust Security Level */
+/** Trust Security Level. */
 export declare type TrustLevel = 'trusted' | 'untrusted';
 /**
  * A File System Path to a dictionary file.
@@ -562,7 +562,7 @@ export interface RegExpPatternDefinition {
      */
     name: PatternId;
     /**
-     * RegExp pattern or array of RegExp patterns
+     * RegExp pattern or array of RegExp patterns.
      */
     pattern: Pattern | Pattern[];
     /**
@@ -573,47 +573,47 @@ export interface RegExpPatternDefinition {
 export declare type CSpellUserSettingsWithComments = CSpellUserSettings;
 export declare type Source = FileSource | MergeSource | InMemorySource | BaseSource;
 export interface FileSource extends BaseSource {
-    /** name of source */
+    /** Name of source. */
     name: string;
-    /** filename if this came from a file. */
+    /** Filename if this came from a file. */
     filename: string;
-    /** The two settings that were merged to */
+    /** The two settings that were merged to. */
     sources?: undefined;
     /** The configuration read. */
     fileSource: CSpellSettings;
 }
 export interface MergeSource extends BaseSource {
-    /** name of source */
+    /** Name of source. */
     name: string;
-    /** filename if this came from a file. */
+    /** Filename if this came from a file. */
     filename?: undefined;
-    /** The two settings that were merged to */
+    /** The two settings that were merged to. */
     sources: [CSpellSettings] | [CSpellSettings, CSpellSettings];
     /** The configuration read. */
     fileSource?: undefined;
 }
 export interface InMemorySource extends BaseSource {
-    /** name of source */
+    /** Name of source. */
     name: string;
-    /** filename if this came from a file. */
+    /** Filename if this came from a file. */
     filename?: undefined;
-    /** The two settings that were merged to */
+    /** The two settings that were merged to. */
     sources?: undefined;
     /** The configuration read. */
     fileSource?: undefined;
 }
 interface BaseSource {
-    /** name of source */
+    /** Name of source. */
     name: string;
-    /** filename if this came from a file. */
+    /** Filename if this came from a file. */
     filename?: string | undefined;
-    /** The two settings that were merged to */
+    /** The two settings that were merged to. */
     sources?: [CSpellSettings] | [CSpellSettings, CSpellSettings] | undefined;
     /** The configuration read. */
     fileSource?: CSpellSettings | undefined;
 }
 /**
- * reporter name or reporter name + reporter config
+ * Reporter name or reporter name + reporter config.
  */
 export declare type ReporterSettings = string | [string] | [string, unknown];
 export {};

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.13.4",
+  "version": "5.14.0-alpha.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -56,5 +56,5 @@
     "typedoc-plugin-markdown": "^3.11.8",
     "typescript": "^4.5.4"
   },
-  "gitHead": "cf6ef9e6137af46d1a7ebd83600c05a4892c4814"
+  "gitHead": "bb136daa99b18e826a5e720ad1dfba94caa1e16e"
 }