@cspell/cspell-types 5.14.0 → 5.15.0

package/cspell.schema.json

@@ -2,6 +2,34 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "additionalProperties": false,
   "definitions": {
+    "CacheSettings": {
+      "additionalProperties": false,
+      "properties": {
+        "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"
+        },
+        "cacheStrategy": {
+          "$ref": "#/definitions/CacheStrategy",
+          "default": "metadata",
+          "description": "Strategy to use for detecting changed files, default: metadata"
+        },
+        "useCache": {
+          "default": false,
+          "description": "Store the results of processed files in order to only operate on the changed ones.",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "CacheStrategy": {
+      "description": "The Strategy to use to detect if a file has changed.\n- `metadata` - uses the file system timestamp and size to detect changes (fastest).\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).",
+      "enum": [
+        "metadata",
+        "content"
+      ],
+      "type": "string"
+    },
     "CustomDictionaryPath": {
       "description": "A File System Path to a dictionary file.",
       "pattern": "^.*\\.txt$",
@@ -210,8 +238,12 @@
       ],
       "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
     },
+    "FSPathResolvable": {
+      "$ref": "#/definitions/FsPath",
+      "description": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."
+    },
     "FsPath": {
-      "description": "A File System Path.",
+      "description": "A File System Path. Relative paths are relative to the configuration file.",
       "type": "string"
     },
     "Glob": {
@@ -596,6 +628,8 @@
     "PredefinedPatterns": {
       "enum": [
         "Base64",
+        "Base64MultiLine",
+        "Base64SingleLine",
         "CStyleComment",
         "CStyleHexValue",
         "CSSHexValue",
@@ -608,7 +642,9 @@
         "PhpHereDoc",
         "PublicKey",
         "RsaCert",
+        "SshRsa",
         "SHA",
+        "HashStrings",
         "SpellCheckerDisable",
         "SpellCheckerDisableBlock",
         "SpellCheckerDisableLine",
@@ -738,6 +774,10 @@
       "description": "True to enable compound word checking.",
       "type": "boolean"
     },
+    "cache": {
+      "$ref": "#/definitions/CacheSettings",
+      "description": "Define cache settings."
+    },
     "caseSensitive": {
       "default": false,
       "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.",
@@ -817,7 +857,7 @@
       "description": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root."
     },
     "globRoot": {
-      "$ref": "#/definitions/FsPath",
+      "$ref": "#/definitions/FSPathResolvable",
       "description": "The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
     },
     "id": {

package/dist/CSpellReporter.d.ts

@@ -36,10 +36,16 @@ export interface ProgressFileComplete extends ProgressBase {
 }
 export declare type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
 export interface RunResult {
+    /** Number of files processed. */
     files: number;
+    /** Set of files where issues were found. */
     filesWithIssues: Set<string>;
+    /** Number of issues found. */
     issues: number;
+    /** Number of processing errors. */
     errors: number;
+    /** Number files that used results from the cache. */
+    cachedFiles: number;
 }
 export declare type ResultEmitter = (result: RunResult) => void | Promise<void>;
 export interface CSpellReporter {

package/dist/CSpellSettingsDef.d.ts

@@ -18,7 +18,7 @@ export interface CSpellSettingsWithSourceTrace extends CSpellSettings {
     __importRef?: ImportFileRef;
     __imports?: Map<string, ImportFileRef>;
 }
-export interface FileSettings extends ExtendableSettings {
+export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /**
      * Configuration format version of the settings file.
      * @default "0.2"
@@ -43,7 +43,7 @@ export interface FileSettings extends ExtendableSettings {
      * - `.` - will be the location of the containing configuration file.
      *
      */
-    globRoot?: FsPath;
+    globRoot?: FSPathResolvable;
     /**
      * Glob patterns of files to be checked.
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
@@ -184,6 +184,39 @@ export interface PnPSettings {
      */
     pnpFiles?: string[];
 }
+/**
+ * The Strategy to use to detect if a file has changed.
+ * - `metadata` - uses the file system timestamp and size to detect changes (fastest).
+ * - `content` - uses a hash of the file content to check file changes (slower - more accurate).
+ */
+export declare type CacheStrategy = 'metadata' | 'content';
+export interface CacheSettings {
+    /**
+     * Store the results of processed files in order to only operate on the changed ones.
+     * @default false
+     */
+    useCache?: boolean;
+    /**
+     * 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
+     */
+    cacheLocation?: FSPathResolvable;
+    /**
+     * Strategy to use for detecting changed files, default: metadata
+     * @default 'metadata'
+     */
+    cacheStrategy?: CacheStrategy;
+}
+/**
+ * These are settings only used by the command line application.
+ */
+export interface CommandLineSettings {
+    /**
+     * Define cache settings.
+     */
+    cache?: CacheSettings;
+}
 /**
  * To prevent the unwanted execution of untrusted code, WorkspaceTrustSettings
  * are use to set the trust levels.
@@ -439,7 +472,7 @@ export interface LanguageSettingFilterFieldsDeprecated {
 /** @hidden */
 declare type InternalRegExp = RegExp;
 export declare type Pattern = string | InternalRegExp;
-export declare type PredefinedPatterns = 'Base64' | 'CStyleComment' | 'CStyleHexValue' | 'CSSHexValue' | 'CommitHash' | 'CommitHashLink' | 'Email' | 'EscapeCharacters' | 'HexValues' | 'href' | 'PhpHereDoc' | 'PublicKey' | 'RsaCert' | 'SHA' | 'SpellCheckerDisable' | 'SpellCheckerDisableBlock' | 'SpellCheckerDisableLine' | 'SpellCheckerDisableNext' | 'SpellCheckerIgnoreInDocSetting' | 'string' | 'UnicodeRef' | 'Urls' | 'UUID' | 'Everything';
+export declare type PredefinedPatterns = 'Base64' | 'Base64MultiLine' | 'Base64SingleLine' | 'CStyleComment' | 'CStyleHexValue' | 'CSSHexValue' | 'CommitHash' | 'CommitHashLink' | 'Email' | 'EscapeCharacters' | 'HexValues' | 'href' | 'PhpHereDoc' | 'PublicKey' | 'RsaCert' | 'SshRsa' | 'SHA' | 'HashStrings' | 'SpellCheckerDisable' | 'SpellCheckerDisableBlock' | 'SpellCheckerDisableLine' | 'SpellCheckerDisableNext' | 'SpellCheckerIgnoreInDocSetting' | 'string' | 'UnicodeRef' | 'Urls' | 'UUID' | 'Everything';
 /** This matches the name in a pattern definition. */
 export declare type PatternId = string;
 /** A PatternRef is a Pattern or PatternId. */
@@ -541,8 +574,18 @@ export declare type LanguageIdMultiple = string;
  */
 export declare type LanguageIdMultipleNeg = string;
 export declare type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
-/** A File System Path. */
+/**
+ * A File System Path. Relative paths are relative to the configuration file.
+ */
 export declare type FsPath = string;
+/**
+ * A File System Path.
+ *
+ * Special Properties:
+ * - `${cwd}` prefix - will be replaced with the current working directory.
+ * - Relative paths are relative to the configuration file.
+ */
+export declare type FSPathResolvable = FsPath;
 /** Trust Security Level. */
 export declare type TrustLevel = 'trusted' | 'untrusted';
 /**

package/dist/configFields.d.ts

@@ -0,0 +1,7 @@
+import type { CSpellUserSettings } from './CSpellSettingsDef';
+export declare type ConfigKeys = Exclude<keyof CSpellUserSettings, '$schema' | 'version' | 'id'>;
+export declare type CSpellUserSettingsFields = {
+    [key in ConfigKeys]: key;
+};
+export declare const ConfigFields: CSpellUserSettingsFields;
+//# sourceMappingURL=configFields.d.ts.map

package/dist/configFields.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigFields = void 0;
+exports.ConfigFields = {
+    allowCompoundWords: 'allowCompoundWords',
+    cache: 'cache',
+    caseSensitive: 'caseSensitive',
+    description: 'description',
+    dictionaries: 'dictionaries',
+    dictionaryDefinitions: 'dictionaryDefinitions',
+    enabled: 'enabled',
+    enabledLanguageIds: 'enabledLanguageIds',
+    enableFiletypes: 'enableFiletypes',
+    enableGlobDot: 'enableGlobDot',
+    files: 'files',
+    flagWords: 'flagWords',
+    gitignoreRoot: 'gitignoreRoot',
+    globRoot: 'globRoot',
+    ignorePaths: 'ignorePaths',
+    ignoreRegExpList: 'ignoreRegExpList',
+    ignoreWords: 'ignoreWords',
+    import: 'import',
+    includeRegExpList: 'includeRegExpList',
+    language: 'language',
+    languageId: 'languageId',
+    languageSettings: 'languageSettings',
+    maxDuplicateProblems: 'maxDuplicateProblems',
+    maxNumberOfProblems: 'maxNumberOfProblems',
+    minWordLength: 'minWordLength',
+    name: 'name',
+    noConfigSearch: 'noConfigSearch',
+    noSuggestDictionaries: 'noSuggestDictionaries',
+    numSuggestions: 'numSuggestions',
+    overrides: 'overrides',
+    patterns: 'patterns',
+    pnpFiles: 'pnpFiles',
+    readonly: 'readonly',
+    reporters: 'reporters',
+    showStatus: 'showStatus',
+    spellCheckDelayMs: 'spellCheckDelayMs',
+    suggestionNumChanges: 'suggestionNumChanges',
+    suggestionsTimeout: 'suggestionsTimeout',
+    useGitignore: 'useGitignore',
+    usePnP: 'usePnP',
+    userWords: 'userWords',
+    words: 'words',
+};
+// export const ConfigKeysNames = Object.values(ConfigKeysByField);
+//# sourceMappingURL=configFields.js.map

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export * from './CSpellSettingsDef';
+export { ConfigFields, type CSpellUserSettingsFields } from './configFields';
 export * from './CSpellReporter';
-export * from './TextOffset';
+export * from './CSpellSettingsDef';
+export type { TextDocumentOffset, TextOffset } from './TextOffset';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -10,7 +10,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CSpellSettingsDef"), exports);
+exports.ConfigFields = void 0;
+var configFields_1 = require("./configFields");
+Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_1.ConfigFields; } });
 __exportStar(require("./CSpellReporter"), exports);
-__exportStar(require("./TextOffset"), exports);
+__exportStar(require("./CSpellSettingsDef"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.14.0",
+  "version": "5.15.0",
   "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.4.5",
+    "jest": "^27.4.6",
     "rimraf": "^3.0.2",
     "ts-json-schema-generator": "^0.97.0",
     "typedoc": "^0.22.10",
-    "typedoc-plugin-markdown": "^3.11.8",
+    "typedoc-plugin-markdown": "^3.11.9",
     "typescript": "^4.5.4"
   },
-  "gitHead": "8c8dfb70479584839e8035094771762f77118667"
+  "gitHead": "04d61378054cbecd28df100ca704c7322abab8ba"
 }