@cspell/cspell-types 9.1.3 → 9.2.0

package/dist/index.d.mts

@@ -327,7 +327,6 @@ interface UnknownWordsConfiguration {
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
-// cspell:ignore aeiouy
 /**
 * A WeightedMapDef enables setting weights for edits between related characters and substrings.
 *
@@ -467,7 +466,6 @@ interface DictionaryInformation {
   */
   ignore?: CharacterSet;
 }
-// cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ aàâä eéèêë iîïy
 interface HunspellInformation {
   /**
   * Selected Hunspell AFF content.
@@ -496,7 +494,6 @@ interface HunspellInformation {
   /** The costs to apply when using the hunspell settings */
   costs?: HunspellCosts;
 }
-// cspell:ignore OCONV
 /**
 * Selected Hunspell AFF content.
 * The content must be UTF-8
@@ -636,7 +633,6 @@ interface InlineDictionary {
   * List of words to be considered correct.
   */
   words?: string[];
-  // cspell:ignore colour color canot incase
   /**
   * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
   *
@@ -1154,14 +1150,13 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   */
   features?: Features;
 }
-/* eslint-disable no-irregular-whitespace */
 /**
 * In the below JSDoc comment, we helpfully specify an example configuration for the end-user to
 * reference. And this example will get captured by the automatic documentation generator.
 *
 * However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the
 * same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in
-* between the "*" and the "/" symbols.
+* between the "*" and the "/" symbols. The zero-width space is automatically removed by the schema generator.
 */
 interface ExtendableSettings extends Settings {
   /**
@@ -1187,16 +1182,12 @@ interface ExtendableSettings extends Settings {
   overrides?: OverrideSettings[];
 }
 interface SpellCheckerExtensionSettings {
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * 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
   */
   enabledLanguageIds?: LanguageIdSingle[];
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Enable / Disable checking file types (languageIds).
   *
@@ -1311,7 +1302,6 @@ interface CacheSettings {
   * @default false
   */
   useCache?: boolean;
-  // cspell:word cspellcache
   /**
   * Path to the cache location. Can be a file or a directory.
   * If none specified `.cspellcache` will be used.
@@ -1649,7 +1639,6 @@ interface RegExpPatternDefinition {
   description?: string | undefined;
 }
 type CSpellUserSettingsWithComments = CSpellUserSettings;
-// Remove BaseSource from the Source list when the code is ready.
 type Source = FileSource | MergeSource | InMemorySource | BaseSource;
 interface FileSource extends BaseSource {
   /** Name of source. */
@@ -1803,5 +1792,5 @@ interface TransformedText extends PartialOrUndefined<Mapped> {
 }
 type PartialOrUndefined<T> = { [P in keyof T]?: T[P] | undefined };
 //#endregion
-export { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CSpellPackageSettings, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, ConfigFields, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, IssueType, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, MessageTypes, OverrideFilterFields, OverrideSettings, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, Source, SpellingErrorEmitter, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, unknownWordsChoices };
+export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type Source, type SpellingErrorEmitter, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, unknownWordsChoices };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -327,7 +327,6 @@ interface UnknownWordsConfiguration {
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
-// cspell:ignore aeiouy
 /**
 * A WeightedMapDef enables setting weights for edits between related characters and substrings.
 *
@@ -467,7 +466,6 @@ interface DictionaryInformation {
   */
   ignore?: CharacterSet;
 }
-// cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ aàâä eéèêë iîïy
 interface HunspellInformation {
   /**
   * Selected Hunspell AFF content.
@@ -496,7 +494,6 @@ interface HunspellInformation {
   /** The costs to apply when using the hunspell settings */
   costs?: HunspellCosts;
 }
-// cspell:ignore OCONV
 /**
 * Selected Hunspell AFF content.
 * The content must be UTF-8
@@ -636,7 +633,6 @@ interface InlineDictionary {
   * List of words to be considered correct.
   */
   words?: string[];
-  // cspell:ignore colour color canot incase
   /**
   * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
   *
@@ -1154,14 +1150,13 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   */
   features?: Features;
 }
