@cspell/cspell-types 9.3.1 → 9.4.0

package/cspell.schema.json

@@ -1408,6 +1408,15 @@
           "markdownDescription": "The maximum number of times the same word can be flagged as an error in a file.",
           "type": "number"
         },
+        "maxFileSize": {
+          "description": "The Maximum size of a file to spell check. This is used to prevent spell checking very large files.\n\nThe value can be number or a string formatted `<number>[units]`, number with optional units.\n\nSupported units:\n\n- K, KB - value * 1024\n- M, MB - value * 2^20\n- G, GB - value * 2^30\n\nSpecial values:\n- `0` - has the effect of removing the limit.\n\nExamples:\n- `1000000` - 1 million bytes\n- `1000K` or `1000KB` - 1 thousand kilobytes\n- `0.5M` or `0.5MB` - 0.5 megabytes\n\ndefault: no limit",
+          "markdownDescription": "The Maximum size of a file to spell check. This is used to prevent spell checking very large files.\n\nThe value can be number or a string formatted `<number>[units]`, number with optional units.\n\nSupported units:\n\n- K, KB - value * 1024\n- M, MB - value * 2^20\n- G, GB - value * 2^30\n\nSpecial values:\n- `0` - has the effect of removing the limit.\n\nExamples:\n- `1000000` - 1 million bytes\n- `1000K` or `1000KB` - 1 thousand kilobytes\n- `0.5M` or `0.5MB` - 0.5 megabytes\n\ndefault: no limit",
+          "since": "9.4.0",
+          "type": [
+            "number",
+            "string"
+          ]
+        },
         "maxNumberOfProblems": {
           "default": 10000,
           "description": "The maximum number of problems to report in a file.",
@@ -1994,6 +2003,15 @@
       "markdownDescription": "The maximum number of times the same word can be flagged as an error in a file.",
       "type": "number"
     },
+    "maxFileSize": {
+      "description": "The Maximum size of a file to spell check. This is used to prevent spell checking very large files.\n\nThe value can be number or a string formatted `<number>[units]`, number with optional units.\n\nSupported units:\n\n- K, KB - value * 1024\n- M, MB - value * 2^20\n- G, GB - value * 2^30\n\nSpecial values:\n- `0` - has the effect of removing the limit.\n\nExamples:\n- `1000000` - 1 million bytes\n- `1000K` or `1000KB` - 1 thousand kilobytes\n- `0.5M` or `0.5MB` - 0.5 megabytes\n\ndefault: no limit",
+      "markdownDescription": "The Maximum size of a file to spell check. This is used to prevent spell checking very large files.\n\nThe value can be number or a string formatted `<number>[units]`, number with optional units.\n\nSupported units:\n\n- K, KB - value * 1024\n- M, MB - value * 2^20\n- G, GB - value * 2^30\n\nSpecial values:\n- `0` - has the effect of removing the limit.\n\nExamples:\n- `1000000` - 1 million bytes\n- `1000K` or `1000KB` - 1 thousand kilobytes\n- `0.5M` or `0.5MB` - 0.5 megabytes\n\ndefault: no limit",
+      "since": "9.4.0",
+      "type": [
+        "number",
+        "string"
+      ]
+    },
     "maxNumberOfProblems": {
       "default": 10000,
       "description": "The maximum number of problems to report in a file.",

package/dist/Parser/index.d.mts

@@ -1,2 +1,2 @@
-import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-BUF_NEXq.mjs";
+import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-TAd2zi6U.mjs";
 export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };

package/dist/Parser/index.d.ts

@@ -1,2 +1,2 @@
-import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-DwYzcMHK.js";
+import { a as ParserName, c as Scope, d as SourceMap, i as Parser, l as ScopeChain, n as ParseResult, o as ParserOptions, r as ParsedText, s as Range, t as DelegateInfo, u as ScopeString } from "../index-BtvDF-9G.js";
 export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };

package/dist/{index-DwYzcMHK.d.ts → index-BtvDF-9G.d.ts}

@@ -126,4 +126,4 @@ type ScopeString = string;
 type Scope = ScopeChain | ScopeString;
 //#endregion
 export { ParserName as a, Scope as c, SourceMap as d, Parser as i, ScopeChain as l, ParseResult as n, ParserOptions as o, ParsedText as r, Range as s, DelegateInfo as t, ScopeString as u };
-//# sourceMappingURL=index-DwYzcMHK.d.ts.map
+//# sourceMappingURL=index-BtvDF-9G.d.ts.map

package/dist/{index-BUF_NEXq.d.mts → index-TAd2zi6U.d.mts}

@@ -126,4 +126,4 @@ type ScopeString = string;
 type Scope = ScopeChain | ScopeString;
 //#endregion
 export { ParserName as a, Scope as c, SourceMap as d, Parser as i, ScopeChain as l, ParseResult as n, ParserOptions as o, ParsedText as r, Range as s, DelegateInfo as t, ScopeString as u };
-//# sourceMappingURL=index-BUF_NEXq.d.mts.map
+//# sourceMappingURL=index-TAd2zi6U.d.mts.map

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-BUF_NEXq.mjs";
+import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-TAd2zi6U.mjs";
 
 //#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
