cspell 9.6.2 → 9.6.4

package/README.md

@@ -291,6 +291,8 @@ Options:
                               words.
   --dictionary <name>         Enable a dictionary by name. Can be used multiple
                               times.
+  --no-dictionary <name>      Disable a dictionary by name. Can be used multiple
+                              times.
   --dictionary-path <format>  Configure how to display the dictionary path.
                               (choices: "hide", "short", "long", "full",
                               default: Display most of the path.)

package/dist/esm/app.d.ts

@@ -1,4 +1,4 @@
-import { i as LinterCliOptions } from "./options-D_PtlSKK.js";
+import { i as LinterCliOptions } from "./options-CeDseSxu.js";
 import { Command } from "commander";
 
 //#region src/util/errors.d.ts

package/dist/esm/app.js

@@ -1,4 +1,4 @@
-import { C as CheckFailed, S as ApplicationError, _ as padLeft, a as parseApplicationFeatureFlags, b as pruneAnsiTextStart, 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 console, x as width, y as pruneAnsiTextEnd } from "./application-BBOBF62T.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-DYABxs7R.js";
 import { Link } from "cspell-lib";
 import chalk from "chalk";
 import * as iPath from "node:path";
@@ -45,6 +45,17 @@ function collect$1(value, previous) {
 	return previous ? [...previous, ...values] : values;
 }
 /**
+* Collects string values into an array, prefixing each value with the given prefix.
+* @param prefix the prefix to add to each value.
+* @returns a function that collects values with the given prefix.
+*/
+function prefixCollect(prefix) {
+	return (value, previous) => {
+		const values = (Array.isArray(value) ? value : [value]).map((v) => prefix + v);
+		return previous ? [...previous, ...values] : values;
+	};
+}
+/**
 * Create Option - a helper function to create a commander option.
 * @param name - the name of the option
 * @param description - the description of the option
@@ -61,16 +72,16 @@ function crOpt(name, description, parseArg, defaultValue) {
 
 //#endregion
 //#region src/emitters/helpers.ts
-function trimMidPath(s, w, sep$1) {
+function trimMidPath(s, w, sep) {
 	if (s.length <= w) return s;
-	const parts = s.split(sep$1);
+	const parts = s.split(sep);
 	if (parts[parts.length - 1].length > w) return trimMid(s, w);
-	function join(left$1, right$1) {
+	function join(left, right) {
 		return [
-			...parts.slice(0, left$1),
+			...parts.slice(0, left),
 			"…",
-			...parts.slice(right$1)
-		].join(sep$1);
+			...parts.slice(right)
+		].join(sep);
 	}
 	let left = 0, right = parts.length, last = "";
 	for (let i = 0; i < parts.length; ++i) {
@@ -101,15 +112,15 @@ function trimMid(s, w) {
 	const r = Math.ceil((w - 1) / 2);
 	return s.slice(0, l) + "…" + s.slice(-r);
 }
-function formatDictionaryLocation(dictSource, maxWidth$2, { cwd, dictionaryPathFormat: format, iPath: iPath$1 }) {
-	let relPath = cwd ? iPath$1.relative(cwd, dictSource) : dictSource;
+function formatDictionaryLocation(dictSource, maxWidth, { cwd, dictionaryPathFormat: format, iPath }) {
+	let relPath = cwd ? iPath.relative(cwd, dictSource) : dictSource;
 	const idxNodeModule = relPath.lastIndexOf("node_modules");
 	const isNodeModule = idxNodeModule >= 0;
 	if (format === "hide") return "";
-	if (format === "short") return (isNodeModule ? "[node_modules]/" : relPath.startsWith(".." + iPath$1.sep + "..") ? "…/" : relPath.startsWith(".." + iPath$1.sep) ? "../" : "") + iPath$1.basename(dictSource);
+	if (format === "short") return (isNodeModule ? "[node_modules]/" : relPath.startsWith(".." + iPath.sep + "..") ? "…/" : relPath.startsWith(".." + iPath.sep) ? "../" : "") + iPath.basename(dictSource);
 	if (format === "full") return dictSource;
 	relPath = isNodeModule ? relPath.slice(idxNodeModule) : relPath;
-	return trimMidPath(relPath.length < dictSource.length ? relPath : dictSource, maxWidth$2, iPath$1.sep);
+	return trimMidPath(relPath.length < dictSource.length ? relPath : dictSource, maxWidth, iPath.sep);
 }
 
 //#endregion
@@ -153,12 +164,12 @@ function calcHeaders(options) {
 	return headers;
 }
 function emitDictResult(r, options) {
-	const a = r.enabled ? "*" : " ";
+	const a = (r.blocked ? chalk.redBright("!") : "") + (r.enabled ? "*" : " ");
 	const dictColor = r.enabled ? chalk.yellowBright : chalk.rgb(200, 128, 50);
-	const n = (width$1) => dictColor(pruneAnsiTextEnd(r.name, width$1 && width$1 - a.length) + a);
+	const n = (width) => dictColor(pruneAnsiTextEnd(r.name, width && width - ansiWidth(a)) + a);
 	const c = colorize$1(chalk.white);
-	const locales = (width$1) => c(pruneAnsiTextEnd(r.locales?.join(",") || "", width$1));
-	const fileTypes = (width$1) => c(pruneAnsiTextEnd(r.fileTypes?.join(",") || "", width$1));
+	const locales = (width) => c(pruneAnsiTextEnd(r.locales?.join(",") || "", width));
+	const fileTypes = (width) => c(pruneAnsiTextEnd(r.fileTypes?.join(",") || "", width));
 	if (!r.path) return {
 		name: n,
 		location: c(r.inline?.join(", ") || ""),
@@ -357,7 +368,7 @@ function commandLint(prog, opts) {
 	spellCheckCommand.description("Check spelling").option("-c, --config <cspell.json>", "Configuration file to use.  By default cspell looks for cspell.json in the current directory.").addOption(crOpt("--config-search", "Allow searching for configuration files.", void 0).hideHelp()).option("--no-config-search", "Disable automatic searching for additional configuration files in parent directories. Only the specified config file (if any) will be used.").option("--stop-config-search-at <dir>", "Specify a directory at which to stop searching for configuration files when walking up from the files being checked. Useful for limiting config inheritance.", collect$1).option("-v, --verbose", "Display more information about the files being checked. Add more than one -v for increased verbosity.", increaseVerbosity, 0).option("--locale <locale>", "Set language locales. i.e. \"en,fr\" for English and French, or \"en-GB\" for British English.").option("--language-id <file-type>", "Force programming language for unknown extensions. i.e. \"php\" or \"scala\"").addOption(crOpt("--languageId <file-type>", "Alias of \"--language-id\". Force programming language for unknown extensions. i.e. \"php\" or \"scala\"").hideHelp()).option("--words-only", "Only output the words not found in the dictionaries.").addOption(crOpt("--wordsOnly", "Only output the words not found in the dictionaries.").hideHelp()).option("-u, --unique", "Only output the first instance of a word not found in the dictionaries.").option("-e, --exclude <glob>", "Exclude files matching the glob pattern. This option can be used multiple times to add multiple globs. ", collect$1).option("--file-list <path or stdin>", "Specify a list of files to be spell checked. The list is filtered against the glob file patterns. Note: the format is 1 file path per line.", collect$1).option("--file [file...]", "Specify files to spell check. They are filtered by the [globs...].", collect$1).addOption(crOpt("--files [file...]", "Alias of \"--file\". Files to spell check.", collect$1).hideHelp()).option("--no-issues", "Do not show the spelling errors.").option("--no-progress", "Turn off progress messages").option("--no-summary", "Turn off summary message in console.").option("-s, --silent", "Silent mode, suppress error messages.").option("--no-exit-code", "Do not return an exit code if issues are found.").addOption(crOpt("--quiet", "Only show spelling issues or errors.").implies({
 		summary: false,
 		progress: false
-	})).option("--fail-fast", "Exit after first file with an issue or error.").addOption(crOpt("--no-fail-fast", "Process all files even if there is an error.").hideHelp()).option("--continue-on-error", "Continue processing files even if there is a configuration error.").option("-r, --root <root folder>", "Root directory, defaults to current directory.").addOption(crOpt("--relative", "Issues are displayed relative to the root.").default(true).hideHelp()).option("--no-relative", "Issues are displayed with absolute path instead of relative to the root.").option("--show-context", "Show the surrounding text around an issue.").option("--show-suggestions", "Show spelling suggestions.").addOption(crOpt("--no-show-suggestions", "Do not show spelling suggestions or fixes.").default(void 0)).addOption(crOpt("--must-find-files", "Error if no files are found.").default(true).hideHelp()).option("--no-must-find-files", "Do not error if no files are found.").addOption(crOpt("--legacy", "Legacy output").hideHelp()).addOption(crOpt("--local <local>", "Deprecated -- Use: --locale").hideHelp()).option("--cache", "Use cache to only check changed files.").option("--no-cache", "Do not use cache.").option("--cache-reset", "Reset the cache file.").addOption(crOpt("--cache-strategy <strategy>", "Strategy to use for detecting changed files.").choices(["content", "metadata"]).default("content")).option("--cache-location <path>", `Path to the cache file or directory. (default: "${DEFAULT_CACHE_LOCATION}")`).option("--dot", "Include files and directories starting with `.` (period) when matching globs.").option("--gitignore", "Ignore files matching glob patterns found in .gitignore files.").option("--no-gitignore", "Do NOT use .gitignore files.").option("--gitignore-root <path>", "Prevent searching for .gitignore files past root.", collect$1).option("--validate-directives", "Validate in-document CSpell directives.").addOption(crOpt("--no-validate-directives", "Do not validate in-document CSpell directives.").hideHelp()).option("--max-file-size <size>", "Prevent checking large files. i.e 1MB, 50KB, 1GB").addOption(crOpt("--color", "Force color.").default(void 0)).addOption(crOpt("--no-color", "Turn off color.").default(void 0)).addOption(crOpt("--default-configuration", "Load the default configuration and dictionaries.").hideHelp()).addOption(crOpt("--no-default-configuration", "Do not load the default configuration and dictionaries.")).option("--dictionary <name>", "Enable a dictionary by name.", collect$1).option("--disable-dictionary <name>", "Disable a dictionary by name.", collect$1).option("--reporter <module|path>", "Specify one or more reporters to use.", collect$1).addOption(crOpt("--report <level>", "Set how unknown words are reported").choices(ReportChoicesAll)).addOption(crOpt("--skip-validation", "Collect and process documents, but do not spell check.").implies({ cache: false }).hideHelp()).addOption(crOpt("--issues-summary-report", "Output a summary of issues found.").hideHelp()).addOption(crOpt("--show-perf-summary", "Output a performance summary report.").hideHelp()).option("--issue-template [template]", "Use a custom issue template. See --help --issue-template for details.").addOption(crOpt("--debug", "Output information useful for debugging cspell.json files.").hideHelp()).usage(usage).addHelpText("after", augmentCommandHelp).arguments("[globs...]").action(action);
+	})).option("--fail-fast", "Exit after first file with an issue or error.").addOption(crOpt("--no-fail-fast", "Process all files even if there is an error.").hideHelp()).option("--continue-on-error", "Continue processing files even if there is a configuration error.").option("-r, --root <root folder>", "Root directory, defaults to current directory.").addOption(crOpt("--relative", "Issues are displayed relative to the root.").default(true).hideHelp()).option("--no-relative", "Issues are displayed with absolute path instead of relative to the root.").option("--show-context", "Show the surrounding text around an issue.").option("--show-suggestions", "Show spelling suggestions.").addOption(crOpt("--no-show-suggestions", "Do not show spelling suggestions or fixes.").default(void 0)).addOption(crOpt("--must-find-files", "Error if no files are found.").default(true).hideHelp()).option("--no-must-find-files", "Do not error if no files are found.").addOption(crOpt("--legacy", "Legacy output").hideHelp()).addOption(crOpt("--local <local>", "Deprecated -- Use: --locale").hideHelp()).option("--cache", "Use cache to only check changed files.").option("--no-cache", "Do not use cache.").option("--cache-reset", "Reset the cache file.").addOption(crOpt("--cache-strategy <strategy>", "Strategy to use for detecting changed files.").choices(["content", "metadata"]).default("content")).option("--cache-location <path>", `Path to the cache file or directory. (default: "${DEFAULT_CACHE_LOCATION}")`).option("--dot", "Include files and directories starting with `.` (period) when matching globs.").option("--gitignore", "Ignore files matching glob patterns found in .gitignore files.").option("--no-gitignore", "Do NOT use .gitignore files.").option("--gitignore-root <path>", "Prevent searching for .gitignore files past root.", collect$1).option("--validate-directives", "Validate in-document CSpell directives.").addOption(crOpt("--no-validate-directives", "Do not validate in-document CSpell directives.").hideHelp()).option("--max-file-size <size>", "Prevent checking large files. i.e 1MB, 50KB, 1GB").addOption(crOpt("--color", "Force color.").default(void 0)).addOption(crOpt("--no-color", "Turn off color.").default(void 0)).addOption(crOpt("--default-configuration", "Load the default configuration and dictionaries.").hideHelp()).addOption(crOpt("--no-default-configuration", "Do not load the default configuration and dictionaries.")).option("--dictionary <name>", "Enable a dictionary by name.", collect$1).addOption(crOpt("--no-dictionary <name>", "Disable a dictionary by name. Can be used multiple times.", prefixCollect("!")).hideHelp()).option("--disable-dictionary <name>", "Disable a dictionary by name.", collect$1).option("--reporter <module|path>", "Specify one or more reporters to use.", collect$1).addOption(crOpt("--report <level>", "Set how unknown words are reported").choices(ReportChoicesAll)).addOption(crOpt("--skip-validation", "Collect and process documents, but do not spell check.").implies({ cache: false }).hideHelp()).addOption(crOpt("--issues-summary-report", "Output a summary of issues found.").hideHelp()).addOption(crOpt("--show-perf-summary", "Output a performance summary report.").hideHelp()).option("--issue-template [template]", "Use a custom issue template. See --help --issue-template for details.").addOption(crOpt("--debug", "Output information useful for debugging cspell.json files.").hideHelp()).usage(usage).addHelpText("after", augmentCommandHelp).arguments("[globs...]").action(action);
 	return spellCheckCommand;
 }
 async function action(fileGlobs, cliOptions) {
@@ -442,32 +453,32 @@ function increaseVerbosity(_dummyValue, previous) {
 //#region src/emitters/suggestionsEmitter.ts
 const regExpRTL = /([ \u0591-\u07FF\uFB1D-\uFDFD\uFE70-\uFEFC]+)/g;
 function reverseRtlText(s) {
-	return s.replaceAll(regExpRTL, (s$1) => [...s$1].reverse().join(""));
+	return s.replaceAll(regExpRTL, (s) => [...s].reverse().join(""));
 }
 function emitSuggestionResult(result, options) {
-	const { word, suggestions: suggestions$1 } = result;
+	const { word, suggestions } = result;
 	const { verbose, output = console } = options;
 	const elapsed = verbose && verbose > 1 && result.elapsedTimeMs ? ` ${result.elapsedTimeMs.toFixed(2)} ms` : "";
 	const rWord = reverseRtlText(word);
 	const wordEx = rWord !== word ? ` (${chalk.yellow(rWord)})` : "";
 	output.log((word ? chalk.yellow(word) + wordEx : chalk.yellow("<empty>")) + ":" + elapsed);
-	if (!suggestions$1.length) {
+	if (!suggestions.length) {
 		console.log(chalk.yellow(" <no suggestions>"));
 		return;
 	}
-	function handleRtl(word$1) {
-		const r = reverseRtlText(word$1);
-		return r === word$1 ? word$1 : `${word$1} (${r})`;
+	function handleRtl(word) {
+		const r = reverseRtlText(word);
+		return r === word ? word : `${word} (${r})`;
 	}
 	if (verbose) {
-		const mappedSugs = suggestions$1.map((s) => ({
+		const mappedSugs = suggestions.map((s) => ({
 			...s,
 			w: handleRtl(s.compoundWord || s.wordAdjustedToMatchCase || s.word)
 		}));
-		const maxWidth$2 = mappedSugs.map((s) => width(s.w)).reduce((max, len) => Math.max(max, len), 0);
+		const maxWidth = mappedSugs.map((s) => width(s.w)).reduce((max, len) => Math.max(max, len), 0);
 		for (const sug of mappedSugs) {
 			const { cost, dictionaries, w } = sug;
-			const padding = " ".repeat(padWidth(w, maxWidth$2));
+			const padding = " ".repeat(padWidth(w, maxWidth));
 			const forbid = sug.forbidden && sug.isPreferred ? chalk.red("*") : sug.forbidden ? chalk.red("X") : sug.isPreferred ? chalk.yellow("*") : " ";
 			const ignore = sug.noSuggest ? chalk.yellow("N") : " ";
 			const strCost = padLeft(cost.toString(10), 4);
@@ -475,7 +486,7 @@ function emitSuggestionResult(result, options) {
 			output.log(` - ${formatWord(w, sug)}${padding} ${forbid}${ignore} - ${chalk.yellow(strCost)} ${dicts}`);
 		}
 	} else {
-		const mappedSugs = suggestions$1.map((s) => ({
+		const mappedSugs = suggestions.map((s) => ({
 			...s,
 			word: handleRtl(s.wordAdjustedToMatchCase || s.word)
 		}));
@@ -580,7 +591,7 @@ function emitTraceResult(r, options) {
 	const sug = r.preferredSuggestions?.map((s) => chalk.yellowBright(s)).join(", ") || "";
 	const w = (r.forbidden ? chalk.red(cWord) : chalk.green(cWord)) + (sug ? `->(${sug})` : "");
 	const f = calcFoundChar(r);
-	const a = r.dictActive ? "*" : " ";
+	const a = (r.dictBlocked ? chalk.redBright("!") : "") + (r.dictActive ? "*" : " ");
 	const dictName = r.dictName.slice(0, colWidthDictionaryName - 1) + a;
 	const n = (r.dictActive ? chalk.yellowBright : chalk.rgb(200, 128, 50))(dictName);
 	const c = colorize(errors ? chalk.red : chalk.white);
@@ -621,7 +632,7 @@ function colorize(fn) {
 //#endregion
 //#region src/commandTrace.ts
 function commandTrace(prog) {
-	return prog.command("trace").description(`Trace words -- Search for words in the configuration and dictionaries.`).option("-c, --config <cspell.json>", "Configuration file to use.  By default cspell looks for cspell.json in the current directory.").option("--locale <locale>", "Set language locales. i.e. \"en,fr\" for English and French, or \"en-GB\" for British English.").option("--language-id <language>", "Use programming language. i.e. \"php\" or \"scala\".").addOption(new Option("--languageId <language>", "Use programming language. i.e. \"php\" or \"scala\".").hideHelp()).option("--allow-compound-words", "Turn on allowCompoundWords").addOption(new Option("--allowCompoundWords", "Turn on allowCompoundWords.").hideHelp()).option("--no-allow-compound-words", "Turn off allowCompoundWords").option("--ignore-case", "Ignore case and accents when searching for words.").option("--no-ignore-case", "Do not ignore case and accents when searching for words.").option("--dictionary <name>", "Enable a dictionary by name. Can be used multiple times.", collect$1).addOption(new Option("--dictionary-path <format>", "Configure how to display the dictionary path.").choices([
+	return prog.command("trace").description(`Trace words -- Search for words in the configuration and dictionaries.`).option("-c, --config <cspell.json>", "Configuration file to use.  By default cspell looks for cspell.json in the current directory.").option("--locale <locale>", "Set language locales. i.e. \"en,fr\" for English and French, or \"en-GB\" for British English.").option("--language-id <language>", "Use programming language. i.e. \"php\" or \"scala\".").addOption(new Option("--languageId <language>", "Use programming language. i.e. \"php\" or \"scala\".").hideHelp()).option("--allow-compound-words", "Turn on allowCompoundWords").addOption(new Option("--allowCompoundWords", "Turn on allowCompoundWords.").hideHelp()).option("--no-allow-compound-words", "Turn off allowCompoundWords").option("--ignore-case", "Ignore case and accents when searching for words.").option("--no-ignore-case", "Do not ignore case and accents when searching for words.").option("--dictionary <name>", "Enable a dictionary by name. Can be used multiple times.", collect$1).option("--no-dictionary <name>", "Disable a dictionary by name. Can be used multiple times.", prefixCollect("!")).addOption(new Option("--dictionary-path <format>", "Configure how to display the dictionary path.").choices([
 		"hide",
 		"short",
 		"long",