@cspell/cspell-types 8.7.0 → 8.8.1

package/cspell.schema.json

@@ -1191,13 +1191,13 @@
           "type": "array"
         },
         "enableFiletypes": {
-          "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample: ``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```",
+          "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
           "items": {
             "$ref": "#/definitions/LanguageIdSingle"
           },
-          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
+          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
           "scope": "resource",
-          "title": "File Types to Check",
+          "title": "Enable File Types",
           "type": "array",
           "uniqueItems": true
         },
@@ -1207,13 +1207,24 @@
           "markdownDescription": "Is the spell checker enabled.",
           "type": "boolean"
         },
+        "enabledFileTypes": {
+          "additionalProperties": {
+            "type": "boolean"
+          },
+          "description": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces:  {@link  Settings.enabledLanguageIds }  and  {@link  Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*`       | `true`  | Enable all file types. | | `json`    | `false` | Disable checking for json files. |",
+          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces:  {@link  Settings.enabledLanguageIds }  and  {@link  Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*`       | `true`  | Enable all file types. |\n| `json`    | `false` | Disable checking for json files. |",
+          "title": "Enabled File Types to Check",
+          "type": "object"
+        },
         "enabledLanguageIds": {
-          "description": "languageIds for the files to spell check.",
+          "description": "Specify a list of file types to spell check. It is better to use  {@link  Settings.enabledFileTypes }  to Enable / Disable checking files types.",
           "items": {
             "$ref": "#/definitions/LanguageIdSingle"
           },
-          "markdownDescription": "languageIds for the files to spell check.",
-          "type": "array"
+          "markdownDescription": "Specify a list of file types to spell check. It is better to use  {@link  Settings.enabledFileTypes }  to Enable / Disable checking files types.",
+          "title": "Enabled Language Ids",
+          "type": "array",
+          "uniqueItems": true
         },
         "filename": {
           "anyOf": [
@@ -1680,13 +1691,13 @@
       "type": "array"
     },
     "enableFiletypes": {
-      "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample: ``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```",
+      "description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc       // enable checking for jsonc !json       // disable checking for json kotlin      // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types !json       // except for json ```",
       "items": {
         "$ref": "#/definitions/LanguageIdSingle"
       },
-      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
+      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by  {@link  Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n*           // enable checking for all file types\n!json       // except for json\n```",
       "scope": "resource",
-      "title": "File Types to Check",
+      "title": "Enable File Types",
       "type": "array",
       "uniqueItems": true
     },
@@ -1702,13 +1713,24 @@
       "markdownDescription": "Is the spell checker enabled.",
       "type": "boolean"
     },
+    "enabledFileTypes": {
+      "additionalProperties": {
+        "type": "boolean"
+      },
+      "description": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces:  {@link  Settings.enabledLanguageIds }  and  {@link  Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*`       | `true`  | Enable all file types. | | `json`    | `false` | Disable checking for json files. |",
+      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces:  {@link  Settings.enabledLanguageIds }  and  {@link  Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*`       | `true`  | Enable all file types. |\n| `json`    | `false` | Disable checking for json files. |",
+      "title": "Enabled File Types to Check",
+      "type": "object"
+    },
     "enabledLanguageIds": {
-      "description": "languageIds for the files to spell check.",
+      "description": "Specify a list of file types to spell check. It is better to use  {@link  Settings.enabledFileTypes }  to Enable / Disable checking files types.",
       "items": {
         "$ref": "#/definitions/LanguageIdSingle"
       },
-      "markdownDescription": "languageIds for the files to spell check.",
-      "type": "array"
+      "markdownDescription": "Specify a list of file types to spell check. It is better to use  {@link  Settings.enabledFileTypes }  to Enable / Disable checking files types.",
+      "title": "Enabled Language Ids",
+      "type": "array",
+      "uniqueItems": true
     },
     "failFast": {
       "default": false,

package/dist/CSpellSettingsDef.d.ts

@@ -125,7 +125,7 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /**
      * Configure CSpell features.
      *
-     * @version 5.16.0
+     * @since 5.16.0
      */
     features?: Features;
 }
@@ -160,39 +160,75 @@ export interface ExtendableSettings extends Settings {
      */
     overrides?: OverrideSettings[];
 }
-export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings {
+export interface SpellCheckerExtensionSettings {
     /**
-     * Current active spelling language. This specifies the language locale to use in choosing the
-     * general dictionary.
-     *
-     * For example:
-     *
-     * - "en-GB" for British English.
-     * - "en,nl" to enable both English and Dutch.
-     *
-     * @default "en"
+     * Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes} to Enable / Disable checking files types.
+     * @title Enabled Language Ids
+     * @uniqueItems true
      */
-    language?: LocaleId;
-    /** languageIds for the files to spell check. */
     enabledLanguageIds?: LanguageIdSingle[];
     /**
      * Enable / Disable checking file types (languageIds).
      *
-     * These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
-     *
+     * These are in additional to the file types specified by {@link Settings.enabledLanguageIds}.
      * To disable a language, prefix with `!` as in `!json`,
      *
-     * Example:
+     *
+     * **Example: individual file types**
+     *
      * ```
      * jsonc       // enable checking for jsonc
      * !json       // disable checking for json
      * kotlin      // enable checking for kotlin
      * ```
-     * @title File Types to Check
+     *
+     * **Example: enable all file types**
+     *
+     * ```
+     * *           // enable checking for all file types
+     * !json       // except for json
+     * ```
+     * @title Enable File Types
      * @scope resource
      * @uniqueItems true
      */
     enableFiletypes?: LanguageIdSingle[];
+    /**
+     * Enable / Disable checking file types (languageIds).
+     *
+     * This setting replaces: {@link Settings.enabledLanguageIds} and {@link Settings.enableFiletypes}.
+     *
+     * A Value of:
+     * - `true` - enable checking for the file type
+     * - `false` - disable checking for the file type
+     *
+     * A file type of `*` is a wildcard that enables all file types.
+     *
+     * **Example: enable all file types**
+     *
+     * | File Type | Enabled | Comment |
+     * | --------- | ------- | ------- |
+     * | `*`       | `true`  | Enable all file types. |
+     * | `json`    | `false` | Disable checking for json files. |
+     *
+     * @title Enabled File Types to Check
+     * @since 8.8.1
+     */
+    enabledFileTypes?: Record<string, boolean>;
+}
+export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings, SpellCheckerExtensionSettings {
+    /**
+     * Current active spelling language. This specifies the language locale to use in choosing the
+     * general dictionary.
+     *
+     * For example:
+     *
+     * - "en-GB" for British English.
+     * - "en,nl" to enable both English and Dutch.
+     *
+     * @default "en"
+     */
+    language?: LocaleId;
     /**
      * Additional settings for individual languages.
      *
@@ -672,7 +708,7 @@ export interface ExperimentalFileSettings {
     /**
      * Future Plugin support
      * @experimental
-     * @version 6.2.0
+     * @since 6.2.0
      */
     plugins?: Plugin[];
 }
@@ -694,14 +730,14 @@ export interface ExperimentalBaseSettings {
     /**
      * Parser to use for the file content
      * @experimental
-     * @version 6.2.0
+     * @since 6.2.0
      */
     parser?: ParserName;
 }
 /**
  * Plugin API
  * @experimental
- * @version 6.2.0
+ * @since 6.2.0
  */
 export interface Plugin {
     parsers?: Parser[];

package/dist/DictionaryDefinition.d.ts

@@ -90,7 +90,7 @@ export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinit
 }
 /**
  * Inline Dictionary Definitions
- * @version 6.23.0
+ * @since 6.23.0
  */
 export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
 /**

package/dist/DictionaryInformation.d.ts

@@ -198,11 +198,15 @@ export interface CharacterSetCosts {
      */
     penalty?: number;
 }
+/**
+ * @hidden
+ */
+export type IRegExp = RegExp;
 export interface PatternAdjustment {
     /** Id of the Adjustment, i.e. `short-compound` */
     id: string;
     /** RegExp pattern to match */
-    regexp: string | RegExp;
+    regexp: string | IRegExp;
     /** The amount of penalty to apply. */
     penalty: number;
 }

package/dist/configFields.js

@@ -11,6 +11,7 @@ exports.ConfigFields = {
     enabled: 'enabled',
     enabledLanguageIds: 'enabledLanguageIds',
     enableFiletypes: 'enableFiletypes',
+    enabledFileTypes: 'enabledFileTypes',
     enableGlobDot: 'enableGlobDot',
     failFast: 'failFast',
     features: 'features',

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "8.7.0",
+  "version": "8.8.1",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "5318079ed11fe77e981287ecf1c40d6f28dd91ed"
+  "gitHead": "6381846ffce8b9a349bfda03262297aa8e301ef5"
 }