@cspell/cspell-types 5.16.0 → 5.17.0-alpha.0

package/cspell.schema.json

@@ -154,6 +154,9 @@
         {
           "$ref": "#/definitions/DictionaryDefinitionCustom"
         },
+        {
+          "$ref": "#/definitions/DictionaryDefinitionAugmented"
+        },
         {
           "$ref": "#/definitions/DictionaryDefinitionAlternate"
         }
@@ -187,10 +190,6 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -207,6 +206,49 @@
       ],
       "type": "object"
     },
+    "DictionaryDefinitionAugmented": {
+      "additionalProperties": false,
+      "description": "Used to provide extra data related to the dictionary",
+      "properties": {
+        "description": {
+          "description": "Optional description.",
+          "type": "string"
+        },
+        "dictionaryInformation": {
+          "$ref": "#/definitions/DictionaryInformation"
+        },
+        "name": {
+          "$ref": "#/definitions/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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
+        },
+        "noSuggest": {
+          "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+          "type": "boolean"
+        },
+        "path": {
+          "$ref": "#/definitions/DictionaryPath",
+          "description": "Path to the file."
+        },
+        "repMap": {
+          "$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"
+        }
+      },
+      "required": [
+        "name",
+        "path"
+      ],
+      "type": "object"
+    },
     "DictionaryDefinitionCustom": {
       "additionalProperties": false,
       "description": "For Defining Custom dictionaries. They are generally scoped to a `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.",
@@ -249,10 +291,6 @@
           ],
           "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -293,10 +331,6 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -327,6 +361,21 @@
       "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
       "type": "string"
     },
+    "DictionaryInformation": {
+      "additionalProperties": false,
+      "description": "Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\n\nAdded with `v5.16.0`.",
+      "properties": {
+        "hunspellInformation": {
+          "$ref": "#/definitions/HunspellInformation",
+          "description": "Used by dictionary authors"
+        },
+        "suggestionEditCosts": {
+          "$ref": "#/definitions/SuggestionCostsDefs",
+          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list."
+        }
+      },
+      "type": "object"
+    },
     "DictionaryNegRef": {
       "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.",
       "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
@@ -378,6 +427,56 @@
       "$ref": "#/definitions/SimpleGlob",
       "description": "These are glob expressions."
     },
+    "HunspellInformation": {
+      "additionalProperties": false,
+      "properties": {
+        "aff": {
+          "description": "Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(IJ) ```",
+          "type": "string"
+        },
+        "costs": {
+          "additionalProperties": false,
+          "description": "The costs to apply when using the hunspell settings",
+          "properties": {
+            "firstLetterPenalty": {
+              "default": 4,
+              "description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - tryCharCost`.",
+              "type": "number"
+            },
+            "ioConvertCost": {
+              "default": 30,
+              "description": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
+              "type": "number"
+            },
+            "keyboardCost": {
+              "default": 94,
+              "description": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
+              "type": "number"
+            },
+            "mapCost": {
+              "default": 25,
+              "description": "mapSet replacement cost is the cost to substitute one character with another from the same set.\n\nMap characters are considered very similar to each other and are often the cause of simple mistakes.",
+              "type": "number"
+            },
+            "replaceCosts": {
+              "default": 75,
+              "description": "The cost to substitute pairs found in the replace settings.",
+              "type": "number"
+            },
+            "tryCharCost": {
+              "default": 95,
+              "description": "The cost of inserting / deleting / or swapping any `tryChars`",
+              "type": "number"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "aff"
+      ],
+      "type": "object"
+    },
     "LanguageId": {
       "anyOf": [
         {
@@ -976,6 +1075,11 @@
       },
       "type": "array"
     },
+    "failFast": {
+      "default": false,
+      "description": "Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)",
+      "type": "boolean"
+    },
     "features": {
       "$ref": "#/definitions/Features",
       "description": "Configure CSpell features.\n\n- Added with `v5.16.0`."

package/dist/CSpellSettingsDef.d.ts

@@ -1,5 +1,5 @@
-import { Features } from './features';
-import type { SuggestionCostsDefs } from './suggestionCostsDef';
+import type { DictionaryInformation } from './DictionaryInformation';
+import type { Features } from './features';
 export declare type ReplaceEntry = [string, string];
 export declare type ReplaceMap = ReplaceEntry[];
 /**
@@ -227,6 +227,11 @@ export interface CommandLineSettings {
      * Define cache settings.
      */
     cache?: CacheSettings;
+    /**
+     * Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)
+     * @default false
+     */
+    failFast?: boolean;
 }
 /**
  * To prevent the unwanted execution of untrusted code, WorkspaceTrustSettings
@@ -346,7 +351,7 @@ export interface BaseSetting {
     patterns?: RegExpPatternDefinition[];
 }
 export declare type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
-export declare type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+export declare type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export interface DictionaryDefinitionBase {
     /**
      * This is the name of a dictionary.
@@ -385,13 +390,6 @@ export interface DictionaryDefinitionBase {
      * @default "S"
      */
     type?: DictionaryFileTypes;
-    /**
-     * Used in making suggestions. The lower the value, the more likely the suggestion
-     * will be near the top of the suggestion list.
-     *
-     * Added with `v5.16.0`.
-     */
-    suggestionEditCosts?: SuggestionCostsDefs;
 }
 export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
     /** Path to the file. */
@@ -404,6 +402,12 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
      */
     file?: undefined;
 }
+/**
+ * Used to provide extra data related to the dictionary
+ */
+export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
+    dictionaryInformation?: DictionaryInformation;
+}
 /**
  * Only for legacy dictionary definitions.
  * @deprecated true
@@ -418,6 +422,8 @@ export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase
      * @deprecationMessage Use `path` instead.
      */
     file: DictionaryPath;
+    /** @hidden */
+    suggestionEditCosts?: undefined;
 }
 /**
  * @deprecated true
@@ -442,6 +448,10 @@ export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
      * @default "S"
      */
     type?: DictionaryFileTypes;
