cspell 10.3.4 → 10.3.6

package/dist/esm/app.js

@@ -1,4 +1,4 @@
-import { C as ApplicationError, S as width, T as console, _ as padLeft, a as parseApplicationFeatureFlags, b as pruneAnsiTextEnd, c as listDictionaries, d as validateUnitSize, f as unindent, g as tableToLines, i as lint, l as ReportChoicesAll, m as npmPackage, n as checkText, o as suggestions, p as DEFAULT_CACHE_LOCATION, r as createInit, s as trace, t as IncludeExcludeFlag, u as cvtLinterCliCommandOptionsToLinterCliOptions, v as padWidth, w as CheckFailed, x as pruneAnsiTextStart, y as ansiWidth } from "./application-9R1ayzTZ.js";
+import { C as ApplicationError, S as width, T as console, _ as padLeft, a as parseApplicationFeatureFlags, b as pruneAnsiTextEnd, c as listDictionaries, d as validateUnitSize, f as unindent, g as tableToLines, i as lint, l as ReportChoicesAll, m as npmPackage, n as checkText, o as suggestions, p as DEFAULT_CACHE_LOCATION, r as createInit, s as trace, t as IncludeExcludeFlag, u as cvtLinterCliCommandOptionsToLinterCliOptions, v as padWidth, w as CheckFailed, x as pruneAnsiTextStart, y as ansiWidth } from "./application-yI9NNGsb.js";
 import { Link } from "cspell-lib";
 import chalk from "chalk";
 import * as iPath from "node:path";
