@cspell/cspell-types 6.7.0 → 6.8.0

package/cspell.schema.json

@@ -2,9 +2,21 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "additionalProperties": false,
   "definitions": {
+    "CacheFormat": {
+      "enum": [
+        "legacy",
+        "universal"
+      ],
+      "type": "string"
+    },
     "CacheSettings": {
       "additionalProperties": false,
       "properties": {
+        "cacheFormat": {
+          "$ref": "#/definitions/CacheFormat",
+          "default": "legacy",
+          "description": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format."
+        },
         "cacheLocation": {
           "$ref": "#/definitions/FSPathResolvable",
           "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
@@ -1461,6 +1473,10 @@
       },
       "type": "array"
     },
+    "validateDirectives": {
+      "description": "Verify that the in-document directives are correct.",
+      "type": "boolean"
+    },
     "version": {
       "$ref": "#/definitions/Version",
       "default": "0.2",

package/dist/CSpellReporter.d.ts

@@ -2,8 +2,26 @@ import { TextDocumentOffset, TextOffset } from './TextOffset';
 export interface Issue extends Omit<TextDocumentOffset, 'doc'> {
     /** text surrounding the issue text */
     context: TextOffset;
+    /**
+     * true if the issue has been flagged as a forbidden word.
+     */
     isFlagged?: boolean;
+    /**
+     * An optional array of replacement strings.
+     */
     suggestions?: string[];
+    /**
+     * Issues are spelling issues unless otherwise specified.
+     */
+    issueType?: IssueType;
+    /**
+     * Optional message to show.
+     */
+    message?: string;
+}
+export declare enum IssueType {
+    spelling = 0,
+    directive = 1
 }
 export declare type MessageType = 'Debug' | 'Info' | 'Warning';
 export declare type MessageTypeLookup = {

package/dist/CSpellReporter.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageTypes = void 0;
+exports.MessageTypes = exports.IssueType = void 0;
+var IssueType;
+(function (IssueType) {
+    IssueType[IssueType["spelling"] = 0] = "spelling";
+    IssueType[IssueType["directive"] = 1] = "directive";
+})(IssueType = exports.IssueType || (exports.IssueType = {}));
 exports.MessageTypes = {
     Debug: 'Debug',
     Info: 'Info',

package/dist/CSpellSettingsDef.d.ts

@@ -108,6 +108,10 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      * Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.
      */
     gitignoreRoot?: FsPath | FsPath[];
+    /**
+     * Verify that the in-document directives are correct.
+     */
+    validateDirectives?: boolean;
     /**
      * Configure CSpell features.
      *
@@ -265,6 +269,7 @@ export interface PnPSettings {
  * - `content` - uses a hash of the file content to check file changes (slower - more accurate).
  */
 export declare type CacheStrategy = 'metadata' | 'content';
+export declare type CacheFormat = 'legacy' | 'universal';
 export interface CacheSettings {
     /**
      * Store the results of processed files in order to only operate on the changed ones.
@@ -285,6 +290,13 @@ export interface CacheSettings {
      * @default 'metadata'
      */
     cacheStrategy?: CacheStrategy;
+    /**
+     * Format of the cache file.
+     * - `legacy` - use absolute paths in the cache file
+     * - `universal` - use a sharable format.
+     * @default 'legacy'
+     */
+    cacheFormat?: CacheFormat | undefined;
 }
 /**
  * These are settings only used by the command line application.

package/dist/configFields.js

@@ -46,6 +46,7 @@ exports.ConfigFields = {
     useGitignore: 'useGitignore',
     usePnP: 'usePnP',
     userWords: 'userWords',
+    validateDirectives: 'validateDirectives',
     words: 'words',
     // Experimental
     parser: 'parser',

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -69,5 +69,5 @@
     "ts-json-schema-generator": "^1.0.0",
     "typescript": "^4.7.4"
   },
-  "gitHead": "3a7312a15d2df1507d9e01863ec5842f5a99e0cc"
+  "gitHead": "8a1bd03222ffc9776c2cdd09180db6150abb3f25"
 }