@cspell/cspell-types - npm Package Compare versions

Comparing version 9.6.2 to 9.6.3

dist/index.d.mts

 import { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from "./Parser/index.mjs";
 
+//#region src/cspell-vfs.d.ts
+/**
+* Binary data for CSpellVFS file.
+* This can be exported by a JavaScript based CSpell Configuration file.
+* @hidden
+*/
+type CSpellVFSBinaryData = Uint8Array;
+/**
+* Data content stored in a string for CSpellVFS file.
+* It is often encoded (e.g. base64) binary data.
+*/
+type CSpellVFSTextData = string;
+/**
+* The data content of a CSpellVFS file.
+*/
+type CSpellVFSData = CSpellVFSBinaryData | CSpellVFSTextData;
+/**
+* An entry in the CSpell Virtual File System.
+* It may or may not have a URL.
+* @since 9.7.0
+*/
+interface CSpellVFSFileEntry {
+  /**
+  * The optional file vfs url. It is already part of the CSpellVFS key.
+  */
+  url?: CSpellVFSFileUrl;
+  /**
+  * The content data of the file.
+  */
+  data: CSpellVFSData;
+  /**
+  * The encoding of the data. In most cases the encoding is determined from the data type and filename url.
+  */
+  encoding?: "base64" | "plaintext" | "utf8";
+}
+interface CSpellVFSFile extends CSpellVFSFileEntry {
+  /**
+  * The file URL.
+  */
+  url: CSpellVFSFileUrl;
+}
+/**
+* A URL string representing a CSpellVFS file.
+* It should be of the form:
+*
+* ```txt
+* cspell-vfs:///<module>/<path-to-file>/<file-name>
+* ```
+*
+* Example: `cspell-vfs:///@cspell/dict-en_us/en_US.trie.gz`
+*
+* @since 9.7.0
+*/
+type CSpellVFSFileUrl = string;
+/**
+* A declaration of files to add to the CSpell Virtual File System.
+* @since 9.7.0
+* @stability experimental
+*/
+type CSpellVFS = Record<CSpellVFSFileUrl, CSpellVFSFileEntry>;
+//#endregion
 //#region src/SuggestionsConfiguration.d.ts
@@ -111,3 +172,3 @@ interface SuggestionsConfiguration {
   spelling = 0,
-  directive = 1,
+  directive = 1
 }
@@ -1186,2 +1247,13 @@ type MessageType = "Debug" | "Info" | "Warning";
   /**
+  * Files to add to the CSpell Virtual File System.
+  *
+  * They can be referenced using `cspell-vfs:///<module>/<path-to-file>/<file-name>` URLs.
+  *
+  * They can be referenced in the `path` field of dictionary definitions.
+  *
+  * @since 9.7.0
+  * @stability experimental
+  */
+  vfs?: CSpellVFS | undefined;
+  /**
   * Configure CSpell features.
@@ -1192,2 +1264,12 @@ *
   features?: Features;
+  /**
+  * Specify compatible engine versions.
+  *
+  * This allows dictionaries and other components to specify the versions of engines (like cspell) they are compatible with.
+  *
+  * It does not enforce compatibility, it is up to the client to use this information as needed.
+  *
+  * @since 9.6.3
+  */
+  engines?: CompatibleEngineVersions;
 }
@@ -1810,2 +1892,32 @@ /**
 }
+/**
+* Semantic Version Predicate
+*
+* Examples:
+* - `>=8`
+*/
+type SemVersionPredicate = string;
+/**
+* Engine version predicates.
+*
+* This allows dictionaries and other components to specify the versions of engines (like cspell) they are compatible with.
+*
+* @since 9.6.3
+*/
+interface CompatibleEngineVersions {
+  /**
+  * CSpell version predicate.
+  * @since 9.6.3
+  */
+  cspell?: SemVersionPredicate | undefined;
+  /**
+  * The VSCode Spell Checker version predicate.
+  * @since 9.6.3
+  */
+  "code-spell-checker"?: SemVersionPredicate | undefined;
+  /**
+  * Other engine version predicates.
+  */
+  [engine: string]: SemVersionPredicate | undefined;
+}
 //#endregion
@@ -1860,3 +1972,3 @@ //#region src/configFields.d.ts
 //#endregion
-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 };
+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 CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, 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