-/* eslint-disable no-irregular-whitespace */
 /**
 * In the below JSDoc comment, we helpfully specify an example configuration for the end-user to
 * reference. And this example will get captured by the automatic documentation generator.
 *
 * However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the
 * same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in
-* between the "*" and the "/" symbols.
+* between the "*" and the "/" symbols. The zero-width space is automatically removed by the schema generator.
 */
 interface ExtendableSettings extends Settings {
   /**
@@ -1187,16 +1182,12 @@ interface ExtendableSettings extends Settings {
   overrides?: OverrideSettings[];
 }
 interface SpellCheckerExtensionSettings {
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * 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
   */
   enabledLanguageIds?: LanguageIdSingle[];
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Enable / Disable checking file types (languageIds).
   *
@@ -1311,7 +1302,6 @@ interface CacheSettings {
   * @default false
   */
   useCache?: boolean;
-  // cspell:word cspellcache
   /**
   * Path to the cache location. Can be a file or a directory.
   * If none specified `.cspellcache` will be used.
@@ -1649,7 +1639,6 @@ interface RegExpPatternDefinition {
   description?: string | undefined;
 }
 type CSpellUserSettingsWithComments = CSpellUserSettings;
-// Remove BaseSource from the Source list when the code is ready.
 type Source = FileSource | MergeSource | InMemorySource | BaseSource;
 interface FileSource extends BaseSource {
   /** Name of source. */
@@ -1803,5 +1792,5 @@ interface TransformedText extends PartialOrUndefined<Mapped> {
 }
 type PartialOrUndefined<T> = { [P in keyof T]?: T[P] | undefined };
 //#endregion
-export { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CSpellPackageSettings, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, ConfigFields, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, IssueType, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, MessageTypes, OverrideFilterFields, OverrideSettings, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, Source, SpellingErrorEmitter, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, unknownWordsChoices };
+export { type AdvancedCSpellSettings, type AdvancedCSpellSettingsWithSourceTrace, type BaseSetting, type CSpellPackageSettings, type CSpellReporter, type CSpellReporterEmitters, type CSpellReporterModule, type CSpellSettings, type CSpellSettingsWithSourceTrace, type CSpellUserSettings, type CSpellUserSettingsFields, type CSpellUserSettingsWithComments, type CacheFormat, type CacheSettings, type CacheStrategy, type CharacterSet, type CharacterSetCosts, type CommandLineSettings, ConfigFields, type CustomDictionaryPath, type CustomDictionaryScope, type DebugEmitter, type DictionaryDefinition, type DictionaryDefinitionAlternate, type DictionaryDefinitionAugmented, type DictionaryDefinitionBase, type DictionaryDefinitionCustom, type DictionaryDefinitionInline, type DictionaryDefinitionInlineFlagWords, type DictionaryDefinitionInlineIgnoreWords, type DictionaryDefinitionInlineWords, type DictionaryDefinitionLegacy, type DictionaryDefinitionPreferred, type DictionaryDefinitionSimple, type DictionaryFileTypes, type DictionaryId, type DictionaryInformation, type DictionaryNegRef, type DictionaryPath, type DictionaryRef, type DictionaryReference, type EditCosts, type ErrorEmitter, type ErrorLike, type ExperimentalBaseSettings, type ExperimentalFileSettings, type ExtendableSettings, type FSPathResolvable, type Feature, type Features, type FeaturesSupportedByReporter, type FileSettings, type FileSource, type FsPath, type Glob, type GlobDef, type ImportFileRef, type InMemorySource, type Issue, IssueType, type LanguageId, type LanguageIdMultiple, type LanguageIdMultipleNeg, type LanguageIdSingle, type LanguageSetting, type LanguageSettingFilterFields, type LanguageSettingFilterFieldsDeprecated, type LanguageSettingFilterFieldsPreferred, type LegacySettings, type LocalId, type LocaleId, type MappedText, type MatchingFileType, type MergeSource, type MessageEmitter, type MessageType, type MessageTypeLookup, MessageTypes, type OverrideFilterFields, type OverrideSettings, type ParseResult, type ParsedText, type Parser, type ParserName, type ParserOptions, type Pattern, type PatternId, type PatternRef, type Plugin, type PnPSettings, type PredefinedPatterns, type ProgressBase, type ProgressEmitter, type ProgressFileBase, type ProgressFileBegin, type ProgressFileComplete, type ProgressItem, type ProgressTypes, type RegExpPatternDefinition, type RegExpPatternList, type ReplaceEntry, type ReplaceMap, type ReportIssueOptions, type ReporterConfiguration, type ReporterSettings, type ReportingConfiguration, type ResultEmitter, type RunResult, type Settings, type SimpleGlob, type Source, type SpellingErrorEmitter, type SuggestionCostMapDef, type SuggestionCostsDefs, type SuggestionsConfiguration, type TextDocumentOffset, type TextOffset, type TrustLevel, type UnknownWordsChoices, type UnknownWordsConfiguration, type Version, type VersionLatest, type VersionLegacy, type WorkspaceTrustSettings, defaultCSpellSettings, defineConfig, unknownWordsChoices };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.1.3",
+  "version": "9.2.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -86,5 +86,5 @@
     "node": ">=20"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "cfa9ab3d0b5dc82afc488a6bf86a23e3a2afc077"
+  "gitHead": "6004e6a19e11985bc61e6578846195be07365049"
 }