@cspell/cspell-types 6.30.2 → 6.31.0

package/cspell.schema.json

@@ -913,17 +913,7 @@
           "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
         },
         "languageId": {
-          "anyOf": [
-            {
-              "$ref": "#/definitions/LanguageId"
-            },
-            {
-              "items": {
-                "$ref": "#/definitions/LanguageIdSingle"
-              },
-              "type": "array"
-            }
-          ],
+          "$ref": "#/definitions/MatchingFileType",
           "description": "The language id.  Ex: \"typescript\", \"html\", or \"php\".  \"*\" -- will match all languages."
         },
         "local": {
@@ -998,6 +988,19 @@
       "description": "This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.",
       "type": "string"
     },
+    "MatchingFileType": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/LanguageId"
+        },
+        {
+          "items": {
+            "$ref": "#/definitions/LanguageId"
+          },
+          "type": "array"
+        }
+      ]
+    },
     "OverrideSettings": {
       "additionalProperties": false,
       "properties": {
@@ -1096,8 +1099,8 @@
           "description": "Sets the locale."
         },
         "languageId": {
-          "$ref": "#/definitions/LanguageId",
-          "description": "Sets the programming language id."
+          "$ref": "#/definitions/MatchingFileType",
+          "description": "Sets the programming language id to match file type."
         },
         "languageSettings": {
           "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
@@ -1583,7 +1586,7 @@
       "description": "Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch."
     },
     "languageId": {
-      "$ref": "#/definitions/LanguageId",
+      "$ref": "#/definitions/MatchingFileType",
       "description": "Forces the spell checker to assume a give language id. Used mainly as an Override."
     },
     "languageSettings": {

package/dist/cjs/CSpellSettingsDef.d.ts

@@ -198,7 +198,7 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
-    languageId?: LanguageId;
+    languageId?: MatchingFileType;
     /**
      * By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
      * will prevent ALL default configuration from being loaded.
@@ -345,8 +345,8 @@ export interface LegacySettings {
     spellCheckDelayMs?: number;
 }
 export interface OverrideSettings extends Settings, OverrideFilterFields {
-    /** Sets the programming language id. */
-    languageId?: LanguageId;
+    /** Sets the programming language id to match file type. */
+    languageId?: MatchingFileType;
     /** Sets the locale. */
     language?: LocaleId;
 }
@@ -470,13 +470,13 @@ export interface LanguageSettingFilterFields extends LanguageSettingFilterFields
 }
 export interface LanguageSettingFilterFieldsPreferred {
     /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /** 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. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /**
      * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
      * @deprecated true
@@ -549,6 +549,7 @@ export type LanguageIdMultiple = string;
  */
 export type LanguageIdMultipleNeg = string;
 export type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
+export type MatchingFileType = LanguageId | LanguageId[];
 /**
  * A File System Path. Relative paths are relative to the configuration file.
  */

package/dist/cjs/index.d.ts

@@ -2,7 +2,7 @@ export type { CSpellUserSettingsFields } from './configFields.js';
 export { ConfigFields } from './configFields.js';
 export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ReporterConfiguration, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.js';
 export { IssueType, MessageTypes } from './CSpellReporter.js';
-export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
+export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MatchingFileType, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
 export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.js';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.js';
 export type { Feature, Features } from './features.js';

package/dist/esm/CSpellSettingsDef.d.mts

@@ -198,7 +198,7 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
-    languageId?: LanguageId;
+    languageId?: MatchingFileType;
     /**
      * By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
      * will prevent ALL default configuration from being loaded.
@@ -345,8 +345,8 @@ export interface LegacySettings {
     spellCheckDelayMs?: number;
 }
 export interface OverrideSettings extends Settings, OverrideFilterFields {
-    /** Sets the programming language id. */
-    languageId?: LanguageId;
+    /** Sets the programming language id to match file type. */
+    languageId?: MatchingFileType;
     /** Sets the locale. */
     language?: LocaleId;
 }
@@ -470,13 +470,13 @@ export interface LanguageSettingFilterFields extends LanguageSettingFilterFields
 }
 export interface LanguageSettingFilterFieldsPreferred {
     /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /** 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. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /**
      * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
      * @deprecated true
@@ -549,6 +549,7 @@ export type LanguageIdMultiple = string;
  */
 export type LanguageIdMultipleNeg = string;
 export type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
+export type MatchingFileType = LanguageId | LanguageId[];
 /**
  * A File System Path. Relative paths are relative to the configuration file.
  */

package/dist/esm/CSpellSettingsDef.d.ts

@@ -198,7 +198,7 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
-    languageId?: LanguageId;
+    languageId?: MatchingFileType;
     /**
      * By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
      * will prevent ALL default configuration from being loaded.
@@ -345,8 +345,8 @@ export interface LegacySettings {
     spellCheckDelayMs?: number;
 }
 export interface OverrideSettings extends Settings, OverrideFilterFields {
-    /** Sets the programming language id. */
-    languageId?: LanguageId;
+    /** Sets the programming language id to match file type. */
+    languageId?: MatchingFileType;
     /** Sets the locale. */
     language?: LocaleId;
 }
@@ -470,13 +470,13 @@ export interface LanguageSettingFilterFields extends LanguageSettingFilterFields
 }
 export interface LanguageSettingFilterFieldsPreferred {
     /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /** 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. */
-    languageId: LanguageId | LanguageIdSingle[];
+    languageId: MatchingFileType;
     /**
      * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
      * @deprecated true
@@ -549,6 +549,7 @@ export type LanguageIdMultiple = string;
  */
 export type LanguageIdMultipleNeg = string;
 export type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
+export type MatchingFileType = LanguageId | LanguageId[];
 /**
  * A File System Path. Relative paths are relative to the configuration file.
  */

package/dist/esm/index.d.mts

@@ -2,7 +2,7 @@ export type { CSpellUserSettingsFields } from './configFields.mjs';
 export { ConfigFields } from './configFields.mjs';
 export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ReporterConfiguration, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.mjs';
 export { IssueType, MessageTypes } from './CSpellReporter.mjs';
-export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.mjs';
+export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MatchingFileType, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.mjs';
 export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.mjs';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.mjs';
 export type { Feature, Features } from './features.mjs';

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@ export type { CSpellUserSettingsFields } from './configFields.js';
 export { ConfigFields } from './configFields.js';
 export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ReporterConfiguration, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.js';
 export { IssueType, MessageTypes } from './CSpellReporter.js';
-export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
+export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MatchingFileType, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
 export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.js';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.js';
 export type { Feature, Features } from './features.js';

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.30.2",
+  "version": "6.31.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "./dist/cjs/index.js",
@@ -90,5 +90,5 @@
     "ts-json-schema-generator": "^1.2.0",
     "typescript": "^4.9.5"
   },
-  "gitHead": "4da6895c680084f3b741ad24a73c5bb011a57b35"
+  "gitHead": "1c0c3eb875bc1aab334bd56d952c0d0964468b7a"
 }