+    /**
+     * @hidden
+     */
+    suggestionEditCosts?: undefined;
 }
 /**
  * Specifies the scope of a dictionary.

package/dist/DictionaryInformation.d.ts

@@ -0,0 +1,217 @@
+import { SuggestionCostsDefs } from '.';
+/**
+ * Use by dictionary authors to help improve the quality of suggestions
+ * given from the dictionary.
+ *
+ * Added with `v5.16.0`.
+ */
+export interface DictionaryInformation {
+    /**
+     * Used in making suggestions. The lower the value, the more likely the suggestion
+     * will be near the top of the suggestion list.
+     */
+    suggestionEditCosts?: SuggestionCostsDefs | undefined;
+    /**
+     * Used by dictionary authors
+     */
+    hunspellInformation?: HunspellInformation;
+}
+export interface HunspellInformationParsed {
+    /**
+     * This is generally the alphabet used in the dictionary.
+     * It stands for the characters to try using for substitutions
+     * when looking for a suggestions.
+     *
+     * Example:
+     * - Hunspell:
+     *   ```hunspell
+     *   TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+     *   ```
+     * - Use: yaml
+     *   ```yaml
+     *   tryChars: "aeistlunkodmrvpgjhäõbüoöfcwzxðqþ"
+     *   ```
+     * <!--- cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ  --
+     */
+    tryChars?: string;
+    /**
+     * This defines characters that are good substitutes for each other.
+     * - A `()` is need for multi character sequences like letters with multiple accents.
+     * - Separate unrelated characters with `|` or `\n`
+     *
+     * Example:
+     * - Hunspell:
+     *   ```hunspell
+     *   MAP aàâäAÀÂÄ
+     *   MAP eéèêëEÉÈÊË
+     *   MAP iîïyIÎÏY
+     *   MAP oôöOÔÖ
+     *   MAP (IJ)(IJ)
+     *   ```
+     * - Use:
+     *   `yaml`
+     *   ```yaml
+     *   mapSets: |
+     *     aàâäAÀÂÄ|eéèêëEÉÈÊË`
+     *     eéèêëEÉÈÊË|iîïyIÎÏY
+     *     oôöOÔÖ|(IJ)(IJ)
+     *   ```
+     * <!--- cspell:ignore aàâä eéèêë iîïy -->
+     */
+    mapSets?: string | string[];
+    /**
+     * This represents the layout of a common keyboard.
+     * Used for adjacency mistakes.
+     *
+     * Hunspell:
+     * ```hunspell
+     * KEY qwertyuiop|asdfghjkl|zxcvbnm
+     * ```
+     * Use:
+     * ```yaml
+     * keyboard: qwertyuiop|asdfghjkl|zxcvbnm
+     * ```
+     * <!--- cspell:ignore asdfghjkl qwertyuiop zxcvbnm -->
+     */
+    keyboard?: string;
+    /**
+     * Output Conversions
+     *
+     */
+    outConvert?: string | string[];
+    inConvert?: string | string[];
+    /**
+     * Common Substitutions.
+     * Special characters:
+     * - `^` - matches the beginning of a word.
+     * - `$` - matches the end of a word.
+     *
+     * Hunspell:
+     * ```hunspell
+     * REP c ss
+     * REP e ij
+     * REP é ee
+     * REP g ch
+     * REP ï ii
+     * REP t d	# gebiest=>gebiesd
+     * REP u ij
+     * ```
+     *
+     * Use:
+     * ```yaml
+     * replace: |
+     *   c ss
+     *   e ij
+     *   é ee
+     *   g ch
+     *   ï ii
+     *   t d
+     *   u ij
+     * ```
+     *
+     * <!--- cspell:ignore gebiesd gebiest -->
+     */
+    replace?: string | string[];
+    /** The costs to apply when using the hunspell settings */
+    costs?: HunspellCosts;
+}
+export interface HunspellInformation {
+    /**
+     * Selected Hunspell AFF content.
+     * The content must be UTF-8
+     *
+     * Sections:
+     * - TRY
+     * - MAP
+     * - REP
+     * - KEY
+     * - ICONV
+     * - OCONV
+     *
+     * Example:
+     * ```hunspell
+     * # Comment
+     * TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+     * MAP aàâäAÀÂÄ
+     * MAP eéèêëEÉÈÊË
+     * MAP iîïyIÎÏY
+     * MAP oôöOÔÖ
+     * MAP (IJ)(IJ)
+     * ```
+     */
+    aff: HunspellAffContent;
+    /** The costs to apply when using the hunspell settings */
+    costs?: HunspellCosts;
+}
+/**
+ * Selected Hunspell AFF content.
+ * The content must be UTF-8
+ *
+ * Sections:
+ * - TRY
+ * - NO-TRY
+ * - MAP
+ * - REP
+ * - KEY
+ * - ICONV
+ * - OCONV
+ *
+ * Example:
+ * ```hunspell
+ * # Comment
+ * TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+ * NO-TRY -0123456789 # Discourage adding numbers and dashes.
+ * MAP aàâäAÀÂÄ
+ * MAP eéèêëEÉÈÊË
+ * MAP iîïyIÎÏY
+ * MAP oôöOÔÖ
+ * MAP (IJ)(IJ)
+ * ```
+ */
+declare type HunspellAffContent = string;
+interface HunspellCosts {
+    /**
+     * The cost of inserting / deleting / or swapping any `tryChars`
+     * @default 95
+     */
+    tryCharCost?: number;
+    /**
+     * The extra cost incurred for changing the first letter of a word.
+     * This value should be less than `100 - tryCharCost`.
+     * @default 4
+     */
+    firstLetterPenalty?: number;
+    /**
+     * The cost of replacing or swapping any adjacent keyboard characters.
+     *
+     * This should be slightly cheaper than `tryCharCost`.
+     * @default 94
+     */
+    keyboardCost?: number;
+    /**
+     * mapSet replacement cost is the cost to substitute one character with another from
+     * the same set.
+     *
+     * Map characters are considered very similar to each other and are often
+     * the cause of simple mistakes.
+     *
+     * @default 25
+     */
+    mapCost?: number;
+    /**
+     * The cost to convert between convert pairs.
+     *
+     * The value should be slightly higher than the mapCost.
+     *
+     * @default 30
+     */
+    ioConvertCost?: number;
+    /**
+     * The cost to substitute pairs found in the replace settings.
+     *
+     * @default 75
+     */
+    replaceCosts?: number;
+}
+export {};
+//# sourceMappingURL=DictionaryInformation.d.ts.map