@@ -402,6 +402,7 @@ async function action(fileGlobs, cliOptions) {
 	const { mustFindFiles, fileList, files, file, forceCheck } = options;
 	if (forceCheck && !file?.length && !files?.length && !fileList?.length) this.error("error: --force-check requires --file, --files, or --file-list to be specified");
 	if (fileGlobs.length && (file?.length || files?.length)) this.error("error: mixing globs and --file is not supported");
+	if (fileGlobs.length && forceCheck) this.error("error: mixing globs and --force-check is not supported");
 	const result = await lint(fileGlobs, options);
 	if (!fileGlobs.length && !result.files && !result.errors && !fileList && !files?.length && !file?.length) {
 		this.outputHelp();

package/dist/esm/{application-9R1ayzTZ.js → application-yI9NNGsb.js}

@@ -563,6 +563,9 @@ function getReporter(options, config) {
 		filesCached: 0,
 		accumulatedTimeMs: 0,
 		startTime: performance.now(),
+		firstFileStartTime: 0,
+		lastFileEndTime: 0,
+		betweenFilesTimeMs: 0,
 		perf: Object.create(null)
 	};
 	const noColor = options.color === false;
@@ -637,13 +640,19 @@ function getReporter(options, config) {
 			errorCollection.forEach((error) => consoleError(error));
 		}
 		if (options.showPerfSummary) {
-			const elapsedTotal = performance.now() - perfStats.startTime;
+			const now = performance.now();
+			const elapsedTotal = now - perfStats.startTime;
+			const setupTime = (perfStats.firstFileStartTime || now) - perfStats.startTime;
+			const otherTime = elapsedTotal - setupTime - perfStats.accumulatedTimeMs - perfStats.betweenFilesTimeMs;
 			consoleError("-------------------------------------------");
 			consoleError("Performance Summary:");
 			consoleError(`  Files Processed : ${perfStats.filesProcessed.toString().padStart(11)}`);
 			consoleError(`  Files Skipped   : ${perfStats.filesSkipped.toString().padStart(11)}`);
 			consoleError(`  Files Cached    : ${perfStats.filesCached.toString().padStart(11)}`);
+			consoleError(`  Setup Time      : ${setupTime.toFixed(2).padStart(9)}ms`);
 			consoleError(`  Processing Time : ${perfStats.accumulatedTimeMs.toFixed(2).padStart(9)}ms`);
+			consoleError(`  Between Files   : ${perfStats.betweenFilesTimeMs.toFixed(2).padStart(9)}ms`);
+			consoleError(`  Other Time      : ${otherTime.toFixed(2).padStart(9)}ms`);
 			consoleError(`  Total Time      : ${elapsedTotal.toFixed(2).padStart(9)}ms`);
 			const tableStats = {
 				title: chalk.bold("Perf Stats:"),
@@ -755,7 +764,15 @@ function getReporter(options, config) {
 	}
 	function progress(p) {
 		if (!silent && showProgress) reportProgress(stderr, p, rootURL, options);
-		if (p.type === "ProgressFileComplete") collectPerfStats(p);
+		if (p.type === "ProgressFileBegin") {
+			const now = performance.now();
+			perfStats.firstFileStartTime ||= now;
+			if (perfStats.lastFileEndTime) perfStats.betweenFilesTimeMs += now - perfStats.lastFileEndTime;
+		}
+		if (p.type === "ProgressFileComplete") {
+			perfStats.lastFileEndTime = performance.now();
+			collectPerfStats(p);
+		}
 	}
 	return {
 		issue: relativeIssue(silent || !issues ? nullEmitter : genIssueEmitter(stdio, stderr, issueTemplate, uniqueIssues, issuesCollection)),
@@ -764,7 +781,7 @@ function getReporter(options, config) {
 		debug: emitters.Debug,
 		progress,
 		result: !silent && summary ? resultEmitter : nullEmitter,
-		features: void 0
+		features: { issueType: true }
 	};
 }
 function extractNotableBySelfTimeInGroup(measurements) {
@@ -1213,7 +1230,7 @@ try {
 const pkgDir = _dirname;
 const npmPackage = {
 	name: "cspell",
-	version: "10.3.4",
+	version: "10.3.6",
 	engines: { node: ">=22.18.0" }
 };
 //#endregion
@@ -1351,7 +1368,7 @@ var LintReporter = class {
 		});
 	}
 	emitProgressComplete(filename, fileNum, fileCount, result) {
-		const numIssues = result.issues.filter((issue) => filterFeatureIssues({}, issue, result.reportIssueOptions)).length;
+		const numIssues = result.issues.filter((issue) => filterFeatureIssues({ issueType: true }, issue, result.reportIssueOptions)).length;
 		for (const reporter of this.#reporters) {
 			const progress = clean({
 				type: "ProgressFileComplete",
@@ -1992,18 +2009,20 @@ var DiskCache = class {
 	cspellVersion;
 	useUniversalCache;
 	fileEntryCache;
+	optionsKey;
 	cacheDir;
 	dependencyCache = /* @__PURE__ */ new Map();
 	dependencyCacheTree = {};
 	objectCollection = new ShallowObjectCollection();
 	ocCacheFileResult = new ShallowObjectCollection();
 	version;
-	constructor(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache, fileEntryCache) {
+	constructor(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache, fileEntryCache, optionsKey) {
 		this.cacheFileLocation = cacheFileLocation;
 		this.useCheckSum = useCheckSum;
 		this.cspellVersion = cspellVersion;
 		this.useUniversalCache = useUniversalCache;
 		this.fileEntryCache = fileEntryCache;
+		this.optionsKey = optionsKey;
 		this.cacheDir = fileURLToPath(new URL("./", cacheFileLocation));
 		this.version = calcVersion(cspellVersion);
 	}
@@ -2014,7 +2033,8 @@ var DiskCache = class {
 		const data = meta?.data;
 		const result = data?.r;
 		const versionMatches = this.version === data?.v;
-		if (fileDescriptor.notFound || fileDescriptor.changed || !meta || !result || !versionMatches || !await this.checkDependencies(data.d)) return;
+		const optionsMatch = this.optionsKey === data?.o;
+		if (fileDescriptor.notFound || fileDescriptor.changed || !meta || !result || !versionMatches || !optionsMatch || !await this.checkDependencies(data.d)) return;
 		const dd = { ...data };
 		if (dd.d) dd.d = setTreeEntry(this.dependencyCacheTree, dd.d);
 		dd.r = dd.r && this.normalizeResult(dd.r);
@@ -2036,7 +2056,8 @@ var DiskCache = class {
 		meta.data = this.objectCollection.get({
 			v: this.version,
 			r: this.normalizeResult(result),
-			d: await this.calcDependencyHashes(dependsUponFiles)
+			d: await this.calcDependencyHashes(dependsUponFiles),
+			...this.optionsKey ? { o: this.optionsKey } : {}
 		});
 	}
 	async reconcile() {
@@ -2138,8 +2159,8 @@ async function getDependencyForUrl(remoteUrl) {
 		};
 	}
 }
-async function createDiskCache(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache) {
-	return new DiskCache(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache, await createFromFile(cacheFileLocation, useCheckSum, useUniversalCache));
+async function createDiskCache(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache, optionsKey) {
+	return new DiskCache(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache, await createFromFile(cacheFileLocation, useCheckSum, useUniversalCache), optionsKey);
 }
 function getTreeEntry(tree, keys) {
 	let r = tree;
@@ -2208,7 +2229,7 @@ async function createCache(options) {
 	const useChecksum = cacheStrategy === "content";
 	const version = normalizeVersion(options.version);
 	const useUniversal = options.cacheFormat === "universal";
-	const cache = useCache ? await createDiskCache(location, useChecksum, version, useUniversal) : new DummyCache();
+	const cache = useCache ? await createDiskCache(location, useChecksum, version, useUniversal, options.optionsKey) : new DummyCache();
 	if (reset) await cache.reset();
 	return cache;
 }
@@ -2220,6 +2241,8 @@ async function calcCacheSettings(config, cacheOptions, root) {
 	const cacheFormat = cacheOptions.cacheFormat ?? cs.cacheFormat ?? "universal";
 	const optionals = {};
 	if (cacheOptions.cacheReset) optionals.reset = true;
+	const optionsKey = calcOptionsKey(cacheOptions);
+	if (optionsKey) optionals.optionsKey = optionsKey;
 	return {
 		...optionals,
 		useCache,
@@ -2229,6 +2252,17 @@ async function calcCacheSettings(config, cacheOptions, root) {
 		cacheFormat
 	};
 }
+function calcOptionsKey(cacheOptions) {
+	const { languageId, locale, report, showSuggestions, validateDirectives } = cacheOptions;
+	const set = Object.entries({
+		languageId: languageId || void 0,
+		locale: locale || void 0,
+		report: report || void 0,
+		showSuggestions,
+		validateDirectives
+	}).filter(([, value]) => value !== void 0);
+	return set.length ? JSON.stringify(Object.fromEntries(set)) : void 0;
+}
 async function resolveCacheLocation(cacheLocation) {
 	try {
 		if ((await stat(cacheLocation)).isFile()) return cacheLocation;
@@ -2513,13 +2547,13 @@ async function processFile(file, cache, prefetch, processFileOptions) {
 	result.fileInfo = fileInfo;
 	let spellResult = {};
 	try {
-		const { showSuggestions: generateSuggestions, validateDirectives, skipValidation, forceCheck: force } = cfg.options;
+		const { showSuggestions: generateSuggestions, validateDirectives, skipValidation, forceCheck } = cfg.options;
 		const validateOptions = clean({
 			generateSuggestions,
 			numSuggestions: configInfo.config.numSuggestions ?? 5,
 			validateDirectives,
 			skipValidation,
-			force
+			forceCheck
 		});
 		const r = await spellCheckDocument(doc, validateOptions, userSettings);
 		spellResult = r;
@@ -2693,7 +2727,7 @@ function prefetch(fileToProcess, cfg) {
 			elapsedTimeMs: getElapsedTimeMs()
 		} };
 		const uri = filenameToUri(filename, cfg.root).href;
-		const checkResult = await shouldCheckDocument({ uri }, {}, cfg.config);
+		const checkResult = await shouldCheckDocument({ uri }, { forceCheck: cfg.forceCheck }, cfg.config);
 		if (!checkResult.shouldCheck) return {
 			skip: true,
 			skipReason: checkResult.reason || "Ignored by configuration."
@@ -2724,6 +2758,7 @@ async function processFiles(files, options) {
 	const prefetchConfig = {
 		root: options.cfg.root,
 		maxFileSize: options.cfg.maxFileSize,
+		forceCheck: !!options.cfg.options.forceCheck,
 		config: options.configInfo.config,
 		cache
 	};
@@ -3063,7 +3098,7 @@ async function determineFilesToCheck(configInfo, cfg, reporter, globInfo) {
 		};
 		const enableGlobDot = cfg.enableGlobDot ?? configInfo.config.enableGlobDot;
 		if (enableGlobDot !== void 0) globOptions.dot = enableGlobDot;
-		const includeFilterCountSkipped = countFiles(createIncludeFileFilterFn(allGlobs, root, enableGlobDot));
+		const includeFilterCountSkipped = countFiles(cfg.options.forceCheck && !cfg.fileGlobs.length ? () => true : createIncludeFileFilterFn(allGlobs, root, enableGlobDot));
 		const rawCliFiles = cfg.files?.map((file) => resolveFilename(file, root)).filter(includeFilterCountSkipped);
 		const cliFiles = cfg.options.mustFindFiles ? rawCliFiles : rawCliFiles && pipeAsync(rawCliFiles, opFilterAsync(isFile));
 		const foundFiles = hasFileLists ? concatAsyncIterables(cliFiles, await useFileLists(fileLists, includeFilterCountSkipped)) : cliFiles || [];
@@ -3226,6 +3261,7 @@ var LintRequest = class {
 		}];
 		this.cspellSettingsFromCliOptions = {
 			...noConfigSearch !== void 0 ? { noConfigSearch } : {},
+			...options.validateDirectives !== void 0 ? { validateDirectives: options.validateDirectives } : {},
 			...extractUnknownWordsConfig(options),
 			languageSettings
 		};
@@ -3533,4 +3569,4 @@ function parseApplicationFeatureFlags(flags) {
 //#endregion
 export { ApplicationError as C, width as S, console as T, padLeft as _, parseApplicationFeatureFlags as a, pruneAnsiTextEnd as b, listDictionaries as c, validateUnitSize as d, unindent as f, tableToLines as g, getReporter as h, lint as i, ReportChoicesAll as l, npmPackage as m, checkText as n, suggestions as o, DEFAULT_CACHE_LOCATION as p, createInit as r, trace as s, IncludeExcludeFlag as t, cvtLinterCliCommandOptionsToLinterCliOptions as u, padWidth as v, CheckFailed as w, pruneAnsiTextStart as x, ansiWidth as y };
 
-//# sourceMappingURL=application-9R1ayzTZ.js.map
+//# sourceMappingURL=application-yI9NNGsb.js.map

package/dist/esm/application.js

@@ -1,2 +1,2 @@
-import { a as parseApplicationFeatureFlags, c as listDictionaries, i as lint, n as checkText, o as suggestions, r as createInit, s as trace, t as IncludeExcludeFlag } from "./application-9R1ayzTZ.js";
+import { a as parseApplicationFeatureFlags, c as listDictionaries, i as lint, n as checkText, o as suggestions, r as createInit, s as trace, t as IncludeExcludeFlag } from "./application-yI9NNGsb.js";
 export { IncludeExcludeFlag, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-import { a as parseApplicationFeatureFlags, c as listDictionaries, h as getReporter, i as lint, n as checkText, o as suggestions, r as createInit, s as trace, t as IncludeExcludeFlag } from "./application-9R1ayzTZ.js";
+import { a as parseApplicationFeatureFlags, c as listDictionaries, h as getReporter, i as lint, n as checkText, o as suggestions, r as createInit, s as trace, t as IncludeExcludeFlag } from "./application-yI9NNGsb.js";
 export * from "@cspell/cspell-types";
 export { IncludeExcludeFlag, checkText, createInit, getReporter as getDefaultReporter, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/package.json

@@ -1,17 +1,36 @@
 {
   "name": "cspell",
-  "version": "10.3.4",
+  "version": "10.3.6",
   "description": "A Spelling Checker for Code!",
-  "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
-  "bin": {
-    "cspell": "bin.mjs",
-    "cspell-esm": "bin.mjs"
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   },
-  "type": "module",
+  "homepage": "https://cspell.org/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/streetsidesoftware/cspell.git",
+    "directory": "packages/cspell"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/issues?q=is%3Aissue%20state%3Aopen%20label%3Acspell"
+  },
+  "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
+  "keywords": [
+    "spell",
+    "checker",
+    "code",
+    "camel",
+    "case",
+    "spelling",
+    "spell checker",
+    "spelling checker",
+    "lint"
+  ],
+  "license": "MIT",
+  "author": "Jason Dent",
   "sideEffects": false,
-  "types": "dist/cjs/commonJsApi.d.cts",
-  "main": "dist/cjs/commonJsApi.cjs",
-  "module": "dist/esm/index.js",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
@@ -30,6 +49,13 @@
       "import": "./dist/esm/application.js"
     }
   },
+  "main": "dist/cjs/commonJsApi.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/commonJsApi.d.cts",
+  "bin": {
+    "cspell": "bin.mjs",
+    "cspell-esm": "bin.mjs"
+  },
   "files": [
     "bin.mjs",
     "dist",
@@ -44,81 +70,55 @@
     "!dist/tsc"
   ],
   "scripts": {
-    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "tsdown && pnpm build:tsc",
-    "build:tsc": "tsc -p .",
     "build:readme": "pnpm build:readme:help",
     "build:readme:help": "pnpm build:readme:help:lint && pnpm build:readme:help:trace && inject-markdown README.md && prettier -w README.md",
     "build:readme:help:lint": "./bin.mjs lint --help > static/help-lint.txt",
     "build:readme:help:trace": "./bin.mjs trace --help > static/help-trace.txt",
+    "build:tsc": "tsc -p .",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "clean-build": "pnpm run clean && pnpm run build",
+    "compile": "tsc -p .",
     "coverage": "vitest run --coverage",
-    "test:watch": "vitest",
+    "prepublishOnly": "pnpm run clean-build",
     "test": "vitest run",
-    "watch": "tsdown -w",
-    "watch:tsc": "tsc -p . -w",
-    "compile": "tsc -p .",
+    "test:update-snapshot": "vitest run --update",
+    "test:watch": "vitest",
     "test-watch": "vitest",
     "version": "node ./tools/patch-version.mjs && git add .",
-    "prepublishOnly": "pnpm run clean-build",
-    "test:update-snapshot": "vitest run --update"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/streetsidesoftware/cspell.git",
-    "directory": "packages/cspell"
-  },
-  "keywords": [
-    "spell",
-    "checker",
-    "code",
-    "camel",
-    "case",
-    "spelling",
-    "spell checker",
-    "spelling checker",
-    "lint"
-  ],
-  "author": "Jason Dent",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "bugs": {
-    "url": "https://github.com/streetsidesoftware/cspell/issues"
+    "watch": "tsdown -w",
+    "watch:tsc": "tsc -p . -w"
   },
-  "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "10.3.4",
-    "@cspell/cspell-performance-monitor": "10.3.4",
-    "@cspell/cspell-pipe": "10.3.4",
-    "@cspell/cspell-types": "10.3.4",
-    "@cspell/cspell-worker": "10.3.4",
-    "@cspell/dynamic-import": "10.3.4",
-    "@cspell/url": "10.3.4",
+    "@cspell/cspell-json-reporter": "10.3.6",
+    "@cspell/cspell-performance-monitor": "10.3.6",
+    "@cspell/cspell-pipe": "10.3.6",
+    "@cspell/cspell-types": "10.3.6",
+    "@cspell/cspell-worker": "10.3.6",
+    "@cspell/dynamic-import": "10.3.6",
+    "@cspell/url": "10.3.6",
     "ansi-regex": "^6.3.0",
     "chalk": "^6.0.0",
     "chalk-template": "^1.1.2",
     "commander": "^15.0.0",
-    "cspell-config-lib": "10.3.4",
-    "cspell-dictionary": "10.3.4",
-    "cspell-gitignore": "10.3.4",
-    "cspell-glob": "10.3.4",
-    "cspell-io": "10.3.4",
-    "cspell-lib": "10.3.4",
+    "cspell-config-lib": "10.3.6",
+    "cspell-dictionary": "10.3.6",
+    "cspell-gitignore": "10.3.6",
+    "cspell-glob": "10.3.6",
+    "cspell-io": "10.3.6",
+    "cspell-lib": "10.3.6",
     "flatted": "^3.4.4",
     "semver": "^7.8.5",
     "tinyglobby": "^0.2.17"
   },
-  "engines": {
-    "node": ">=22.18.0"
-  },
   "devDependencies": {
     "@types/micromatch": "^4.0.10",
     "@types/semver": "^7.8.0",
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.9"
   },
-  "gitHead": "7bb5c4750ece7c732edbf920c0cea910d9b4d717"
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "gitHead": "8559198ccfcac2f745911db1ffe2ee62c17cba49"
 }