@cspell/cspell-types 7.3.3 → 7.3.5

package/dist/CSpellSettingsDef.d.ts

@@ -175,12 +175,10 @@ 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`.
+     *
      * To disable a language, prefix with `!` as in `!json`,
      *
      * Example:
@@ -189,12 +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[];
     /**
      * Additional settings for individual languages.
      *
      * See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
+     *
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
@@ -477,6 +479,8 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *   }
      * ]
      * ```
+     * Defines a list of patterns that can be used with the `ignoreRegExpList` and
+     * `includeRegExpList` options.
      */
     patterns?: RegExpPatternDefinition[];
 }

package/dist/DictionaryDefinition.d.ts

@@ -32,10 +32,12 @@ export interface DictionaryDefinitionBase {
     noSuggest?: boolean;
     /**
      * 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).
+     * - 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.
      * @default "S"
      */
@@ -123,10 +125,12 @@ export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
     file: FsDictionaryPath;
     /**
      * 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).
+     * - 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.
      * @default "S"
      */
@@ -145,6 +149,7 @@ export type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
  * `user`, `workspace`, or `folder`.
  * When `addWords` is true, indicates that the spell checker can add words
  * to the file.
+ *
  * Note: only plain text files with one word per line are supported at this moment.
  */
 export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
@@ -152,6 +157,7 @@ export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferre
     path: CustomDictionaryPath;
     /**
      * Defines the scope for when words will be added to the dictionary.
+     *
      * Scope values: `user`, `workspace`, `folder`.
      */
     scope?: CustomDictionaryScope | CustomDictionaryScope[];

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.3.3",
+  "version": "7.3.5",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -52,13 +52,11 @@
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "pnpm build:tsc && pnpm run build-schema",
-    "build:tsc": "tsc -b tsconfig.json",
-    "build-schema": "ts-json-schema-generator --no-top-ref --path src/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && shx cp ./cspell.schema.json ../..",
+    "build:tsc": "tsc -p tsconfig.json",
+    "build-schema": "pnpm build-cspell-schema",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
-    "test": "pnpm test:unit && pnpm test:schema",
-    "test:unit": "vitest run",
-    "test:schema": "ajv -s ./cspell.schema.json -d \"cspell.test.{json,yaml}\" -c ./ajv.config.js",
+    "test": "vitest run",
     "prepare": "echo Skip Building Types"
   },
   "repository": {
@@ -86,9 +84,5 @@
   "engines": {
     "node": ">=16"
   },
-  "devDependencies": {
-    "ajv-cli": "^5.0.0",
-    "ts-json-schema-generator": "^1.3.0"
-  },
-  "gitHead": "da65ffafaa6a039cedc52d9e029c53ddd273a1fb"
+  "gitHead": "23fb2fbae335526185ab53a22e0cac0f3e8f1a25"
 }

package/ajv.config.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const keywords = ['deprecationMessage', 'markdownDescription', 'scope'];
-
-function addKeywords(ajv) {
-    for (const keyword of keywords) {
-        ajv.addKeyword(keyword);
-    }
-}
-
-module.exports = addKeywords;