@cspell/cspell-types 6.14.3 → 6.15.1

package/cspell.schema.json

@@ -171,7 +171,7 @@
       "type": "object"
     },
     "CustomDictionaryPath": {
-      "$ref": "#/definitions/FsPath",
+      "$ref": "#/definitions/FsDictionaryPath",
       "description": "A File System Path to a dictionary file."
     },
     "CustomDictionaryScope": {
@@ -535,6 +535,10 @@
       },
       "type": "object"
     },
+    "FsDictionaryPath": {
+      "description": "A File System Path. Relative paths are relative to the configuration file.",
+      "type": "string"
+    },
     "FsPath": {
       "description": "A File System Path. Relative paths are relative to the configuration file.",
       "type": "string"

package/dist/CSpellSettingsDef.d.ts

@@ -1,9 +1,7 @@
-import type { DictionaryInformation } from './DictionaryInformation';
+import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition';
 import type { Features } from './features';
-import { Parser, ParserName } from './Parser';
-import { Serializable } from './types';
-export type ReplaceEntry = [string, string];
-export type ReplaceMap = ReplaceEntry[];
+import type { Parser, ParserName } from './Parser';
+import type { Serializable } from './types';
 /**
  * These settings come from user and workspace settings.
  */
@@ -482,133 +480,6 @@ export interface BaseSetting extends ExperimentalBaseSettings {
      */
     patterns?: RegExpPatternDefinition[];
 }
-export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
-export interface DictionaryDefinitionBase {
-    /**
-     * This is the name of a dictionary.
-     *
-     * Name Format:
-     * - Must contain at least 1 number or letter.
-     * - Spaces are allowed.
-     * - Leading and trailing space will be removed.
-     * - Names ARE case-sensitive.
-     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
-     */
-    name: DictionaryId;
-    /** Optional description. */
-    description?: string;
-    /** Replacement pairs. */
-    repMap?: ReplaceMap;
-    /** Use Compounds. */
-    useCompounds?: boolean;
-    /**
-     * Indicate that suggestions should not come from this dictionary.
-     * Words in this dictionary are considered correct, but will not be
-     * used when making spell correction suggestions.
-     *
-     * Note: if a word is suggested by another dictionary, but found in
-     * this dictionary, it will be removed from the set of
-     * possible suggestions.
-     */
-    noSuggest?: boolean;
-    /**
-     * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
-     * Default is S.
-     * C is the slowest to load due to the need to split each line based upon code splitting rules.
-     * @default "S"
-     */
-    type?: DictionaryFileTypes;
-}
-export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
-    /** Path to the file. */
-    path: DictionaryPath;
-    /**
-     * Only for legacy dictionary definitions.
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
-     * @hidden
-     */
-    file?: undefined;
-}
-/**
- * Used to provide extra data related to the dictionary
- */
-export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
-    dictionaryInformation?: DictionaryInformation;
-}
-/**
- * Only for legacy dictionary definitions.
- * @deprecated true
- * @deprecationMessage Use `DictionaryDefinitionPreferred` instead.
- */
-export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
-    /** @hidden */
-    path?: undefined;
-    /**
-     * Path to the file, only for legacy dictionary definitions.
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
-     */
-    file: DictionaryPath;
-    /** @hidden */
-    suggestionEditCosts?: undefined;
-}
-/**
- * @deprecated true
- * @hidden
- */
-export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
-    /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
-    path?: FsPath;
-    /**
-     * File name.
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
-     */
-    file: FsPath;
-    /**
-     * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
-     * Default is S.
-     * C is the slowest to load due to the need to split each line based upon code splitting rules.
-     * @default "S"
-     */
-    type?: DictionaryFileTypes;
-    /**
-     * @hidden
-     */
-    suggestionEditCosts?: undefined;
-}
-/**
- * Specifies the scope of a dictionary.
- */
-export type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
-/**
- * For Defining Custom dictionaries. They are generally scoped to a
- * `user`, `workspace`, or `folder`.
- * When `addWords` is true, indicates that the spell checker can add words
- * to the file.
- * Note: only plain text files with one word per line are supported at this moment.
- */
-export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
-    /** Path to custom dictionary text file. */
-    path: CustomDictionaryPath;
-    /**
-     * Defines the scope for when words will be added to the dictionary.
-     * Scope values: `user`, `workspace`, `folder`.
-     */
-    scope?: CustomDictionaryScope | CustomDictionaryScope[];
-    /**
-     * When `true`, let's the spell checker know that words can be added to this dictionary.
-     */
-    addWords: boolean;
-}
 export interface LanguageSetting extends LanguageSettingFilterFields, BaseSetting {
 }
 export interface LanguageSettingFilterFields extends LanguageSettingFilterFieldsPreferred, LanguageSettingFilterFieldsDeprecated {
@@ -639,46 +510,6 @@ export type PatternId = string;
 export type PatternRef = Pattern | PatternId | PredefinedPatterns;
 /** A list of pattern names or regular expressions. */
 export type RegExpPatternList = PatternRef[];
-/**
- * This is the name of a dictionary.
- *
- * Name Format:
- * - Must contain at least 1 number or letter.
- * - Spaces are allowed.
- * - Leading and trailing space will be removed.
- * - Names ARE case-sensitive.
- * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
- *
- * @pattern ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
- */
-export type DictionaryId = string;
-/**
- * This a reference to a named dictionary.
- * It is expected to match the name of a dictionary.
- */
-export type DictionaryRef = DictionaryId;
-/**
- * This a negative reference to a named dictionary.
- *
- * It is used to exclude or include a dictionary by name.
- *
- * The reference starts with 1 or more `!`.
- * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
- * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.
- *    Overrides `!<dictionary_name>`.
- * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.
- *    Overrides `!!<dictionary_name>`.
- *
- * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
- */
-export type DictionaryNegRef = string;
-/**
- * Reference to a dictionary by name.
- * One of:
- * - {@link DictionaryRef}
- * - {@link DictionaryNegRef}
- */
-export type DictionaryReference = DictionaryRef | DictionaryNegRef;
 /** This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. */
 export type LocaleId = string;
 /**
@@ -748,15 +579,6 @@ export type FsPath = string;
 export type FSPathResolvable = FsPath;
 /** Trust Security Level. */
 export type TrustLevel = 'trusted' | 'untrusted';
-/**
- * A File System Path to a dictionary file.
- * @pattern ^.*\.(?:txt|trie)(?:\.gz)?$
- */
-export type DictionaryPath = string;
-/**
- * A File System Path to a dictionary file.
- */
-export type CustomDictionaryPath = FsPath;
 export interface RegExpPatternDefinition {
     /**
      * Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.

package/dist/DictionaryDefinition.d.ts

@@ -0,0 +1,184 @@
+import { DictionaryInformation } from './DictionaryInformation';
+export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
+export interface DictionaryDefinitionBase {
+    /**
+     * This is the name of a dictionary.
+     *
+     * Name Format:
+     * - Must contain at least 1 number or letter.
+     * - Spaces are allowed.
+     * - Leading and trailing space will be removed.
+     * - Names ARE case-sensitive.
+     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
+     */
+    name: DictionaryId;
+    /** Optional description. */
+    description?: string;
+    /** Replacement pairs. */
+    repMap?: ReplaceMap;
+    /** Use Compounds. */
+    useCompounds?: boolean;
+    /**
+     * Indicate that suggestions should not come from this dictionary.
+     * Words in this dictionary are considered correct, but will not be
+     * used when making spell correction suggestions.
+     *
+     * Note: if a word is suggested by another dictionary, but found in
+     * this dictionary, it will be removed from the set of
+     * possible suggestions.
+     */
+    noSuggest?: boolean;
+    /**
+     * Type of file:
+     * S - single word per line,
+     * W - each line can contain one or more words separated by space,
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
+     * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     * @default "S"
+     */
+    type?: DictionaryFileTypes;
+}
+export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
+    /** Path to the file. */
+    path: DictionaryPath;
+    /**
+     * Only for legacy dictionary definitions.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     * @hidden
+     */
+    file?: undefined;
+}
+/**
+ * Used to provide extra data related to the dictionary
+ */
+export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
+    dictionaryInformation?: DictionaryInformation;
+}
+/**
+ * Only for legacy dictionary definitions.
+ * @deprecated true
+ * @deprecationMessage Use `DictionaryDefinitionPreferred` instead.
+ */
+export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
+    /** @hidden */
+    path?: undefined;
+    /**
+     * Path to the file, only for legacy dictionary definitions.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     */
+    file: DictionaryPath;
+    /** @hidden */
+    suggestionEditCosts?: undefined;
+}
+/**
+ * @deprecated true
+ * @hidden
+ */
+export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
+    /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
+    path?: FsDictionaryPath;
+    /**
+     * File name.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     */
+    file: FsDictionaryPath;
+    /**
+     * Type of file:
+     * S - single word per line,
+     * W - each line can contain one or more words separated by space,
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
+     * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     * @default "S"
+     */
+    type?: DictionaryFileTypes;
+    /**
+     * @hidden
+     */
+    suggestionEditCosts?: undefined;
+}
+/**
+ * Specifies the scope of a dictionary.
+ */
+export type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
+/**
+ * For Defining Custom dictionaries. They are generally scoped to a
+ * `user`, `workspace`, or `folder`.
+ * When `addWords` is true, indicates that the spell checker can add words
+ * to the file.
+ * Note: only plain text files with one word per line are supported at this moment.
+ */
+export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
+    /** Path to custom dictionary text file. */
+    path: CustomDictionaryPath;
+    /**
+     * Defines the scope for when words will be added to the dictionary.
+     * Scope values: `user`, `workspace`, `folder`.
+     */
+    scope?: CustomDictionaryScope | CustomDictionaryScope[];
+    /**
+     * When `true`, let's the spell checker know that words can be added to this dictionary.
+     */
+    addWords: boolean;
+}
+/**
+ * This is the name of a dictionary.
+ *
+ * Name Format:
+ * - Must contain at least 1 number or letter.
+ * - Spaces are allowed.
+ * - Leading and trailing space will be removed.
+ * - Names ARE case-sensitive.
+ * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
+ *
+ * @pattern ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
+ */
+export type DictionaryId = string;
+export type ReplaceEntry = [string, string];
+export type ReplaceMap = ReplaceEntry[];
+/**
+ * A File System Path. Relative paths are relative to the configuration file.
+ */
+export type FsDictionaryPath = string;
+/**
+ * A File System Path to a dictionary file.
+ * @pattern ^.*\.(?:txt|trie)(?:\.gz)?$
+ */
+export type DictionaryPath = string;
+/**
+ * A File System Path to a dictionary file.
+ */
+export type CustomDictionaryPath = FsDictionaryPath;
+/**
+ * Reference to a dictionary by name.
+ * One of:
+ * - {@link DictionaryRef}
+ * - {@link DictionaryNegRef}
+ */
+export type DictionaryReference = DictionaryRef | DictionaryNegRef;
+/**
+ * This a reference to a named dictionary.
+ * It is expected to match the name of a dictionary.
+ */
+export type DictionaryRef = DictionaryId;
+/**
+ * This a negative reference to a named dictionary.
+ *
+ * It is used to exclude or include a dictionary by name.
+ *
+ * The reference starts with 1 or more `!`.
+ * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
+ * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.
+ *    Overrides `!<dictionary_name>`.
+ * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.
+ *    Overrides `!!<dictionary_name>`.
+ *
+ * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
+ */
+export type DictionaryNegRef = string;
+//# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/DictionaryDefinition.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DictionaryDefinition.js.map

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 export { ConfigFields } from './configFields';
 export type { CSpellUserSettingsFields } from './configFields';
