@cspell/cspell-types 10.4.0-alpha.1 → 10.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cspell.schema.json +4 -4
- package/dist/index.d.mts +21 -13
- package/dist/index.d.ts +21 -13
- package/package.json +2 -2
package/cspell.schema.json
CHANGED
|
@@ -929,8 +929,8 @@
|
|
|
929
929
|
},
|
|
930
930
|
"DictionaryInformation": {
|
|
931
931
|
"additionalProperties": false,
|
|
932
|
-
"description": "
|
|
933
|
-
"markdownDescription": "
|
|
932
|
+
"description": "Provides extra information about the dictionary.\n\nIt is used to improve suggestions and casing rules.\n\nAdded with `v5.16.0`.",
|
|
933
|
+
"markdownDescription": "Provides extra information about the dictionary.\n\nIt is used to improve suggestions and casing rules.\n\nAdded with `v5.16.0`.",
|
|
934
934
|
"properties": {
|
|
935
935
|
"accents": {
|
|
936
936
|
"anyOf": [
|
|
@@ -987,8 +987,8 @@
|
|
|
987
987
|
"markdownDescription": "An optional set of characters that can possibly be removed from a word before\nchecking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported."
|
|
988
988
|
},
|
|
989
989
|
"locale": {
|
|
990
|
-
"description": "The locale of the dictionary.
|
|
991
|
-
"markdownDescription": "The locale of the dictionary.\nExample: `nl
|
|
990
|
+
"description": "The locale of the dictionary.\n\nThe locale should follow the IETF BCP 47 standard. If more than one locale is specified, the first valid locale will be used for casing rules.\n\nAvoid mixing different locales in the same dictionary.\n\nExample: `nl` or `nl-BE`",
|
|
991
|
+
"markdownDescription": "The locale of the dictionary.\n\nThe locale should follow the IETF BCP 47 standard.\nIf more than one locale is specified, the first valid locale will be used for casing rules.\n\nAvoid mixing different locales in the same dictionary.\n\nExample: `nl` or `nl-BE`",
|
|
992
992
|
"type": "string"
|
|
993
993
|
},
|
|
994
994
|
"suggestionEditCosts": {
|
package/dist/index.d.mts
CHANGED
|
@@ -166,13 +166,13 @@ interface Issue extends Omit<TextDocumentOffset, "doc"> {
|
|
|
166
166
|
*/
|
|
167
167
|
hasPreferredSuggestions?: boolean | undefined;
|
|
168
168
|
}
|
|
169
|
-
declare enum IssueType {
|
|
169
|
+
export declare enum IssueType {
|
|
170
170
|
spelling = 0,
|
|
171
171
|
directive = 1
|
|
172
172
|
}
|
|
173
173
|
type MessageType = "Debug" | "Info" | "Warning";
|
|
174
174
|
type MessageTypeLookup = { [key in MessageType]: key; };
|
|
175
|
-
declare const MessageTypes: MessageTypeLookup;
|
|
175
|
+
export declare const MessageTypes: MessageTypeLookup;
|
|
176
176
|
type MessageEmitter = (message: string, msgType: MessageType) => void;
|
|
177
177
|
type DebugEmitter = (message: string) => void;
|
|
178
178
|
type ErrorLike = Error | {
|
|
@@ -375,7 +375,7 @@ interface ReportIssueOptions extends UnknownWordsConfiguration {
|
|
|
375
375
|
* Possible choices for how to handle unknown words.
|
|
376
376
|
*/
|
|
377
377
|
type UnknownWordsChoices = "report-all" | "report-simple" | "report-common-typos" | "report-flagged";
|
|
378
|
-
declare const unknownWordsChoices: {
|
|
378
|
+
export declare const unknownWordsChoices: {
|
|
379
379
|
readonly ReportAll: "report-all";
|
|
380
380
|
readonly ReportSimple: "report-simple";
|
|
381
381
|
readonly ReportCommonTypos: "report-common-typos";
|
|
@@ -546,15 +546,23 @@ interface CostMapDefSwap extends CostMapDefBase {
|
|
|
546
546
|
//#endregion
|
|
547
547
|
//#region src/DictionaryInformation.d.ts
|
|
548
548
|
/**
|
|
549
|
-
*
|
|
550
|
-
*
|
|
549
|
+
* Provides extra information about the dictionary.
|
|
550
|
+
*
|
|
551
|
+
* It is used to improve suggestions and casing rules.
|
|
551
552
|
*
|
|
552
553
|
* Added with `v5.16.0`.
|
|
553
554
|
*/
|
|
554
555
|
interface DictionaryInformation {
|
|
555
556
|
/**
|
|
556
557
|
* The locale of the dictionary.
|
|
557
|
-
*
|
|
558
|
+
*
|
|
559
|
+
* The locale should follow the IETF BCP 47 standard.
|
|
560
|
+
* If more than one locale is specified, the first valid locale will be used for casing rules.
|
|
561
|
+
*
|
|
562
|
+
* Avoid mixing different locales in the same dictionary.
|
|
563
|
+
*
|
|
564
|
+
* Example: `nl` or `nl-BE`
|
|
565
|
+
*
|
|
558
566
|
*/
|
|
559
567
|
locale?: string;
|
|
560
568
|
/**
|
|
@@ -2244,21 +2252,21 @@ interface CompatibleEngineVersions {
|
|
|
2244
2252
|
//#region src/configFields.d.ts
|
|
2245
2253
|
type ConfigKeys = Exclude<keyof CSpellUserSettings, "$schema" | "version" | "id">;
|
|
2246
2254
|
type CSpellUserSettingsFields = { [key in ConfigKeys]: key; };
|
|
2247
|
-
declare const ConfigFields: CSpellUserSettingsFields;
|
|
2255
|
+
export declare const ConfigFields: CSpellUserSettingsFields;
|
|
2248
2256
|
//#endregion
|
|
2249
2257
|
//#region src/defaultConfigSettings.d.ts
|
|
2250
|
-
declare const defaultCSpellSettings: {
|
|
2258
|
+
export declare const defaultCSpellSettings: {
|
|
2251
2259
|
readonly ignoreRandomStrings: boolean;
|
|
2252
2260
|
readonly minRandomLength: number;
|
|
2253
2261
|
};
|
|
2254
2262
|
//#endregion
|
|
2255
2263
|
//#region src/defineConfig.d.ts
|
|
2256
|
-
declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
|
|
2264
|
+
export declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
|
|
2257
2265
|
//#endregion
|
|
2258
2266
|
//#region src/merge.d.ts
|
|
2259
|
-
declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
|
|
2260
|
-
declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
|
|
2261
|
-
declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
|
|
2267
|
+
export declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
|
|
2268
|
+
export declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
|
|
2269
|
+
export declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
|
|
2262
2270
|
//#endregion
|
|
2263
|
-
export {
|
|
2271
|
+
export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, AvailableParsers, BaseSetting, CSpellPackageSettings, CSpellPlugin, CSpellPlugin as Plugin, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CSpellVFS, CSpellVFSBinaryData, CSpellVFSData, CSpellVFSFile, CSpellVFSFileEntry, CSpellVFSFileUrl, CSpellVFSTextData, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, CreateParser, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, DocumentParser, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, OverrideFilterFields, OverrideSettings, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Parsers, Pattern, PatternId, PatternRef, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, Range, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, SoftWordBreak, SoftWordBreakDefinitions, SoftWordBreakPattern, SoftWordBreakRegExp, SoftWordBreakRegExpString, SoftWordBreakRule, SoftWordBreaks, Source, SourceMap, SpellingErrorEmitter, SubstitutionDefinition, SubstitutionDefinitions, SubstitutionEntry, SubstitutionID, Substitutions, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TagPattern, TextDocument, TextDocumentFragment, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, ValidationTags, Version, VersionLatest, VersionLegacy, WordSegmentationSettings, WorkspaceTrustSettings };
|
|
2264
2272
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -166,13 +166,13 @@ interface Issue extends Omit<TextDocumentOffset, "doc"> {
|
|
|
166
166
|
*/
|
|
167
167
|
hasPreferredSuggestions?: boolean | undefined;
|
|
168
168
|
}
|
|
169
|
-
declare enum IssueType {
|
|
169
|
+
export declare enum IssueType {
|
|
170
170
|
spelling = 0,
|
|
171
171
|
directive = 1
|
|
172
172
|
}
|
|
173
173
|
type MessageType = "Debug" | "Info" | "Warning";
|
|
174
174
|
type MessageTypeLookup = { [key in MessageType]: key; };
|
|
175
|
-
declare const MessageTypes: MessageTypeLookup;
|
|
175
|
+
export declare const MessageTypes: MessageTypeLookup;
|
|
176
176
|
type MessageEmitter = (message: string, msgType: MessageType) => void;
|
|
177
177
|
type DebugEmitter = (message: string) => void;
|
|
178
178
|
type ErrorLike = Error | {
|
|
@@ -375,7 +375,7 @@ interface ReportIssueOptions extends UnknownWordsConfiguration {
|
|
|
375
375
|
* Possible choices for how to handle unknown words.
|
|
376
376
|
*/
|
|
377
377
|
type UnknownWordsChoices = "report-all" | "report-simple" | "report-common-typos" | "report-flagged";
|
|
378
|
-
declare const unknownWordsChoices: {
|
|
378
|
+
export declare const unknownWordsChoices: {
|
|
379
379
|
readonly ReportAll: "report-all";
|
|
380
380
|
readonly ReportSimple: "report-simple";
|
|
381
381
|
readonly ReportCommonTypos: "report-common-typos";
|
|
@@ -546,15 +546,23 @@ interface CostMapDefSwap extends CostMapDefBase {
|
|
|
546
546
|
//#endregion
|
|
547
547
|
//#region src/DictionaryInformation.d.ts
|
|
548
548
|
/**
|
|
549
|
-
*
|
|
550
|
-
*
|
|
549
|
+
* Provides extra information about the dictionary.
|
|
550
|
+
*
|
|
551
|
+
* It is used to improve suggestions and casing rules.
|
|
551
552
|
*
|
|
552
553
|
* Added with `v5.16.0`.
|
|
553
554
|
*/
|
|
554
555
|
interface DictionaryInformation {
|
|
555
556
|
/**
|
|
556
557
|
* The locale of the dictionary.
|
|
557
|
-
*
|
|
558
|
+
*
|
|
559
|
+
* The locale should follow the IETF BCP 47 standard.
|
|
560
|
+
* If more than one locale is specified, the first valid locale will be used for casing rules.
|
|
561
|
+
*
|
|
562
|
+
* Avoid mixing different locales in the same dictionary.
|
|
563
|
+
*
|
|
564
|
+
* Example: `nl` or `nl-BE`
|
|
565
|
+
*
|
|
558
566
|
*/
|
|
559
567
|
locale?: string;
|
|
560
568
|
/**
|
|
@@ -2244,21 +2252,21 @@ interface CompatibleEngineVersions {
|
|
|
2244
2252
|
//#region src/configFields.d.ts
|
|
2245
2253
|
type ConfigKeys = Exclude<keyof CSpellUserSettings, "$schema" | "version" | "id">;
|
|
2246
2254
|
type CSpellUserSettingsFields = { [key in ConfigKeys]: key; };
|
|
2247
|
-
declare const ConfigFields: CSpellUserSettingsFields;
|
|
2255
|
+
export declare const ConfigFields: CSpellUserSettingsFields;
|
|
2248
2256
|
//#endregion
|
|
2249
2257
|
//#region src/defaultConfigSettings.d.ts
|
|
2250
|
-
declare const defaultCSpellSettings: {
|
|
2258
|
+
export declare const defaultCSpellSettings: {
|
|
2251
2259
|
readonly ignoreRandomStrings: boolean;
|
|
2252
2260
|
readonly minRandomLength: number;
|
|
2253
2261
|
};
|
|
2254
2262
|
//#endregion
|
|
2255
2263
|
//#region src/defineConfig.d.ts
|
|
2256
|
-
declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
|
|
2264
|
+
export declare function defineConfig(config: AdvancedCSpellSettings): CSpellSettings;
|
|
2257
2265
|
//#endregion
|
|
2258
2266
|
//#region src/merge.d.ts
|
|
2259
|
-
declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
|
|
2260
|
-
declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
|
|
2261
|
-
declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
|
|
2267
|
+
export declare function mergeConfig(settings: CSpellSettings[]): CSpellSettings;
|
|
2268
|
+
export declare function mergeConfig(...settings: [CSpellSettings, ...CSpellSettings[]]): CSpellSettings;
|
|
2269
|
+
export declare function mergeConfig(...settings: [CSpellSettings[], ...CSpellSettings[]]): CSpellSettings;
|
|
2262
2270
|
//#endregion
|
|
2263
|
-
export {
|
|
2271
|
+
export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, AvailableParsers, BaseSetting, CSpellPackageSettings, CSpellPlugin, CSpellPlugin as Plugin, CSpellReporter, CSpellReporterEmitters, CSpellReporterModule, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsFields, CSpellUserSettingsWithComments, CSpellVFS, CSpellVFSBinaryData, CSpellVFSData, CSpellVFSFile, CSpellVFSFileEntry, CSpellVFSFileUrl, CSpellVFSTextData, CacheFormat, CacheSettings, CacheStrategy, CharacterSet, CharacterSetCosts, CommandLineSettings, CreateParser, CustomDictionaryPath, CustomDictionaryScope, DebugEmitter, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryDefinitionSimple, DictionaryFileTypes, DictionaryId, DictionaryInformation, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, DocumentParser, EditCosts, ErrorEmitter, ErrorLike, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FSPathResolvable, Feature, Features, FeaturesSupportedByReporter, FileSettings, FileSource, FsPath, Glob, GlobDef, ImportFileRef, InMemorySource, Issue, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocalId, LocaleId, MappedText, MatchingFileType, MergeSource, MessageEmitter, MessageType, MessageTypeLookup, OverrideFilterFields, OverrideSettings, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Parsers, Pattern, PatternId, PatternRef, PnPSettings, PredefinedPatterns, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, Range, RegExpPatternDefinition, RegExpPatternList, ReplaceEntry, ReplaceMap, ReportIssueOptions, ReporterConfiguration, ReporterSettings, ReportingConfiguration, ResultEmitter, RunResult, Settings, SimpleGlob, SoftWordBreak, SoftWordBreakDefinitions, SoftWordBreakPattern, SoftWordBreakRegExp, SoftWordBreakRegExpString, SoftWordBreakRule, SoftWordBreaks, Source, SourceMap, SpellingErrorEmitter, SubstitutionDefinition, SubstitutionDefinitions, SubstitutionEntry, SubstitutionID, Substitutions, SuggestionCostMapDef, SuggestionCostsDefs, SuggestionsConfiguration, TagPattern, TextDocument, TextDocumentFragment, TextDocumentOffset, TextOffset, TrustLevel, UnknownWordsChoices, UnknownWordsConfiguration, ValidationTags, Version, VersionLatest, VersionLegacy, WordSegmentationSettings, WorkspaceTrustSettings };
|
|
2264
2272
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cspell/cspell-types",
|
|
3
|
-
"version": "10.4.0
|
|
3
|
+
"version": "10.4.0",
|
|
4
4
|
"description": "Types for cspell and cspell-lib",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
@@ -88,5 +88,5 @@
|
|
|
88
88
|
"engines": {
|
|
89
89
|
"node": ">=22.18.0"
|
|
90
90
|
},
|
|
91
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "7e2bbb5e866c827ac5d2cf6b84bf3e1a016d0823"
|
|
92
92
|
}
|