@cspell/cspell-types 5.18.1 → 5.18.5

package/cspell.schema.json

@@ -403,8 +403,14 @@
               "type": "array"
             }
           ],
-          "default": "̀-́",
-          "description": "The accent characters"
+          "description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
+        },
+        "adjustments": {
+          "description": "A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.",
+          "items": {
+            "$ref": "#/definitions/PatternAdjustment"
+          },
+          "type": "array"
         },
         "alphabet": {
           "anyOf": [
@@ -948,6 +954,29 @@
     "Pattern": {
       "type": "string"
     },
+    "PatternAdjustment": {
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "description": "Id of the Adjustment, i.e. `short-compound`",
+          "type": "string"
+        },
+        "penalty": {
+          "description": "The amount of penalty to apply.",
+          "type": "number"
+        },
+        "regexp": {
+          "description": "RegExp pattern to match",
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "regexp",
+        "penalty"
+      ],
+      "type": "object"
+    },
     "PatternId": {
       "description": "This matches the name in a pattern definition.",
       "type": "string"
@@ -1128,6 +1157,8 @@
   },
   "properties": {
     "$schema": {
+      "default": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+      "description": "Url to JSON Schema",
       "type": "string"
     },
     "allowCompoundWords": {

package/dist/CSpellReporter.d.ts

@@ -19,21 +19,30 @@ export declare type ErrorLike = Error | {
 };
 export declare type ErrorEmitter = (message: string, error: ErrorLike) => void;
 export declare type SpellingErrorEmitter = (issue: Issue) => void;
-export declare type ProgressTypes = 'ProgressFileComplete';
-export declare type ProgressItem = ProgressFileComplete;
-interface ProgressBase {
+export declare type ProgressTypes = 'ProgressFileBegin' | 'ProgressFileComplete';
+export declare type ProgressItem = ProgressFileBegin | ProgressFileComplete;
+export interface ProgressBase {
     type: ProgressTypes;
 }
-export interface ProgressFileComplete extends ProgressBase {
-    type: 'ProgressFileComplete';
+export interface ProgressFileBase extends ProgressBase {
+    type: ProgressTypes;
     fileNum: number;
     fileCount: number;
     filename: string;
+}
+export interface ProgressFileComplete extends ProgressFileBase {
+    type: 'ProgressFileComplete';
     elapsedTimeMs: number | undefined;
     processed: boolean | undefined;
     numErrors: number | undefined;
     cached?: boolean;
 }
+/**
+ * Notification sent just before processing a file.
+ */
+export interface ProgressFileBegin extends ProgressFileBase {
+    type: 'ProgressFileBegin';
+}
 export declare type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
 export interface RunResult {
     /** Number of files processed. */
@@ -59,5 +68,4 @@ export interface CSpellReporter {
 export interface CSpellReporterModule {
     getReporter: (settings: unknown) => CSpellReporter;
 }
-export {};
 //# sourceMappingURL=CSpellReporter.d.ts.map

package/dist/CSpellSettingsDef.d.ts

@@ -8,6 +8,10 @@ export declare type ReplaceMap = ReplaceEntry[];
 export declare type CSpellPackageSettings = CSpellUserSettings;
 export declare type CSpellUserSettings = CSpellSettings;
 export interface CSpellSettings extends FileSettings, LegacySettings {
+    /**
+     * Url to JSON Schema
+     * @default "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json"
+     */
     $schema?: string;
 }
 export interface ImportFileRef {

package/dist/DictionaryInformation.d.ts

@@ -17,8 +17,9 @@ export interface DictionaryInformation {
      */
     alphabet?: CharacterSet | CharacterSetCosts[];
     /**
-     * The accent characters
-     * @default "\u0300-\u0341"
+     * The accent characters.
+     *
+     * Default: `"\u0300-\u0341"`
      */
     accents?: CharacterSet | CharacterSetCosts[];
     /**
@@ -34,105 +35,11 @@ export interface DictionaryInformation {
      * 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 -->
+     * A collection of patterns to test against the suggested words.
+     * If the word matches the pattern, then the penalty is applied.
      */
-    replace?: string | string[];
-    /** The costs to apply when using the hunspell settings */
-    costs?: HunspellCosts;
+    adjustments?: PatternAdjustment[];
 }
 export interface HunspellInformation {
     /**
@@ -282,5 +189,13 @@ export interface CharacterSetCosts {
      */
     penalty?: number;
 }
+export interface PatternAdjustment {
+    /** Id of the Adjustment, i.e. `short-compound` */
+    id: string;
+    /** RegExp pattern to match */
+    regexp: string | RegExp;
+    /** The amount of penalty to apply. */
+    penalty: number;
+}
 export {};
 //# sourceMappingURL=DictionaryInformation.d.ts.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.18.1",
+  "version": "5.18.5",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -50,12 +50,12 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^27.4.7",
+    "jest": "^27.5.1",
     "rimraf": "^3.0.2",
     "ts-json-schema-generator": "^0.97.0",
     "typedoc": "0.22.11",
-    "typedoc-plugin-markdown": "^3.11.12",
+    "typedoc-plugin-markdown": "^3.11.14",
     "typescript": "^4.5.5"
   },
-  "gitHead": "8b94979b57a7b1a11f8efbd5bc086d29d496f7be"
+  "gitHead": "bff6b01340bde5ca7a89860868e179592eaa7520"
 }