@cspell/cspell-types - npm Package Compare versions

Comparing version 8.9.1 to 8.10.0

dist/CSpellSettingsDef.d.ts

@@ -82,3 +82,3 @@ import type { ReporterConfigurationBase } from './CSpellReporter.js';
      *
-     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
+     * Glob patterns are relative to the {@link globRoot} of the configuration file that defines them.
      */
@@ -410,3 +410,3 @@ ignorePaths?: Glob[];
     /**
-     * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
+     * True to enable compound word checking.
      *
@@ -419,2 +419,4 @@ * @default false
      *
+     * See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
+     *
      * - `false` - Case is ignored and accents can be missing on the entire word.
@@ -499,4 +501,4 @@ *   Incorrect accents or partially missing accents will be marked as incorrect.
     /**
-     * Defines a list of patterns that can be used with the `ignoreRegExpList` and
-     * `includeRegExpList` options.
+     * Defines a list of patterns that can be used with the {@link ignoreRegExpList} and
+     * {@link includeRegExpList} options.
      *
@@ -523,4 +525,2 @@ * For example:
      * ```
-     * Defines a list of patterns that can be used with the `ignoreRegExpList` and
-     * `includeRegExpList` options.
      */
@@ -534,12 +534,12 @@ patterns?: RegExpPatternDefinition[];
 export interface LanguageSettingFilterFieldsPreferred {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
+    /** The language id.  Ex: `typescript`, `html`, or `php`.  `*` -- will match all languages. */
     languageId: MatchingFileType;
-    /** The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. */
+    /** The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales. */
     locale?: LocaleId | LocaleId[];
 }
 export interface LanguageSettingFilterFieldsDeprecated {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages. */
+    /** The language id.  Ex: `typescript`, `html`, or `php`.  `*` -- will match all languages. */
     languageId: MatchingFileType;
     /**
-     * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
+     * Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.
      * @deprecated true
@@ -560,3 +560,3 @@ * @deprecationMessage Use `locale` instead.
 export type RegExpPatternList = PatternRef[];
-/** This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. */
+/** This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,fr` for both English and French */
 export type LocaleId = string;
@@ -601,3 +601,5 @@ /**
 /**
- * This can be '*', 'typescript', 'cpp', 'json', etc.
+ * A file type:
+ * - `*` - will match ALL file types.
+ * - `typescript`, `cpp`, `json`, etc.
  * @pattern ^(!?[-\w_\s]+)|(\*)$
@@ -607,3 +609,6 @@ */
 /**
- * This can be 'typescript,cpp,json,literal haskell', etc.
+ * A single string with a comma separated list of file types:
+ * - `typescript,cpp`
+ * - `json,jsonc,yaml`
+ * - etc.
  * @pattern ^([-\w_\s]+)(,[-\w_\s]+)*$
@@ -613,4 +618,7 @@ */
 /**
- * This can be 'typescript,cpp,json,literal haskell', etc.
- * @pattern ^(![-\w_\s]+)(,![-\w_\s]+)*$
+ * A Negative File Type used to exclude files of that type.
+ * - `!typescript` - will exclude typescript files.
+ * - `!cpp,!json` - will exclude cpp and json files.
+ * - `!typescript,javascript` - will exclude typescript files and include javascript files.
+ * @pattern ^(![-\w_\s]+)(,!?[-\w_\s]+)*$
  */
@@ -726,3 +734,3 @@ export type LanguageIdMultipleNeg = string;
 /**
- * Extends CSpellSettings with ExperimentalFileSettings
+ * Extends CSpellSettings with {@link ExperimentalFileSettings}
  * @experimental
@@ -729,0 +737,0 @@ * @hidden

dist/defineConfig.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineConfig = void 0;
+exports.defineConfig = defineConfig;
 function defineConfig(config) {
     return config;
 }
-exports.defineConfig = defineConfig;
 //# sourceMappingURL=defineConfig.js.map

dist/DictionaryDefinition.d.ts

@@ -17,3 +17,5 @@ import type { DictionaryInformation } from './DictionaryInformation.js';
     name: DictionaryId;
-    /** Optional description. */
+    /**
+     * Optional description of the contents / purpose of the dictionary.
+     */
     description?: string;
@@ -33,3 +35,3 @@ /** Replacement pairs. */
      */
-    noSuggest?: boolean;
+    noSuggest?: boolean | undefined;
     /**
@@ -44,5 +46,8 @@ * Type of file:
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     *
+     * Note: this settings does not apply to inline dictionaries or `.trie` files.
+     *
      * @default "S"
      */
-    type?: DictionaryFileTypes;
+    type?: DictionaryFileTypes | undefined;
 }
@@ -55,3 +60,3 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
      * @deprecated true
-     * @deprecationMessage Use `path` instead.
+     * @deprecationMessage Use {@link path} instead.
      * @hidden
@@ -79,8 +84,16 @@ */
     /**
-     * Note used
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
+     * Not used
      * @hidden
      */
     file?: undefined;
+    /**
+     * Not used
+     * @hidden
+     */
+    type?: DictionaryDefinitionBase['type'];
+    /**
+     * Use `ignoreWords` instead.
+     * @hidden
+     */
+    noSuggest?: DictionaryDefinitionBase['noSuggest'];
 }
@@ -96,2 +109,5 @@ export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
 }
+export interface DictionaryDefinitionInlineSuggestWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'suggestWords'>> {
+    suggestWords: string[];
+}
 /**
@@ -101,7 +117,7 @@ * Inline Dictionary Definitions
  */
-export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
+export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords | DictionaryDefinitionInlineSuggestWords;
 /**
  * Only for legacy dictionary definitions.
  * @deprecated true
- * @deprecationMessage Use `DictionaryDefinitionPreferred` instead.
+ * @deprecationMessage Use {@link DictionaryDefinitionPreferred} instead.
  */
@@ -130,3 +146,3 @@ export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
      * @deprecated true
-     * @deprecationMessage Use `path` instead.
+     * @deprecationMessage Use {@link path} instead.
      */
@@ -133,0 +149,0 @@ file: FsDictionaryPath;

package.json

@@ -6,3 +6,3 @@ {
   },
-  "version": "8.9.1",
+  "version": "8.10.0",
   "description": "Types for cspell and cspell-lib",
@@ -90,3 +90,3 @@ "type": "commonjs",
   },
-  "gitHead": "f532c77cca4bfae380293c586f02f377354c850b"
+  "gitHead": "a5dde6ae7e2ac86ac956220d4b8c39a0e58e1bc6"
 }

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

209434

increased by4.2%

Lines of code

4084

increased by3.13%

Worsened metrics

Published versions last week

1

decreased by-66.67%

No dependency changes