@cspell/cspell-types 7.3.4 → 7.3.5

package/dist/CSpellSettingsDef.d.ts

@@ -40,20 +40,12 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /** Words to add to global dictionary -- should only be in the user config file. */
     userWords?: string[];
     /**
-     * @markdownDescription
      * Allows this configuration to inherit configuration for one or more other files.
      *
      * See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.
-     *
-     * @description
-     * Allows this configuration to inherit configuration for one or more other files.
-     *
-     * See https://cspell.org/configuration/imports/ for more details.
-     *
      */
     import?: FsPath | FsPath[];
     /**
-     * @markdownDescription
      * The root to use for glob patterns found in this configuration.
      * Default: location of the configuration file.
      *   For compatibility reasons, config files with version 0.1, the glob root will
@@ -67,17 +59,9 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      * - `${cwd}` - will be replaced with the current working directory.
      * - `.` - will be the location of the containing configuration file.
      *
-     * @description
-     * The root to use for glob patterns found in this configuration.
      */
     globRoot?: FSPathResolvable;
     /**
-     * @markdownDescription
-     * Glob patterns of files to be checked.
-     *
-     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
-     *
-     * @description
      * Glob patterns of files to be checked.
      *
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
@@ -112,17 +96,6 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      */
     readonly?: boolean;
     /**
-     * @markdownDescription
-     * Define which reports to use.
-     * `default` - is a special name for the default cli reporter.
-     *
-     * Examples:
-     * - `["default"]` - to use the default reporter
-     * - `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter.
-     * - `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]`
-     * - `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter.
-     *
-     * @description
      * Define which reports to use.
      * `default` - is a special name for the default cli reporter.
      *
@@ -165,7 +138,6 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
  */
 export interface ExtendableSettings extends Settings {
     /**
-     * @markdownDescription
      * Overrides are used to apply settings for specific files in your project.
      *
      * For example:
@@ -184,8 +156,6 @@ export interface ExtendableSettings extends Settings {
      *   }
      * ]
      * ```
-     * @description
-     * Overrides are used to apply settings for specific files in your project.
      */
     overrides?: OverrideSettings[];
 }
@@ -205,10 +175,6 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
     /** languageIds for the files to spell check. */
     enabledLanguageIds?: LanguageIdSingle[];
     /**
-     * @title File Types to Check
-     * @scope resource
-     * @uniqueItems true
-     * @markdownDescription
      * Enable / Disable checking file types (languageIds).
      *
      * These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
@@ -221,16 +187,16 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      * !json       // disable checking for json
      * kotlin      // enable checking for kotlin
      * ```
+     * @title File Types to Check
+     * @scope resource
+     * @uniqueItems true
      */
     enableFiletypes?: LanguageIdSingle[];
     /**
-     * @markdownDescription
      * Additional settings for individual languages.
      *
      * See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
      *
-     * @description
-     * Additional settings for individual languages.
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
@@ -259,16 +225,12 @@ export interface SuggestionsConfiguration {
      */
     suggestionsTimeout?: number;
     /**
-     * @markdownDescription
      * The maximum number of changes allowed on a word to be considered a suggestions.
      *
      * For example, appending an `s` onto `example` -> `examples` is considered 1 change.
      *
      * Range: between 1 and 5.
      *
-     * @description
-     * The maximum number of changes allowed on a word to be considered a suggestions.
-     *
      * @default 3
      */
     suggestionNumChanges?: number;
@@ -407,13 +369,9 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     enabled?: boolean;
     /**
-     * @markdownDescription
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *
-     * @description
-     * True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.
-
-    * @default false
+     * @default false
      */
     allowCompoundWords?: boolean;
     /**
@@ -440,7 +398,6 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     dictionaryDefinitions?: DictionaryDefinition[];
     /**
-     * @markdownDescription
      * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
      *
      * To remove a dictionary from the list, add `!` before the name.
@@ -449,9 +406,6 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *
      * See the [Dictionaries](https://cspell.org/docs/dictionaries/)
      * and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.
-     *
-     * @description
-     * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
      */
     dictionaries?: DictionaryReference[];
     /**
@@ -465,7 +419,6 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     noSuggestDictionaries?: DictionaryReference[];
     /**
-     * @markdownDescription
      * List of regular expression patterns or pattern names to exclude from spell checking.
      *
      * Example: `["href"]` - to exclude html href pattern.
@@ -491,24 +444,18 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *
      * While you can create your own patterns, you can also leverage several patterns that are
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
-     * @description
-     * List of regular expression patterns or pattern names to exclude from spell checking.
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
-     * @markdownDescription
      * List of regular expression patterns or defined pattern names to match for spell checking.
      *
      * If this property is defined, only text matching the included patterns will be checked.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
-     * @description
-     * List of regular expression patterns or defined pattern names to match for spell checking.
      */
     includeRegExpList?: RegExpPatternList;
     /**
-     * @markdownDescription
      * Defines a list of patterns that can be used with the `ignoreRegExpList` and
      * `includeRegExpList` options.
      *
@@ -532,7 +479,6 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *   }
      * ]
      * ```
-     * @description
      * Defines a list of patterns that can be used with the `ignoreRegExpList` and
      * `includeRegExpList` options.
      */

package/dist/DictionaryInformation.d.ts

@@ -17,8 +17,6 @@ export interface DictionaryInformation {
      */
     alphabet?: CharacterSet | CharacterSetCosts[];
     /**
-     * The accent characters.
-     * @markdownDescription
      * The accent characters.
      *
      * Default: `"\u0300-\u0341"`
@@ -54,7 +52,6 @@ export interface DictionaryInformation {
 }
 export interface HunspellInformation {
     /**
-     * @markdownDescription
      * Selected Hunspell AFF content.
      * The content must be UTF-8
      *
@@ -76,18 +73,6 @@ export interface HunspellInformation {
      * MAP oôöOÔÖ
      * MAP (IJ)(IJ)
      * ```
-     *
-     * @description
-     * Selected Hunspell AFF content.
-     * The content must be UTF-8
-     *
-     * Sections:
-     * - TRY
-     * - MAP
-     * - REP
-     * - KEY
-     * - ICONV
-     * - OCONV
      */
     aff: HunspellAffContent;
     /** The costs to apply when using the hunspell settings */

package/dist/InlineDictionary.d.ts

@@ -4,8 +4,6 @@ export interface InlineDictionary {
      */
     words?: string[];
     /**
-     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
-     * @markdownDescription
      * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
      *
      * Format of `flagWords`
@@ -29,11 +27,6 @@ export interface InlineDictionary {
      */
     ignoreWords?: string[];
     /**
-     * A list of suggested replacements for words.
-     * Suggested words provide a way to make preferred suggestions on word replacements.
-     * To hint at a preferred change, but not to require it.
-     *
-     * @markdownDescription
      * A list of suggested replacements for words.
      * Suggested words provide a way to make preferred suggestions on word replacements.
      * To hint at a preferred change, but not to require it.

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.3.4",
+  "version": "7.3.5",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -84,5 +84,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "7849a4ff2561453653fae9b9067b39252aeb773f"
+  "gitHead": "23fb2fbae335526185ab53a22e0cac0f3e8f1a25"
 }