@@ -155,6 +155,10 @@ interface ProgressFileComplete extends ProgressFileBase {
   */
   processed: boolean | undefined;
   /**
+  * Optional reason for skipping the file.
+  */
+  skippedReason?: string | undefined;
+  /**
   * Number of errors and issues found in the file.
   */
   numErrors: number | undefined;
@@ -188,8 +192,10 @@ interface RunResult {
   issues: number;
   /** Number of processing errors. */
   errors: number;
-  /** Number files that used results from the cache. */
+  /** Number of files that used results from the cache. */
   cachedFiles?: number;
+  /** Number of files that were skipped (not processed). */
+  skippedFiles?: number;
 }
 type ResultEmitter = (result: RunResult) => void | Promise<void>;
 interface CSpellReporterEmitters {
@@ -245,6 +251,10 @@ interface ReporterCommandLineOptions {
   */
   verbose?: boolean;
   /**
+  * Level of verbosity (higher number = more verbose).
+  */
+  verboseLevel?: number;
+  /**
   * Show extensive output.
   */
   debug?: boolean;
@@ -1266,6 +1276,29 @@ interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings, Spe
   * @default true
   */
   loadDefaultConfiguration?: boolean;
+  /**
+  * The Maximum size of a file to spell check. This is used to prevent spell checking very large files.
+  *
+  * The value can be number or a string formatted `<number>[units]`, number with optional units.
+  *
+  * Supported units:
+  *
+  * - K, KB - value * 1024
+  * - M, MB - value * 2^20
+  * - G, GB - value * 2^30
+  *
+  * Special values:
+  * - `0` - has the effect of removing the limit.
+  *
+  * Examples:
+  * - `1000000` - 1 million bytes
+  * - `1000K` or `1000KB` - 1 thousand kilobytes
+  * - `0.5M` or `0.5MB` - 0.5 megabytes
+  *
+  * default: no limit
+  * @since 9.4.0
+  */
+  maxFileSize?: number | string | undefined;
 }
 /**
 * Plug N Play settings to support package systems like Yarn 2.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-DwYzcMHK.js";
+import { a as ParserName, i as Parser, n as ParseResult, o as ParserOptions, r as ParsedText } from "./index-BtvDF-9G.js";
 
 //#region src/SuggestionsConfiguration.d.ts
 interface SuggestionsConfiguration {
@@ -155,6 +155,10 @@ interface ProgressFileComplete extends ProgressFileBase {
   */
   processed: boolean | undefined;
   /**
+  * Optional reason for skipping the file.
+  */
+  skippedReason?: string | undefined;
+  /**
   * Number of errors and issues found in the file.
   */
   numErrors: number | undefined;
@@ -188,8 +192,10 @@ interface RunResult {
   issues: number;
   /** Number of processing errors. */
   errors: number;
-  /** Number files that used results from the cache. */
+  /** Number of files that used results from the cache. */
   cachedFiles?: number;
+  /** Number of files that were skipped (not processed). */
+  skippedFiles?: number;
 }
 type ResultEmitter = (result: RunResult) => void | Promise<void>;
 interface CSpellReporterEmitters {
@@ -245,6 +251,10 @@ interface ReporterCommandLineOptions {
   */
   verbose?: boolean;
   /**
+  * Level of verbosity (higher number = more verbose).
+  */
+  verboseLevel?: number;
+  /**
   * Show extensive output.
   */
   debug?: boolean;
@@ -1266,6 +1276,29 @@ interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings, Spe
   * @default true
   */
   loadDefaultConfiguration?: boolean;
+  /**
+  * The Maximum size of a file to spell check. This is used to prevent spell checking very large files.
+  *
+  * The value can be number or a string formatted `<number>[units]`, number with optional units.
+  *
+  * Supported units:
+  *
+  * - K, KB - value * 1024
+  * - M, MB - value * 2^20
+  * - G, GB - value * 2^30
+  *
+  * Special values:
+  * - `0` - has the effect of removing the limit.
+  *
+  * Examples:
+  * - `1000000` - 1 million bytes
+  * - `1000K` or `1000KB` - 1 thousand kilobytes
+  * - `0.5M` or `0.5MB` - 0.5 megabytes
+  *
+  * default: no limit
+  * @since 9.4.0
+  */
+  maxFileSize?: number | string | undefined;
 }
 /**
 * Plug N Play settings to support package systems like Yarn 2.

package/dist/index.js

@@ -29,6 +29,7 @@ const ConfigFields = {
 	languageSettings: "languageSettings",
 	loadDefaultConfiguration: "loadDefaultConfiguration",
 	maxDuplicateProblems: "maxDuplicateProblems",
+	maxFileSize: "maxFileSize",
 	maxNumberOfProblems: "maxNumberOfProblems",
 	minWordLength: "minWordLength",
 	minRandomLength: "minRandomLength",
@@ -93,4 +94,5 @@ exports.IssueType = IssueType;
 exports.MessageTypes = MessageTypes;
 exports.defaultCSpellSettings = defaultCSpellSettings;
 exports.defineConfig = defineConfig;
-exports.unknownWordsChoices = unknownWordsChoices;
+exports.unknownWordsChoices = unknownWordsChoices;
+//# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -28,6 +28,7 @@ const ConfigFields = {
 	languageSettings: "languageSettings",
 	loadDefaultConfiguration: "loadDefaultConfiguration",
 	maxDuplicateProblems: "maxDuplicateProblems",
+	maxFileSize: "maxFileSize",
 	maxNumberOfProblems: "maxNumberOfProblems",
 	minWordLength: "minWordLength",
 	minRandomLength: "minRandomLength",

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.3.1",
+  "version": "9.4.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -52,7 +52,7 @@
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "pnpm build:tsc && pnpm build:tsdown && pnpm run build-schema",
     "build:tsc": "tsc -p tsconfig.json",
-    "build:tsdown": "tsdown --entry src/index.ts --entry src/Parser/index.ts --format cjs,esm  --dts --out-dir dist",
+    "build:tsdown": "tsdown",
     "build-schema": "pnpm build-cspell-schema",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
@@ -86,5 +86,5 @@
     "node": ">=20"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "3f8bf5c88cda393b581957b7f8efc696e432f6f1"
+  "gitHead": "12dba3d8b880384d1401c765cb2186647f5a266f"
 }