@cspell/cspell-types 6.21.0 → 6.23.0

package/README.md

@@ -58,3 +58,27 @@ module.exports = cspell;
 ## API
 
 `CSpellSettings` alias `CSpellUserSettings` is the formal definition of the configuration that controls the spell checker.
+
+## CSpell for Enterprise
+
+<!--- @@inject: ../../static/tidelift.md --->
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
+
+<!--- @@inject-end: ../../static/tidelift.md --->
+
+<!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->

package/cspell.schema.json

@@ -194,6 +194,9 @@
         {
           "$ref": "#/definitions/DictionaryDefinitionAugmented"
         },
+        {
+          "$ref": "#/definitions/DictionaryDefinitionInline"
+        },
         {
           "$ref": "#/definitions/DictionaryDefinitionAlternate"
         }
@@ -345,6 +348,188 @@
       ],
       "type": "object"
     },
+    "DictionaryDefinitionInline": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/DictionaryDefinitionInlineWords"
+        },
+        {
+          "$ref": "#/definitions/DictionaryDefinitionInlineIgnoreWords"
+        },
+        {
+          "$ref": "#/definitions/DictionaryDefinitionInlineFlagWords"
+        }
+      ],
+      "description": "Inline Dictionary Definitions"
+    },
+    "DictionaryDefinitionInlineFlagWords": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "Optional description.",
+          "type": "string"
+        },
+        "flagWords": {
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "ignoreWords": {
+          "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "name": {
+          "$ref": "#/definitions/DictionaryId",
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
+        },
+        "noSuggest": {
+          "description": "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.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+          "type": "boolean"
+        },
+        "repMap": {
+          "$ref": "#/definitions/ReplaceMap",
+          "description": "Replacement pairs."
+        },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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."
+        },
+        "useCompounds": {
+          "description": "Use Compounds.",
+          "type": "boolean"
+        },
+        "words": {
+          "description": "List of words to be considered correct.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "flagWords",
+        "name"
+      ],
+      "type": "object"
+    },
+    "DictionaryDefinitionInlineIgnoreWords": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "Optional description.",
+          "type": "string"
+        },
+        "flagWords": {
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "ignoreWords": {
+          "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "name": {
+          "$ref": "#/definitions/DictionaryId",
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
+        },
+        "noSuggest": {
+          "description": "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.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+          "type": "boolean"
+        },
+        "repMap": {
+          "$ref": "#/definitions/ReplaceMap",
+          "description": "Replacement pairs."
+        },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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."
+        },
+        "useCompounds": {
+          "description": "Use Compounds.",
+          "type": "boolean"
+        },
+        "words": {
+          "description": "List of words to be considered correct.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "ignoreWords",
+        "name"
+      ],
+      "type": "object"
+    },
+    "DictionaryDefinitionInlineWords": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "Optional description.",
+          "type": "string"
+        },
+        "flagWords": {
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "ignoreWords": {
+          "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "name": {
+          "$ref": "#/definitions/DictionaryId",
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
+        },
+        "noSuggest": {
+          "description": "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.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+          "type": "boolean"
+        },
+        "repMap": {
+          "$ref": "#/definitions/ReplaceMap",
+          "description": "Replacement pairs."
+        },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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."
+        },
+        "useCompounds": {
+          "description": "Use Compounds.",
+          "type": "boolean"
+        },
+        "words": {
+          "description": "List of words to be considered correct.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "name",
+        "words"
+      ],
+      "type": "object"
+    },
     "DictionaryDefinitionPreferred": {
       "additionalProperties": false,
       "properties": {
@@ -681,7 +866,7 @@
           "type": "boolean"
         },
         "flagWords": {
-          "description": "List of words to always be considered incorrect.",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
           "items": {
             "type": "string"
           },
@@ -769,7 +954,7 @@
           "type": "array"
         },
         "words": {
-          "description": "List of words to be always considered correct.",
+          "description": "List of words to be considered correct.",
           "items": {
             "type": "string"
           },
@@ -853,7 +1038,7 @@
           "description": "Glob pattern or patterns to match against."
         },
         "flagWords": {
-          "description": "List of words to always be considered incorrect.",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
           "items": {
             "type": "string"
           },
@@ -963,7 +1148,7 @@
           "type": "boolean"
         },
         "words": {
-          "description": "List of words to be always considered correct.",
+          "description": "List of words to be considered correct.",
           "items": {
             "type": "string"
           },
@@ -1283,7 +1468,7 @@
     },
     "features": {
       "$ref": "#/definitions/Features",
-      "description": "Configure CSpell features.\n\n- Added with `v5.16.0`."
+      "description": "Configure CSpell features."
     },
     "files": {
       "description": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
@@ -1293,7 +1478,7 @@
       "type": "array"
     },
     "flagWords": {
-      "description": "List of words to always be considered incorrect.",
+      "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
       "items": {
         "type": "string"
       },
@@ -1501,7 +1686,7 @@
       "description": "Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave."
     },
     "words": {
-      "description": "List of words to be always considered correct.",
+      "description": "List of words to be considered correct.",
       "items": {
         "type": "string"
       },

package/dist/cjs/CSpellSettingsDef.d.ts

@@ -1,6 +1,7 @@
 import type { ReporterConfigurationBase } from './CSpellReporter.js';
 import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition.js';
 import type { Features } from './features.js';
+import type { InlineDictionary } from './InlineDictionary.js';
 import type { Parser, ParserName } from './Parser/index.js';
 import type { Serializable } from './types.js';
 /**
@@ -123,7 +124,7 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /**
      * Configure CSpell features.
      *
-     * - Added with `v5.16.0`.
+     * @version 5.16.0
      */
     features?: Features;
 }
@@ -353,7 +354,7 @@ export interface OverrideFilterFields {
     /** Glob pattern or patterns to match against. */
     filename: Glob | Glob[];
 }
-export interface BaseSetting extends ExperimentalBaseSettings {
+export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings {
     /** Optional identifier. */
     id?: string;
     /** Optional name of configuration. */
@@ -365,15 +366,6 @@ export interface BaseSetting extends ExperimentalBaseSettings {
      * @default true
      */
     enabled?: boolean;
-    /** List of words to be always considered correct. */
-    words?: string[];
-    /** List of words to always be considered incorrect. */
-    flagWords?: string[];
-    /**
-     * List of words to be ignored. An ignored word will not show up as an error, even if it is
-     * also in the `flagWords`.
-     */
-    ignoreWords?: string[];
     /**
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *

package/dist/cjs/DictionaryDefinition.d.ts

@@ -1,5 +1,6 @@
 import type { DictionaryInformation } from './DictionaryInformation.js';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+import type { InlineDictionary } from './InlineDictionary.js';
+export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
 export interface DictionaryDefinitionBase {
     /**
@@ -57,6 +58,39 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
 export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
     dictionaryInformation?: DictionaryInformation;
 }
+/**
+ * Inline Dictionary Definition
+ *
+ * All words are defined inline.
+ */
+interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, InlineDictionary {
+    /**
+     * Not used
+     * @hidden
+     */
+    path?: undefined;
+    /**
+     * Note used
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     * @hidden
+     */
+    file?: undefined;
+}
+export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
+    words: string[];
+}
+export interface DictionaryDefinitionInlineFlagWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'flagWords'>> {
+    flagWords: string[];
+}
+export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'ignoreWords'>> {
+    ignoreWords: string[];
+}
+/**
+ * Inline Dictionary Definitions
+ * @version 6.23.0
+ */
+export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
 /**
  * Only for legacy dictionary definitions.
  * @deprecated true
@@ -181,4 +215,5 @@ export type DictionaryRef = DictionaryId;
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
 export type DictionaryNegRef = string;
+export {};
 //# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/cjs/InlineDictionary.d.ts

@@ -0,0 +1,30 @@
+export interface InlineDictionary {
+    /**
+     * List of words to be considered correct.
+     */
+    words?: string[];
+    /**
+     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
+     *
+     * Format of `flagWords`
+     * - single word entry - `word`
+     * - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
+     *
+     * Example:
+     * ```ts
+     * "flagWords": [
+     *   "color: colour",
+     *   "incase: in case, encase",
+     *   "canot->cannot",
+     *   "cancelled->canceled"
+     * ]
+     * ```
+     */
+    flagWords?: string[];
+    /**
+     * List of words to be ignored. An ignored word will not show up as an error, even if it is
+     * also in the `flagWords`.
+     */
+    ignoreWords?: string[];
+}
+//# sourceMappingURL=InlineDictionary.d.ts.map

package/dist/cjs/Parser/CSpellSettingsDef.d.ts

@@ -1,6 +1,7 @@
 import type { ReporterConfigurationBase } from './CSpellReporter.js';
 import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition.js';
 import type { Features } from './features.js';
+import type { InlineDictionary } from './InlineDictionary.js';
 import type { Parser, ParserName } from './Parser/index.js';
 import type { Serializable } from './types.js';
 /**
@@ -123,7 +124,7 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /**
      * Configure CSpell features.
      *
-     * - Added with `v5.16.0`.
+     * @version 5.16.0
      */
     features?: Features;
 }
@@ -353,7 +354,7 @@ export interface OverrideFilterFields {
     /** Glob pattern or patterns to match against. */
     filename: Glob | Glob[];
 }
-export interface BaseSetting extends ExperimentalBaseSettings {
+export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings {
     /** Optional identifier. */
     id?: string;
     /** Optional name of configuration. */
@@ -365,15 +366,6 @@ export interface BaseSetting extends ExperimentalBaseSettings {
      * @default true
      */
     enabled?: boolean;
-    /** List of words to be always considered correct. */
-    words?: string[];
-    /** List of words to always be considered incorrect. */
-    flagWords?: string[];
-    /**
-     * List of words to be ignored. An ignored word will not show up as an error, even if it is
-     * also in the `flagWords`.
-     */
-    ignoreWords?: string[];
     /**
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *

package/dist/cjs/Parser/DictionaryDefinition.d.ts

@@ -1,5 +1,6 @@
 import type { DictionaryInformation } from './DictionaryInformation.js';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+import type { InlineDictionary } from './InlineDictionary.js';
+export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
 export interface DictionaryDefinitionBase {
     /**
@@ -57,6 +58,39 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
 export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
     dictionaryInformation?: DictionaryInformation;
 }
+/**
+ * Inline Dictionary Definition
+ *
+ * All words are defined inline.
+ */
+interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, InlineDictionary {
+    /**
+     * Not used
+     * @hidden
+     */
+    path?: undefined;
+    /**
+     * Note used
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     * @hidden
+     */
+    file?: undefined;
+}
+export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
+    words: string[];
+}
+export interface DictionaryDefinitionInlineFlagWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'flagWords'>> {
+    flagWords: string[];
+}
+export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'ignoreWords'>> {
+    ignoreWords: string[];
+}
+/**
+ * Inline Dictionary Definitions
+ * @version 6.23.0
+ */
+export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
 /**
  * Only for legacy dictionary definitions.
  * @deprecated true
@@ -181,4 +215,5 @@ export type DictionaryRef = DictionaryId;
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
 export type DictionaryNegRef = string;
+export {};
 //# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/cjs/Parser/InlineDictionary.d.ts

@@ -0,0 +1,30 @@
+export interface InlineDictionary {
+    /**
+     * List of words to be considered correct.
+     */
+    words?: string[];
+    /**
+     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
+     *
+     * Format of `flagWords`
+     * - single word entry - `word`
+     * - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
+     *
+     * Example:
+     * ```ts
+     * "flagWords": [
+     *   "color: colour",
+     *   "incase: in case, encase",
+     *   "canot->cannot",
+     *   "cancelled->canceled"
+     * ]
+     * ```
+     */
+    flagWords?: string[];
+    /**
+     * List of words to be ignored. An ignored word will not show up as an error, even if it is
+     * also in the `flagWords`.
+     */
+    ignoreWords?: string[];
+}
+//# sourceMappingURL=InlineDictionary.d.ts.map

package/dist/cjs/Parser/index.d.ts

@@ -3,7 +3,7 @@ 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 { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.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';
 export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser/index.js';

package/dist/cjs/index.d.ts

@@ -3,7 +3,7 @@ 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 { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.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';
 export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser/index.js';

package/dist/esm/CSpellSettingsDef.d.ts

@@ -1,6 +1,7 @@
 import type { ReporterConfigurationBase } from './CSpellReporter.js';
 import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition.js';
 import type { Features } from './features.js';
+import type { InlineDictionary } from './InlineDictionary.js';
 import type { Parser, ParserName } from './Parser/index.js';
 import type { Serializable } from './types.js';
 /**
@@ -123,7 +124,7 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /**
      * Configure CSpell features.
      *
-     * - Added with `v5.16.0`.
+     * @version 5.16.0
      */
     features?: Features;
 }
@@ -353,7 +354,7 @@ export interface OverrideFilterFields {
     /** Glob pattern or patterns to match against. */
     filename: Glob | Glob[];
 }
-export interface BaseSetting extends ExperimentalBaseSettings {
+export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings {
     /** Optional identifier. */
     id?: string;
     /** Optional name of configuration. */
@@ -365,15 +366,6 @@ export interface BaseSetting extends ExperimentalBaseSettings {
      * @default true
      */
     enabled?: boolean;
-    /** List of words to be always considered correct. */
-    words?: string[];
-    /** List of words to always be considered incorrect. */
-    flagWords?: string[];
-    /**
-     * List of words to be ignored. An ignored word will not show up as an error, even if it is
-     * also in the `flagWords`.
-     */
-    ignoreWords?: string[];
     /**
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *

package/dist/esm/DictionaryDefinition.d.ts

@@ -1,5 +1,6 @@
 import type { DictionaryInformation } from './DictionaryInformation.js';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+import type { InlineDictionary } from './InlineDictionary.js';
+export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
 export interface DictionaryDefinitionBase {
     /**
@@ -57,6 +58,39 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
 export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
     dictionaryInformation?: DictionaryInformation;
 }
+/**
+ * Inline Dictionary Definition
+ *
+ * All words are defined inline.
+ */
+interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, InlineDictionary {
+    /**
+     * Not used
+     * @hidden
+     */
+    path?: undefined;
+    /**
+     * Note used
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     * @hidden
+     */
+    file?: undefined;
+}
+export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
+    words: string[];
+}
+export interface DictionaryDefinitionInlineFlagWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'flagWords'>> {
+    flagWords: string[];
+}
+export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'ignoreWords'>> {
+    ignoreWords: string[];
+}
+/**
+ * Inline Dictionary Definitions
+ * @version 6.23.0
+ */
+export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
 /**
  * Only for legacy dictionary definitions.
  * @deprecated true
@@ -181,4 +215,5 @@ export type DictionaryRef = DictionaryId;
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
 export type DictionaryNegRef = string;
+export {};
 //# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/esm/InlineDictionary.d.ts

@@ -0,0 +1,30 @@
+export interface InlineDictionary {
+    /**
+     * List of words to be considered correct.
+     */
+    words?: string[];
+    /**
+     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
+     *
+     * Format of `flagWords`
+     * - single word entry - `word`
+     * - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
+     *
+     * Example:
+     * ```ts
+     * "flagWords": [
+     *   "color: colour",
+     *   "incase: in case, encase",
+     *   "canot->cannot",
+     *   "cancelled->canceled"
+     * ]
+     * ```
+     */
+    flagWords?: string[];
+    /**
+     * List of words to be ignored. An ignored word will not show up as an error, even if it is
+     * also in the `flagWords`.
+     */
+    ignoreWords?: string[];
+}
+//# sourceMappingURL=InlineDictionary.d.ts.map

package/dist/esm/InlineDictionary.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=InlineDictionary.js.map

package/dist/esm/index.d.ts

@@ -3,7 +3,7 @@ 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 { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.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';
 export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser/index.js';

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.21.0",
+  "version": "6.23.0",
   "description": "Types for cspell and cspell-lib",
   "type": "module",
   "main": "./dist/cjs/index.cjs",
@@ -89,10 +89,10 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^29.4.1",
+    "jest": "^29.4.2",
     "ts-json-schema-generator": "^1.2.0",
     "typescript": "^4.9.5",
-    "vitest": "^0.28.3"
+    "vitest": "^0.28.4"
   },
-  "gitHead": "67b37de0cbcbe62feb8fb6ec95adad1275c14caa"
+  "gitHead": "a7cfbfa6cf42c9d9746dd8229d9f1317472e5af8"
 }