@cspell/cspell-types 9.1.3 → 9.1.5

package/dist/index.d.mts

@@ -327,7 +327,6 @@ interface UnknownWordsConfiguration {
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
-// cspell:ignore aeiouy
 /**
 * A WeightedMapDef enables setting weights for edits between related characters and substrings.
 *
@@ -467,7 +466,6 @@ interface DictionaryInformation {
   */
   ignore?: CharacterSet;
 }
-// cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ aàâä eéèêë iîïy
 interface HunspellInformation {
   /**
   * Selected Hunspell AFF content.
@@ -496,7 +494,6 @@ interface HunspellInformation {
   /** The costs to apply when using the hunspell settings */
   costs?: HunspellCosts;
 }
-// cspell:ignore OCONV
 /**
 * Selected Hunspell AFF content.
 * The content must be UTF-8
@@ -636,7 +633,6 @@ interface InlineDictionary {
   * List of words to be considered correct.
   */
   words?: string[];
-  // cspell:ignore colour color canot incase
   /**
   * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
   *
@@ -1154,14 +1150,13 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   */
   features?: Features;
 }
-/* eslint-disable no-irregular-whitespace */
 /**
 * In the below JSDoc comment, we helpfully specify an example configuration for the end-user to
 * reference. And this example will get captured by the automatic documentation generator.
 *
 * However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the
 * same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in
-* between the "*" and the "/" symbols.
+* between the "*" and the "/" symbols. The zero-width space is automatically removed by the schema generator.
 */
 interface ExtendableSettings extends Settings {
   /**
@@ -1187,16 +1182,12 @@ interface ExtendableSettings extends Settings {
   overrides?: OverrideSettings[];
 }
 interface SpellCheckerExtensionSettings {
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes} to Enable / Disable checking files types.
   * @title Enabled Language Ids
   * @uniqueItems true
   */
   enabledLanguageIds?: LanguageIdSingle[];
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Enable / Disable checking file types (languageIds).
   *
@@ -1311,7 +1302,6 @@ interface CacheSettings {
   * @default false
   */
   useCache?: boolean;
-  // cspell:word cspellcache
   /**
   * Path to the cache location. Can be a file or a directory.
   * If none specified `.cspellcache` will be used.
@@ -1649,7 +1639,6 @@ interface RegExpPatternDefinition {
   description?: string | undefined;
 }
 type CSpellUserSettingsWithComments = CSpellUserSettings;
-// Remove BaseSource from the Source list when the code is ready.
 type Source = FileSource | MergeSource | InMemorySource | BaseSource;
 interface FileSource extends BaseSource {
   /** Name of source. */

package/dist/index.d.ts

@@ -327,7 +327,6 @@ interface UnknownWordsConfiguration {
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
-// cspell:ignore aeiouy
 /**
 * A WeightedMapDef enables setting weights for edits between related characters and substrings.
 *
@@ -467,7 +466,6 @@ interface DictionaryInformation {
   */
   ignore?: CharacterSet;
 }
-// cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ aàâä eéèêë iîïy
 interface HunspellInformation {
   /**
   * Selected Hunspell AFF content.
@@ -496,7 +494,6 @@ interface HunspellInformation {
   /** The costs to apply when using the hunspell settings */
   costs?: HunspellCosts;
 }
-// cspell:ignore OCONV
 /**
 * Selected Hunspell AFF content.
 * The content must be UTF-8
@@ -636,7 +633,6 @@ interface InlineDictionary {
   * List of words to be considered correct.
   */
   words?: string[];
-  // cspell:ignore colour color canot incase
   /**
   * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
   *
@@ -1154,14 +1150,13 @@ interface FileSettings extends ExtendableSettings, CommandLineSettings {
   */
   features?: Features;
 }
-/* eslint-disable no-irregular-whitespace */
 /**
 * In the below JSDoc comment, we helpfully specify an example configuration for the end-user to
 * reference. And this example will get captured by the automatic documentation generator.
 *
 * However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the
 * same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in
-* between the "*" and the "/" symbols.
+* between the "*" and the "/" symbols. The zero-width space is automatically removed by the schema generator.
 */
 interface ExtendableSettings extends Settings {
   /**
@@ -1187,16 +1182,12 @@ interface ExtendableSettings extends Settings {
   overrides?: OverrideSettings[];
 }
 interface SpellCheckerExtensionSettings {
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes} to Enable / Disable checking files types.
   * @title Enabled Language Ids
   * @uniqueItems true
   */
   enabledLanguageIds?: LanguageIdSingle[];
-  // * @deprecated true
-  // * @deprecationMessage - Use {@link Settings.enabledFileTypes} instead.
   /**
   * Enable / Disable checking file types (languageIds).
   *
@@ -1311,7 +1302,6 @@ interface CacheSettings {
   * @default false
   */
   useCache?: boolean;
-  // cspell:word cspellcache
   /**
   * Path to the cache location. Can be a file or a directory.
   * If none specified `.cspellcache` will be used.
@@ -1649,7 +1639,6 @@ interface RegExpPatternDefinition {
   description?: string | undefined;
 }
 type CSpellUserSettingsWithComments = CSpellUserSettings;
-// Remove BaseSource from the Source list when the code is ready.
 type Source = FileSource | MergeSource | InMemorySource | BaseSource;
 interface FileSource extends BaseSource {
   /** Name of source. */

package/package.json

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