@cspell/cspell-types 5.12.1 → 5.12.6

package/cspell.schema.json

@@ -55,6 +55,11 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs"
         },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+        },
         "useCompounds": {
           "description": "Use Compounds",
           "type": "boolean"
@@ -108,6 +113,11 @@
           ],
           "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`"
         },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+        },
         "useCompounds": {
           "description": "Use Compounds",
           "type": "boolean"
@@ -143,6 +153,11 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs"
         },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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) Default is S C is the slowest to load due to the need to split each line based upon code splitting rules."
+        },
         "useCompounds": {
           "description": "Use Compounds",
           "type": "boolean"
@@ -154,6 +169,15 @@
       ],
       "type": "object"
     },
+    "DictionaryFileTypes": {
+      "enum": [
+        "S",
+        "W",
+        "C",
+        "T"
+      ],
+      "type": "string"
+    },
     "DictionaryId": {
       "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`",
       "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
@@ -230,7 +254,7 @@
         },
         "caseSensitive": {
           "default": false,
-          "description": "Words must match case rules.",
+          "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
           "type": "boolean"
         },
         "description": {
@@ -370,7 +394,7 @@
         },
         "caseSensitive": {
           "default": false,
-          "description": "Words must match case rules.",
+          "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
           "type": "boolean"
         },
         "description": {
@@ -713,7 +737,7 @@
     },
     "caseSensitive": {
       "default": false,
-      "description": "Words must match case rules.",
+      "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
       "type": "boolean"
     },
     "description": {

package/dist/CSpellSettingsDef.d.ts

@@ -252,7 +252,12 @@ export interface BaseSetting {
      */
     allowCompoundWords?: boolean;
     /**
-     * Words must match case rules.
+     * Determines if words must match case and accent rules.
+     *
+     * - `false` - Case is ignored and accents can be missing on the entire word.
+     *   Incorrect accents or partially missing accents will be marked as incorrect.
+     * - `true` - Case and accents are enforced.
+     *
      * @default false
      */
     caseSensitive?: boolean;
@@ -319,6 +324,16 @@ export interface DictionaryDefinitionBase {
      * possible suggestions.
      */
     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)
+     * Default is S
+     * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     * @default "S"
+     */
+    type?: DictionaryFileTypes;
 }
 export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
     /** Path to the file */

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.12.1",
+  "version": "5.12.6",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -49,12 +49,12 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^27.2.4",
+    "jest": "^27.3.1",
     "rimraf": "^3.0.2",
-    "ts-json-schema-generator": "^0.95.0",
-    "typedoc": "^0.22.5",
-    "typedoc-plugin-markdown": "^3.11.2",
-    "typescript": "^4.4.3"
+    "ts-json-schema-generator": "^0.96.0",
+    "typedoc": "^0.22.7",
+    "typedoc-plugin-markdown": "^3.11.3",
+    "typescript": "^4.4.4"
   },
-  "gitHead": "43a626145377e1f760ad51fc58701313c7a26243"
+  "gitHead": "430bb6103b03793d5f0b746e7c643d12fa313216"
 }