@cspell/cspell-types 8.8.0 → 8.8.2

package/README.md

@@ -6,18 +6,19 @@ This package contains no dependencies to avoid any security issues.
 
 ## Support Future Development
 
-- Become a [<img src="https://github.githubassets.com/images/modules/site/icons/funding_platforms/patreon.svg" width="16" height="16" alt="Patreon">Patreon!](https://patreon.com/streetsidesoftware)
+<!--- @@inject: ../../static/sponsor.md --->
 
-## cspell for enterprise
+- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](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)
+- [![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)
 
-Available as part of the Tidelift Subscription.
-
-The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
+<!--- @@inject-end: ../../static/sponsor.md --->
 
 ## Installation
 
 ```
-npm i -SD @cspell/cspell-types
+npm i -S @cspell/cspell-types
 ```
 
 ## Usage
@@ -75,10 +76,6 @@ The maintainers of cspell and thousands of other packages are working with Tidel
 
 ---
 
-<p align="center">
-Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
-<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
-</a>
-</p>
+<p align="center">Brought to you by<a href="https://streetsidesoftware.com" title="Street Side Software"><img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software</a></p>
 
 <!--- @@inject-end: ../../static/footer.md --->

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

@@ -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.
      *

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.8.0",
+  "version": "8.8.2",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "a42bce675c00cb2d51809b3ae3894119ea4f5ce7"
+  "gitHead": "e82ec807677c040c38b7d5608c8a8d42185d3b24"
 }