-export * from './CSpellReporter';
-export * from './CSpellSettingsDef';
+export { IssueType, MessageTypes } from './CSpellReporter';
+export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter';
+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';
+export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation';
 export type { Feature, Features } from './features';
 export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser';

package/dist/index.js

@@ -1,23 +1,10 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigFields = void 0;
+exports.MessageTypes = exports.IssueType = exports.ConfigFields = void 0;
 // Using old-style of `type` exports because the new style breaks some integrations.
 var configFields_1 = require("./configFields");
 Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_1.ConfigFields; } });
-__exportStar(require("./CSpellReporter"), exports);
-__exportStar(require("./CSpellSettingsDef"), exports);
+var CSpellReporter_1 = require("./CSpellReporter");
+Object.defineProperty(exports, "IssueType", { enumerable: true, get: function () { return CSpellReporter_1.IssueType; } });
+Object.defineProperty(exports, "MessageTypes", { enumerable: true, get: function () { return CSpellReporter_1.MessageTypes; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.14.3",
+  "version": "6.15.1",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -69,5 +69,5 @@
     "ts-json-schema-generator": "^1.1.2",
     "typescript": "^4.9.3"
   },
-  "gitHead": "df0efdbb0dc7b084579130ba5fe97441c0ab67ca"
+  "gitHead": "9668bef6beeec53e1e473efc97e309baa0338de2"
 }