@cspell/cspell-types - npm Package Compare versions

Comparing version 7.3.4 to 7.3.5

dist/CSpellSettingsDef.d.ts

@@ -43,16 +43,8 @@ import type { ReporterConfigurationBase } from './CSpellReporter.js';
     /**
-     * @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.
@@ -71,16 +63,8 @@ * Default: location of the 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.
      */
@@ -117,3 +101,2 @@ files?: Glob[];
     /**
-     * @markdownDescription
      * Define which reports to use.
@@ -128,12 +111,2 @@ * `default` - is a special name for the default cli reporter.
      *
-     * @description
-     * 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.
-     *
      * @default ["default"]
@@ -172,3 +145,2 @@ */
     /**
-     * @markdownDescription
      * Overrides are used to apply settings for specific files in your project.
@@ -192,4 +164,2 @@ *
      * ```
-     * @description
-     * Overrides are used to apply settings for specific files in your project.
      */
@@ -214,6 +184,2 @@ overrides?: OverrideSettings[];
     /**
-     * @title File Types to Check
-     * @scope resource
-     * @uniqueItems true
-     * @markdownDescription
      * Enable / Disable checking file types (languageIds).
@@ -231,6 +197,8 @@ *
      * ```
+     * @title File Types to Check
+     * @scope resource
+     * @uniqueItems true
      */
     enableFiletypes?: LanguageIdSingle[];
     /**
-     * @markdownDescription
      * Additional settings for individual languages.
@@ -240,4 +208,2 @@ *
      *
-     * @description
-     * Additional settings for individual languages.
      */
@@ -271,3 +237,2 @@ languageSettings?: LanguageSetting[];
     /**
-     * @markdownDescription
      * The maximum number of changes allowed on a word to be considered a suggestions.
@@ -279,5 +244,2 @@ *
      *
-     * @description
-     * The maximum number of changes allowed on a word to be considered a suggestions.
-     *
      * @default 3
@@ -421,9 +383,5 @@ */
     /**
-     * @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
      */
@@ -455,3 +413,2 @@ allowCompoundWords?: boolean;
     /**
-     * @markdownDescription
      * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
@@ -465,5 +422,2 @@ *
      * 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.
      */
@@ -482,3 +436,2 @@ dictionaries?: DictionaryReference[];
     /**
-     * @markdownDescription
      * List of regular expression patterns or pattern names to exclude from spell checking.
@@ -509,8 +462,5 @@ *
      * [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.
@@ -522,8 +472,5 @@ *
      * [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
@@ -552,3 +499,2 @@ * `includeRegExpList` options.
      * ```
-     * @description
      * Defines a list of patterns that can be used with the `ignoreRegExpList` and
@@ -555,0 +501,0 @@ * `includeRegExpList` options.

dist/DictionaryInformation.d.ts

@@ -21,4 +21,2 @@ import type { SuggestionCostsDefs } from './suggestionCostsDef.js';
      * The accent characters.
-     * @markdownDescription
-     * The accent characters.
      *
@@ -58,3 +56,2 @@ * Default: `"\u0300-\u0341"`
     /**
-     * @markdownDescription
      * Selected Hunspell AFF content.
@@ -81,14 +78,2 @@ * The content must be UTF-8
      * ```
-     *
-     * @description
-     * Selected Hunspell AFF content.
-     * The content must be UTF-8
-     *
-     * Sections:
-     * - TRY
-     * - MAP
-     * - REP
-     * - KEY
-     * - ICONV
-     * - OCONV
      */
@@ -95,0 +80,0 @@ aff: HunspellAffContent;

dist/InlineDictionary.d.ts

@@ -8,4 +8,2 @@ export interface InlineDictionary {
      * 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`.
      *
@@ -37,7 +35,2 @@ * Format of `flagWords`
      *
-     * @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.
-     *
      * Format of `suggestWords`
@@ -44,0 +37,0 @@ * - Single suggestion (possible auto fix)

package.json

@@ -6,3 +6,3 @@ {
   },
-  "version": "7.3.4",
+  "version": "7.3.5",
   "description": "Types for cspell and cspell-lib",
@@ -88,3 +88,3 @@ "type": "commonjs",
   },
-  "gitHead": "7849a4ff2561453653fae9b9067b39252aeb773f"
+  "gitHead": "23fb2fbae335526185ab53a22e0cac0f3e8f1a25"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

194875

increased by26.94%

Lines of code

3881

increased by5.35%

No dependency changes