dist/index.d.ts

 import { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from "./Parser/index.js";
 
+//#region src/cspell-vfs.d.ts
+/**
+* Binary data for CSpellVFS file.
+* This can be exported by a JavaScript based CSpell Configuration file.
+* @hidden
+*/
+type CSpellVFSBinaryData = Uint8Array;
+/**
+* Data content stored in a string for CSpellVFS file.
+* It is often encoded (e.g. base64) binary data.
+*/
+type CSpellVFSTextData = string;
+/**
+* The data content of a CSpellVFS file.
+*/
+type CSpellVFSData = CSpellVFSBinaryData | CSpellVFSTextData;
+/**
+* An entry in the CSpell Virtual File System.
+* It may or may not have a URL.
+* @since 9.7.0
+*/
+interface CSpellVFSFileEntry {
+  /**
+  * The optional file vfs url. It is already part of the CSpellVFS key.
+  */
+  url?: CSpellVFSFileUrl;
+  /**
+  * The content data of the file.
+  */
+  data: CSpellVFSData;
+  /**
+  * The encoding of the data. In most cases the encoding is determined from the data type and filename url.
+  */
+  encoding?: "base64" | "plaintext" | "utf8";
+}
+interface CSpellVFSFile extends CSpellVFSFileEntry {
+  /**
+  * The file URL.
+  */
+  url: CSpellVFSFileUrl;
+}
+/**
+* A URL string representing a CSpellVFS file.
+* It should be of the form:
+*
+* ```txt
+* cspell-vfs:///<module>/<path-to-file>/<file-name>
+* ```
+*
+* Example: `cspell-vfs:///@cspell/dict-en_us/en_US.trie.gz`
+*
+* @since 9.7.0
+*/
+type CSpellVFSFileUrl = string;
+/**
+* A declaration of files to add to the CSpell Virtual File System.
+* @since 9.7.0
+* @stability experimental
+*/
+type CSpellVFS = Record<CSpellVFSFileUrl, CSpellVFSFileEntry>;
+//#endregion
 //#region src/SuggestionsConfiguration.d.ts
@@ -111,3 +172,3 @@ interface SuggestionsConfiguration {
   spelling = 0,
-  directive = 1,
+  directive = 1
 }
@@ -1186,2 +1247,13 @@ type MessageType = "Debug" | "Info" | "Warning";
   /**
+  * Files to add to the CSpell Virtual File System.
+  *
+  * They can be referenced using `cspell-vfs:///<module>/<path-to-file>/<file-name>` URLs.
+  *
+  * They can be referenced in the `path` field of dictionary definitions.
+  *
+  * @since 9.7.0
+  * @stability experimental
+  */
+  vfs?: CSpellVFS | undefined;
+  /**
   * Configure CSpell features.
@@ -1192,2 +1264,12 @@ *
   features?: Features;
+  /**
+  * Specify compatible engine versions.
+  *
+  * This allows dictionaries and other components to specify the versions of engines (like cspell) they are compatible with.
+  *
+  * It does not enforce compatibility, it is up to the client to use this information as needed.
+  *
+  * @since 9.6.3
+  */
+  engines?: CompatibleEngineVersions;
 }
@@ -1810,2 +1892,32 @@ /**
 }
+/**
+* Semantic Version Predicate
+*
+* Examples:
+* - `>=8`
+*/
+type SemVersionPredicate = string;
+/**
+* Engine version predicates.
+*
+* This allows dictionaries and other components to specify the versions of engines (like cspell) they are compatible with.
+*
+* @since 9.6.3
+*/
+interface CompatibleEngineVersions {
+  /**
+  * CSpell version predicate.
+  * @since 9.6.3
+  */
+  cspell?: SemVersionPredicate | undefined;
+  /**
+  * The VSCode Spell Checker version predicate.
+  * @since 9.6.3
+  */
+  "code-spell-checker"?: SemVersionPredicate | undefined;
+  /**
+  * Other engine version predicates.
+  */
+  [engine: string]: SemVersionPredicate | undefined;
+}
 //#endregion
@@ -1860,3 +1972,3 @@ //#region src/configFields.d.ts
 //#endregion
-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 };
+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 CSpellVFS, type CSpellVFSBinaryData, type CSpellVFSData, type CSpellVFSFile, type CSpellVFSFileEntry, type CSpellVFSFileUrl, type CSpellVFSTextData, 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

dist/index.js

@@ -15,2 +15,3 @@
 	enableGlobDot: "enableGlobDot",
+	engines: "engines",
 	failFast: "failFast",
@@ -56,2 +57,3 @@ features: "features",
 	validateDirectives: "validateDirectives",
+	vfs: "vfs",
 	words: "words",
@@ -63,6 +65,6 @@ parser: "parser"
 //#region src/CSpellReporter.ts
-let IssueType = /* @__PURE__ */ function(IssueType$1) {
-	IssueType$1[IssueType$1["spelling"] = 0] = "spelling";
-	IssueType$1[IssueType$1["directive"] = 1] = "directive";
-	return IssueType$1;
+let IssueType = /* @__PURE__ */ function(IssueType) {
+	IssueType[IssueType["spelling"] = 0] = "spelling";
+	IssueType[IssueType["directive"] = 1] = "directive";
+	return IssueType;
 }({});
@@ -69,0 +71,0 @@ const MessageTypes = {

dist/index.mjs

@@ -14,2 +14,3 @@ //#region src/configFields.ts
 	enableGlobDot: "enableGlobDot",
+	engines: "engines",
 	failFast: "failFast",
@@ -55,2 +56,3 @@ features: "features",
 	validateDirectives: "validateDirectives",
+	vfs: "vfs",
 	words: "words",
@@ -62,6 +64,6 @@ parser: "parser"
 //#region src/CSpellReporter.ts
-let IssueType = /* @__PURE__ */ function(IssueType$1) {
-	IssueType$1[IssueType$1["spelling"] = 0] = "spelling";
-	IssueType$1[IssueType$1["directive"] = 1] = "directive";
-	return IssueType$1;
+let IssueType = /* @__PURE__ */ function(IssueType) {
+	IssueType[IssueType["spelling"] = 0] = "spelling";
+	IssueType[IssueType["directive"] = 1] = "directive";
+	return IssueType;
 }({});
@@ -68,0 +70,0 @@ const MessageTypes = {

package.json

@@ -7,3 +7,3 @@ {
   },
-  "version": "9.6.2",
+  "version": "9.6.3",
   "description": "Types for cspell and cspell-lib",
@@ -60,4 +60,3 @@ "type": "commonjs",
     "coverage": "vitest run --coverage",
-    "test": "vitest run",
-    "prepare": "echo Skip Building Types"
+    "test": "vitest run"
   },
@@ -91,3 +90,3 @@ "repository": {
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "646e18a04ff36d43f78a74e5055540e0f5297e91"
+  "gitHead": "500b996b6c0a6ff025c42ef98db44776f43a9e72"
 }

No alert changes

Improved metrics

Total package byte prevSize

295407

4.18%

Lines of code

4748

5.04%

No dependency changes