@cspell/cspell-types - npm Package Compare versions

Comparing version 8.8.0 to 8.8.1

dist/configFields.js

@@ -14,2 +14,3 @@ "use strict";
     enableFiletypes: 'enableFiletypes',
+    enabledFileTypes: 'enabledFileTypes',
     enableGlobDot: 'enableGlobDot',
@@ -16,0 +17,0 @@ failFast: 'failFast',

dist/CSpellSettingsDef.d.ts

@@ -163,16 +163,8 @@ import type { ReporterConfigurationBase } from './CSpellReporter.js';
 }
-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[];
@@ -182,7 +174,8 @@ /**
      *
-     * 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**
+     *
      * ```
@@ -193,3 +186,10 @@ * jsonc       // enable checking for jsonc
      * ```
-     * @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
@@ -200,2 +200,38 @@ * @uniqueItems true
     /**
+     * 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.
@@ -202,0 +238,0 @@ *

package.json

@@ -6,3 +6,3 @@ {
   },
-  "version": "8.8.0",
+  "version": "8.8.1",
   "description": "Types for cspell and cspell-lib",
@@ -90,3 +90,3 @@ "type": "commonjs",
   },
-  "gitHead": "a42bce675c00cb2d51809b3ae3894119ea4f5ce7"
+  "gitHead": "6381846ffce8b9a349bfda03262297aa8e301ef5"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

200916

increased by2.66%

Lines of code

3960

increased by1.62%

No dependency changes