cspell 10.3.5 → 10.4.0-alpha.1

package/README.md

@@ -19,7 +19,7 @@ Please show your support through one of the following sites:
 ## Features
 
 - Spell Checks Code -- Parses code into words before checking them against the dictionaries.
-  - Supports CamelCase, snake\_case, and compoundwords naming styles.
+  - Supports CamelCase, snake_case, and compoundwords naming styles.
 - Self contained -- does not depend upon OS libraries like Hunspell or Aspell. Nor does it depend upon online services.
 - Fast -- checks 1000's of lines of code in seconds.
 - Programming Language Specific Dictionaries -- Has dedicated support for:
@@ -102,108 +102,130 @@ The `lint` command is used for spell checking files.
 cspell lint --help
 ```
 
+Help, and the tables from `cspell trace` and `cspell dictionaries`, fit the width of your terminal. To use a different
+width, set the `COLUMNS` environment variable:
+
+```sh
+COLUMNS=60 cspell lint --help
+```
+
 ### Options
 
 <!--- @@inject: static/help-lint.txt --->
 
 ```
-Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]
+Usage: cspell lint [options] [globs...] [file://<path> ...]
+                   [stdin[://<path>]]
 
 Patterns:
  - [globs...]            Glob Patterns
  - [stdin]               Read from "stdin" assume text file.
- - [stdin://<path>]      Read from "stdin", use <path> for file type and config.
+ - [stdin://<path>]      Read stdin; <path> sets file type and config.
  - [file://<path>]       Check the file at <path>
 
 Examples:
     cspell .                        Recursively check all files.
     cspell lint .                   The same as "cspell ."
-    cspell "*.js"                   Check all .js files in the current directory
+    cspell "*.js"                   Check .js files in this directory
     cspell "**/*.js"                Check all .js files recursively
     cspell "src/**/*.js"            Only check .js under src
     cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
     cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
     cat LICENSE | cspell stdin      Check stdin
-    cspell stdin://docs/doc.md      Check stdin as if it was "./docs/doc.md"
+    cspell stdin://docs/doc.md      Check stdin as "./docs/doc.md"
 
 Check spelling
 
 Options:
-  -c, --config <cspell.json>     Configuration file to use.  By default cspell
-                                 looks for cspell.json in the current directory.
-  --no-config-search             Disable automatic searching for additional
-                                 configuration files in parent directories. Only
-                                 the specified config file (if any) will be
-                                 used.
-  --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.
-  -v, --verbose                  Display more information about the files being
-                                 checked. Add more than one -v for increased
-                                 verbosity.
-  --locale <locale>              Set language locales. i.e. "en,fr" for English
-                                 and French, or "en-GB" for British English.
+  -c, --config <cspell.json>     Configuration file to use.  By default
+                                 cspell looks for cspell.json in the
+                                 current directory.
+  --no-config-search             Disable automatic searching for
+                                 additional configuration files in
+                                 parent directories. Only the specified
+                                 config file (if any) will be used.
+  --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.
+  -v, --verbose                  Display more information about the
+                                 files being checked. Add more than one
+                                 -v for increased verbosity.
+  --locale <locale>              Set language locales. i.e. "en,fr" for
+                                 English and French, or "en-GB" for
+                                 British English.
   --language-id <file-type>      Force programming language for unknown
                                  extensions. i.e. "php" or "scala"
   --words-only                   Only output the words not found in the
                                  dictionaries.
-  -u, --unique                   Only output the first instance of a word not
-                                 found in the dictionaries.
-  -e, --exclude <glob>           Exclude files matching the glob pattern. This
-                                 option can be used multiple times to add
-                                 multiple globs.
-  --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.
-  --file [file...]               Specify files to spell check. They are filtered
-                                 by the [globs...].
-  --force-check                  Force the --file or --file-list documents to be
-                                 checked even if it would normally be excluded.
+  -u, --unique                   Only output the first instance of a
+                                 word not found in the dictionaries.
+  -e, --exclude <glob>           Exclude files matching the glob
+                                 pattern. This option can be used
+                                 multiple times to add multiple globs.
+  --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.
+  --file [file...]               Specify files to spell check. They are
+                                 filtered by the [globs...].
+  --force-check                  Force the --file or --file-list
+                                 documents to be checked even if it
+                                 would normally be excluded.
+  --follow-symlinks              Allow checking --file and --file-list
+                                 documents referenced by symbolic links.
   --no-issues                    Do not show the spelling errors.
   --no-progress                  Turn off progress messages
   --no-summary                   Turn off summary message in console.
   -s, --silent                   Silent mode, suppress error messages.
-  --no-exit-code                 Do not return an exit code if issues are found.
+  --no-exit-code                 Do not return an exit code if issues
+                                 are found.
   --quiet                        Only show spelling issues or errors.
-  --fail-fast                    Exit after first file with an issue or error.
-  --continue-on-error            Continue processing files even if there is a
-                                 configuration error.
-  -r, --root <root folder>       Root directory, defaults to current directory.
-  --no-relative                  Issues are displayed with absolute path instead
-                                 of relative to the root.
-  --show-context                 Show the surrounding text around an issue.
+  --fail-fast                    Exit after first file with an issue or
+                                 error.
+  --continue-on-error            Continue processing files even if there
+                                 is a configuration error.
+  -r, --root <root folder>       Root directory, defaults to current
+                                 directory.
+  --no-relative                  Issues are displayed with absolute path
+                                 instead of relative to the root.
+  --show-context                 Show the surrounding text around an
+                                 issue.
   --show-suggestions             Show spelling suggestions.
-  --no-show-suggestions          Do not show spelling suggestions or fixes.
+  --no-show-suggestions          Do not show spelling suggestions or
+                                 fixes.
   --no-must-find-files           Do not error if no files are found.
   --cache                        Use cache to only check changed files.
   --no-cache                     Do not use cache.
   --cache-reset                  Reset the cache file.
-  --cache-strategy <strategy>    Strategy to use for detecting changed files.
-                                 (choices: "content", "metadata", default:
-                                 "content")
-  --cache-location <path>        Path to the cache file or directory. (default:
-                                 ".cspellcache")
-  --dot                          Include files and directories starting with `.`
-                                 (period) when matching globs.
-  --gitignore                    Ignore files matching glob patterns found in
-                                 .gitignore files.
+  --cache-strategy <strategy>    Strategy to use for detecting changed
+                                 files. (choices: "content", "metadata",
+                                 default: "content")
+  --cache-location <path>        Path to the cache file or directory.
+                                 (default: ".cspellcache")
+  --dot                          Include files and directories starting
+                                 with `.` (period) when matching globs.
+  --glob-symlinks                Follow symbolic links when matching
+                                 globs.
+  --gitignore                    Ignore files matching glob patterns
+                                 found in .gitignore files.
   --no-gitignore                 Do NOT use .gitignore files.
-  --gitignore-root <path>        Prevent searching for .gitignore files past
-                                 root.
+  --gitignore-root <path>        Prevent searching for .gitignore files
+                                 past root.
   --validate-directives          Validate in-document CSpell directives.
-  --max-file-size <size>         Prevent checking large files. i.e 1MB, 50KB,
-                                 1GB
+  --max-file-size <size>         Prevent checking large files. i.e 1MB,
+                                 50KB, 1GB
   --color                        Force color.
   --no-color                     Turn off color.
-  --no-default-configuration     Do not load the default configuration and
-                                 dictionaries.
+  --no-default-configuration     Do not load the default configuration
+                                 and dictionaries.
   --dictionary <name>            Enable a dictionary by name.
   --disable-dictionary <name>    Disable a dictionary by name.
   --reporter <module|path>       Specify one or more reporters to use.
-  --report <level>               Set how unknown words are reported (choices:
-                                 "all", "simple", "typos", "flagged")
+  --report <level>               Set how unknown words are reported
+                                 (choices: "all", "simple", "typos",
+                                 "flagged")
   --issue-template [template]    Use a custom issue template. See --help
                                  --issue-template for details.
   -h, --help                     display help for command
@@ -226,7 +248,7 @@ More Examples:
 
     cspell "/*.md" --no-must-find-files --files $FILES
         Only spell check the "/*.md" files in $FILES,
-        where $FILES is a shell variable that contains the list of files.
+        where $FILES is a shell variable containing the list of files.
 
     cspell --help --verbose
         Show all options including hidden options.
@@ -275,26 +297,32 @@ Usage: cspell trace [options] [words...]
 Trace words -- Search for words in the configuration and dictionaries.
 
 Options:
-  -c, --config <cspell.json>  Configuration file to use.  By default cspell
-                              looks for cspell.json in the current directory.
-  --locale <locale>           Set language locales. i.e. "en,fr" for English and
-                              French, or "en-GB" for British English.
-  --language-id <language>    Use programming language. i.e. "php" or "scala".
+  -c, --config <cspell.json>  Configuration file to use.  By default
+                              cspell looks for cspell.json in the
+                              current directory.
+  --locale <locale>           Set language locales. i.e. "en,fr" for
+                              English and French, or "en-GB" for British
+                              English.
+  --language-id <language>    Use programming language. i.e. "php" or
+                              "scala".
   --allow-compound-words      Turn on allowCompoundWords
   --no-allow-compound-words   Turn off allowCompoundWords
-  --ignore-case               Ignore case and accents when searching for words.
-  --no-ignore-case            Do not ignore case and accents when searching for
+  --ignore-case               Ignore case and accents when searching for
                               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.)
+  --no-ignore-case            Do not ignore case and accents when
+                              searching for 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.)
   --stdin                     Read words from stdin.
   --all                       Show all dictionaries.
-  --only-found                Show only dictionaries that have the words.
+  --only-found                Show only dictionaries that have the
+                              words.
   --color                     Force color.
   --no-color                  Turn off color.
   --no-default-configuration  Do not load the default configuration and
@@ -343,7 +371,7 @@ CSpell needs Node 22 and above.
 
 ## How it works
 
-The concept is simple: split camelCase and snake\_case words before checking them against a list of known words.
+The concept is simple: split camelCase and snake_case words before checking them against a list of known words.
 
 - `camelCase` -> `camel case`
 - `HTMLInput` -> `html input`
@@ -704,7 +732,7 @@ The spell checker includes a set of default dictionaries.
 
 ### General Dictionaries
 
-- **en\_US** - Derived from Hunspell US English words.
+- **en_US** - Derived from Hunspell US English words.
 - **en-gb** - Derived from Hunspell GB English words.
 - **companies** - List of well known companies
 - **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc.

package/dist/esm/app.d.ts

@@ -1,4 +1,4 @@
-import { i as LinterCliOptions } from "./options-DlXe327y.js";
+import { i as LinterCliOptions } from "./options-D5lC3IZu.js";
 import { Command } from "commander";
 //#region src/util/errors.d.ts
 declare class CheckFailed extends Error {

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-CdcDwTFc.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-DRa52DKq.js";
 import { Link } from "cspell-lib";
 import chalk from "chalk";
 import * as iPath from "node:path";
@@ -97,6 +97,19 @@ function crOpt(name, description, parseArg, defaultValue) {
 	return option;
 }
 //#endregion
+//#region src/util/outputWidth.ts
+/**
+* The width to format output for.
+* `COLUMNS` wins when it is a positive integer, otherwise the width of the stream if it has one.
+*/
+function getOutputWidth(stream = process.stdout, env = process.env) {
+	return parseColumns(env.COLUMNS) || stream.columns || void 0;
+}
+function parseColumns(value) {
+	if (!value || !/^\s*\d+\s*$/.test(value)) return void 0;
+	return Number.parseInt(value, 10) || void 0;
+}
+//#endregion
 //#region src/emitters/helpers.ts
 function trimMidPath(s, w, sep) {
 	if (s.length <= w) return s;
@@ -170,7 +183,7 @@ function calcListDictsResultsReport(results, options) {
 		table: tableToLines({
 			header,
 			rows,
-			terminalWidth: options.lineWidth || process.stdout.columns || maxWidth$1,
+			terminalWidth: options.lineWidth || getOutputWidth() || maxWidth$1,
 			deliminator: " ",
 			maxColumnWidths: {
 				locales: 12,
@@ -337,24 +350,25 @@ function commandLink(prog) {
 //#endregion
 //#region src/commandLint.ts
 const usage = `\
-[options] [globs...] [file://<path> ...] [stdin[://<path>]]
+[options] [globs...] [file://<path> ...]
+                   [stdin[://<path>]]
 
 Patterns:
  - [globs...]            Glob Patterns
  - [stdin]               Read from "stdin" assume text file.
- - [stdin://<path>]      Read from "stdin", use <path> for file type and config.
+ - [stdin://<path>]      Read stdin; <path> sets file type and config.
  - [file://<path>]       Check the file at <path>
 
 Examples:
     cspell .                        Recursively check all files.
     cspell lint .                   The same as "cspell ."
-    cspell "*.js"                   Check all .js files in the current directory
+    cspell "*.js"                   Check .js files in this directory
     cspell "**/*.js"                Check all .js files recursively
     cspell "src/**/*.js"            Only check .js under src
     cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
     cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
     cat LICENSE | cspell stdin      Check stdin
-    cspell stdin://docs/doc.md      Check stdin as if it was "./docs/doc.md"\
+    cspell stdin://docs/doc.md      Check stdin as "./docs/doc.md"\
 `;
 const advanced = `
 More Examples:
@@ -375,7 +389,7 @@ More Examples:
 
     cspell "/*.md" --no-must-find-files --files $FILES
         Only spell check the "/*.md" files in $FILES,
-        where $FILES is a shell variable that contains the list of files.
+        where $FILES is a shell variable containing the list of files.
 
     cspell --help --verbose
         Show all options including hidden options.
@@ -386,10 +400,10 @@ References:
 `;
 function commandLint(prog, opts) {
 	const spellCheckCommand = prog.command("lint", 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("--force-check", "Force the --file or --file-list documents to be checked even if it would normally be excluded.").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({
+	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("--force-check", "Force the --file or --file-list documents to be checked even if it would normally be excluded.").option("--follow-symlinks", "Allow checking --file and --file-list documents referenced by symbolic links.").addOption(crOpt("--no-follow-symlinks", "Skip documents referenced by symbolic links.").default(void 0).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).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);
+	})).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("--glob-symlinks", "Follow symbolic links when matching globs.").addOption(crOpt("--no-glob-symlinks", "Do not follow symbolic links when matching globs.").default(void 0).hideHelp()).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) {
@@ -408,7 +422,12 @@ async function action(fileGlobs, cliOptions) {
 		this.outputHelp();
 		throw new CheckFailed("outputHelp", 1);
 	}
-	if (result.errors || mustFindFiles && !result.files) throw new CheckFailed("check failed", 1);
+	if (result.errors) throw new CheckFailed("check failed", 1);
+	const skippedFiles = result.skippedFiles || 0;
+	if (mustFindFiles && result.files <= skippedFiles) {
+		if (!options.silent) console.error(`No files found to check${skippedFiles ? ` (${skippedFiles} skipped)` : ""}.`);
+		throw new CheckFailed("no files found", 1);
+	}
 	if (result.issues) throw new CheckFailed("check failed", useExitCode ? 1 : 0);
 }
 function helpIssueTemplate(opts) {
@@ -455,7 +474,7 @@ function augmentCommandHelp(context) {
 	const showHidden = !!opts.verbose;
 	const hiddenHelp = [];
 	const help = command.createHelp();
-	help.helpWidth = process.stdout.columns || 80;
+	help.helpWidth = getOutputWidth() || 80;
 	const hiddenOptions = command.options.filter((opt) => opt.hidden && showHidden);
 	const flagColWidth = Math.max(...command.options.map((opt) => opt.flags.length), 0);
 	for (const options of hiddenOptions) {
@@ -592,7 +611,7 @@ function calcTraceResultsReport(word, found, results, options) {
 		table: tableToLines({
 			header,
 			rows,
-			terminalWidth: options.lineWidth || process.stdout.columns || maxWidth,
+			terminalWidth: options.lineWidth || getOutputWidth() || maxWidth,
 			deliminator: " "
 		}).map((line) => line.trimEnd()).join("\n"),
 		errors: emitErrors(results).join("\n")
@@ -728,9 +747,15 @@ async function run(command, argv) {
 	const prog = command || program;
 	const args = argv || process.argv;
 	prog.exitOverride();
+	prog.configureOutput({
+		getOutHelpWidth: () => getOutputWidth(process.stdout) ?? 80,
+		getErrHelpWidth: () => getOutputWidth(process.stderr) ?? 80
+	});
+	prog.configureHelp({ minWidthToWrap: 20 });
 	prog.version(npmPackage.version).description("Spelling Checker for Code").name("cspell");
 	if (!satisfies(process.versions.node, npmPackage.engines.node)) throw new ApplicationError(`Unsupported NodeJS version (${process.versions.node}); ${npmPackage.engines.node} is required`);
-	addGlobalOptionsToAction(commandLint(prog, { isDefault: true }));
+	const lintCommand = addGlobalOptionsToAction(commandLint(prog, { isDefault: true }));
+	prog.addHelpText("after", (context) => defaultCommandOptionsHelp(context, lintCommand));
 	addGlobalOptionsToAction(commandTrace(prog));
 	addGlobalOptionsToAction(commandCheck(prog));
 	addGlobalOptionsToAction(commandSuggestion(prog));
@@ -741,6 +766,18 @@ async function run(command, argv) {
 	prog.exitOverride();
 	await prog.parseAsync(args);
 }
+/**
+* `cspell --help` is answered by the program, not the default command,
+* so list the default command's options here.
+*/
+function defaultCommandOptionsHelp(context, defaultCommand) {
+	const helper = defaultCommand.createHelp();
+	helper.prepareContext({ helpWidth: getOutputWidth(context.error ? process.stderr : process.stdout) ?? 80 });
+	const termWidth = helper.longestOptionTermLength(defaultCommand, helper);
+	const items = helper.visibleOptions(defaultCommand).filter((option) => option.long !== "--help").map((option) => helper.formatItem(helper.styleOptionTerm(helper.optionTerm(option)), termWidth, helper.styleOptionDescription(helper.optionDescription(option)), helper));
+	const heading = `Options for "${defaultCommand.name()}" (the default command):`;
+	return "\n" + helper.formatItemList(heading, items, helper).join("\n");
+}
 //#endregion
 export { ApplicationError, CheckFailed, run };
 

package/dist/esm/{application-094uTsvC.d.ts → application-CFfMlhE_.d.ts}

@@ -1,4 +1,4 @@
-import { a as SuggestionOptions, i as LinterCliOptions, n as DictionariesOptions, o as TraceOptions, r as LegacyOptions, t as BaseOptions } from "./options-DlXe327y.js";
+import { a as SuggestionOptions, i as LinterCliOptions, n as DictionariesOptions, o as TraceOptions, r as LegacyOptions, t as BaseOptions } from "./options-D5lC3IZu.js";
 import { CheckTextInfo, FeatureFlags, IncludeExcludeFlag, SuggestionsForWordResult, TraceResult, TraceWordResult } from "cspell-lib";
 import { CSpellReporter, RunResult } from "@cspell/cspell-types";
 //#region src/config/options.d.ts
@@ -106,7 +106,15 @@ interface ListDictionariesResult {
 declare function listDictionaries(options: DictionariesOptions): Promise<ListDictionariesResult[]>;
 //#endregion
 //#region src/application.d.mts
-type AppError = NodeJS.ErrnoException;
+/**
+ * The same shape as `NodeJS.ErrnoException`, declared here so the published types do not need `@types/node`.
+ */
+interface AppError extends Error {
+  errno?: number | undefined;
+  code?: string | undefined;
+  path?: string | undefined;
+  syscall?: string | undefined;
+}
 declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
 declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceWordResult>;
 type CheckTextResult = CheckTextInfo;
@@ -116,4 +124,4 @@ declare function createInit(options: InitOptions): Promise<void>;
 declare function parseApplicationFeatureFlags(flags: string[] | undefined): FeatureFlags;
 //#endregion
 export { checkText as a, parseApplicationFeatureFlags as c, listDictionaries as d, TraceResult as i, suggestions as l, CheckTextResult as n, createInit as o, IncludeExcludeFlag as r, lint as s, AppError as t, trace as u };
-//# sourceMappingURL=application-094uTsvC.d.ts.map
+//# sourceMappingURL=application-CFfMlhE_.d.ts.map