package/dist/DictionaryInformation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DictionaryInformation.js.map

package/dist/configFields.js

@@ -12,6 +12,7 @@ exports.ConfigFields = {
     enabledLanguageIds: 'enabledLanguageIds',
     enableFiletypes: 'enableFiletypes',
     enableGlobDot: 'enableGlobDot',
+    failFast: 'failFast',
     features: 'features',
     files: 'files',
     flagWords: 'flagWords',

package/dist/features.d.ts

@@ -1,5 +1,5 @@
 /**
- * These are experimental features and are subject to change or removal.
+ * These are experimental features and are subject to change or removal without notice.
  */
 export interface FeaturesExperimental {
     /**

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.16.0",
+  "version": "5.17.0-alpha.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "build": "npm run compile && npm run build-schema",
     "build-dev": "tsc -p tsconfig.dev.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 && cp ./cspell.schema.json ../..",
-    "build-docs": "typedoc --out ../../docs/types/cspell-types src/index.ts",
+    "build-docs": "rimraf ../../docs/types/cspell-types && typedoc --out ../../docs/types/cspell-types src/index.ts",
     "test-build-docs": "typedoc --out ./temp/docs src/index.ts",
     "clean-build": "npm run clean && npm run build",
     "compile": "tsc -p .",
@@ -55,7 +55,7 @@
     "ts-json-schema-generator": "^0.97.0",
     "typedoc": "0.22.11",
     "typedoc-plugin-markdown": "^3.11.12",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
-  "gitHead": "c5d994f58bdb48c4d16f1708607b28c8a7b52a65"
+  "gitHead": "d884218703cac72186fd69e8ba1e9eb78558c7ca"
 }