cspell 10.3.1-alpha.1 → 10.3.2-alpha.0

package/README.md

@@ -1,9 +1,5 @@
 # cspell
 
-[![](https://github.com/streetsidesoftware/cspell/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions)
-[![Coverage Status](https://coveralls.io/repos/github/streetsidesoftware/cspell/badge.svg?branch=main)](https://coveralls.io/github/streetsidesoftware/cspell?branch=main)
-[![codecov](https://codecov.io/gh/streetsidesoftware/cspell/branch/main/graph/badge.svg?token=Dr4fi2Sy08)](https://codecov.io/gh/streetsidesoftware/cspell)
-
 A Spell Checker for Code!
 
 `cspell` is a command line tool and library for spell checking code.
@@ -12,24 +8,22 @@ A Spell Checker for Code!
 
 <!--- @@inject: ../../static/sponsor.md --->
 
-[![GitHub Sponsors](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=githubsponsors&label=GitHub%20Sponsor%3A)](https://github.com/sponsors/streetsidesoftware)
-
-[![Open Collective](https://img.shields.io/badge/-CSpell-black?style=for-the-badge&logo=opencollective&label=Open%20Collective%3A)](https://opencollective.com/cspell)
+If our spell checkers save you time, please consider supporting their development.
 
-[![Street Side Software](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fstreetsidesoftware%2Fcspell%2Frefs%2Fheads%2Fmain%2Fstatic%2Fcspell-badge.json)](https://streetsidesoftware.com/sponsor/)
-
-[![PayPal](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=paypal&label=PayPal%20Donate%3A)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
+<p align="left">
+  <a href="https://github.com/sponsors/streetsidesoftware" title="GitHub Sponsor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/github-sponsor-dark.png" /><img alt="GitHub Sponsor" src="https://cspell.org/img/sponsor/github-sponsor.png" width="180" /></picture></a> &nbsp; <a href="https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY" title="PayPal"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/paypal-dark.png" /><img alt="PayPal" src="https://cspell.org/img/sponsor/paypal.png" width="180" /></picture></a> &nbsp; <a href="https://opencollective.com/cspell" title="Open Collective"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/open-collective-dark.png" /><img alt="Open Collective" src="https://cspell.org/img/sponsor/open-collective.png" width="180" /></picture></a> &nbsp; <a href="https://streetsidesoftware.com/sponsor/" title="Street Side Software"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cspell.org/img/sponsor/cspell-dark.png" /><img alt="CSpell" src="https://cspell.org/img/sponsor/cspell.png" width="180" /></picture></a>
+</p>
 
 <!--- @@inject-end: ../../static/sponsor.md --->
 
 ## Features
 
-- Spell Checks Code -- Able to spell check code by parsing it into words before checking against the dictionaries.
+- Spell Checks Code -- Parses code into words before checking them against the dictionaries.
   - 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.
+- 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:
-  - JavaScript, TypeScript, Python, PHP, C#, C++, LaTex, Go, HTML, CSS, etc.
+  - JavaScript, TypeScript, Python, PHP, C#, C++, LaTeX, Go, HTML, CSS, etc.
 - Customizable -- supports custom dictionaries and word lists.
 - Continuous Integration Support -- Can easily be added as a linter to Travis-CI.
 
@@ -265,7 +259,7 @@ cspell check <filename> --color | less -r
 
 ## Command: `trace` - See which dictionaries contain a word
 
-Trace shows a the list of known dictionaries and a `*` next to the ones that contain the word.
+Trace shows the list of known dictionaries and a `*` next to the ones that contain the word.
 
 A `!` will appear next to the ones where the word is forbidden.
 
@@ -310,23 +304,21 @@ Options:
 
 <!--- @@inject-end: static/help-trace.txt --->
 
-## CI/CD Continuous Integration support
+## CI/CD Support
 
 ### Mega-Linter
 
-[Mega-Linter](https://nvuillam.github.io/mega-linter/) aggregates 70 linters ready to use out of the box, including [cspell](https://nvuillam.github.io/mega-linter/descriptors/spell_cspell/)
+[Mega-Linter](https://megalinter.io/latest/) aggregates 70 linters ready to use out of the box, including [cspell](https://megalinter.io/latest/descriptors/spell_cspell/)
 
 - Can run as a GitHub Action, on other CI tools and locally
 - Provides an updated `.cspell.json` file with new unknown words
 
 **Setup**
 
-Quick setup following installation guide in [Mega-Linter documentation](https://nvuillam.github.io/mega-linter/)
+Quick setup following installation guide in [Mega-Linter documentation](https://megalinter.io/latest/)
 
 ### Git commit-hooks
 
-#### pre-commit
-
 **Setup**
 
 ```
@@ -335,19 +327,23 @@ npm install -SD cspell
 
 **`.git/hooks/pre-commit`**
 
-```
+```sh
 #!/bin/sh
 
 exec git diff --cached --name-only | npx cspell --no-summary --no-progress --no-must-find-files --file-list stdin
 ```
 
+### Using [pre-commit.com](https://pre-commit.com) Hook
+
+Use: [`cspell-cli`](https://github.com/streetsidesoftware/cspell-cli#setup-pre-commit-hook)
+
 ## Requirements
 
 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`
@@ -358,14 +354,18 @@ The concept is simple, split camelCase and snake\_case words before checking the
 
 ### Special cases
 
-- Escape characters like `\n`, `\t` are removed if the word does not match:
-  - `\narrow` -> `narrow` - because `narrow` is a word
-  - `\ncode` -> `code` - because `ncode` is not a word.
-  - `\network` -> `network` - but it might be hiding a spelling error, if `\n` was an escape character.
+- Escape sequences like `\n` and `\t` are stripped from words one character at a time: the backslash is
+  always removed, and the letter (`n`, `t`, etc.) is kept only if doing so still produces a known word.
+  - `\narrow` -> `narrow` -- the `n` is kept because `narrow` is a word.
+  - `\ncode` -> `code` -- the `n` is dropped too, because `ncode` is not a word.
+  - `\network` -> `network` -- the `n` is kept because `network` is a word, but this might hide a real
+    typo if `\n` was actually meant as a newline followed by a misspelling.
 
 ### Things to note
 
-- This spellchecker is case insensitive. It will not catch errors like `english` which should be `English`.
+- By default, case and accent checking is off for English, so it will not catch errors like `english` which should be `English`.
+  This is controlled by the `caseSensitive` setting -- see [Case and Accent Sensitivity](https://cspell.org/docs/case-sensitive).
+  Some language dictionaries (like German, French, and Spanish) turn on case sensitivity by default.
 - The spellchecker uses dictionaries stored locally. It does not send anything outside your machine.
 - The words in the dictionaries can and do contain errors.
 - There are missing words.
@@ -375,9 +375,9 @@ The concept is simple, split camelCase and snake\_case words before checking the
 ## In Document Settings
 
 It is possible to add spell check settings into your source code.
-This is to help with file specific issues that may not be applicable to the entire project.
+This is to help with file-specific issues that may not be applicable to the entire project.
 
-All settings are prefixed with `cspell:` or `spell-checker:`.
+All settings are prefixed with `cspell:`, `spell-checker:`, or `spellchecker:` (the prefix is case insensitive, and the hyphen in `spell-checker:` is optional).
 
 - `disable` -- turn off the spell checker for a section of code.
 - `enable` -- turn the spell checker back on after it has been turned off.
@@ -513,7 +513,8 @@ var email1 = 'emailaddress@myfancynewcompany.com';
 var email2 = '<emailaddress@myfancynewcompany.com>';
 ```
 
-**Note:** ignoreRegExp and includeRegExp are applied to the entire file. They do not start and stop.
+**Note:** `ignoreRegExp` and `includeRegExp` apply to the entire file, unlike `cspell:disable`/`cspell:enable`,
+which only affect the section of code between them.
 
 #### Include Example
 
@@ -585,6 +586,26 @@ _cspell_'s behavior can be controlled through a config file. By default it looks
 
 Or you can specify a path to a config file with the `--config <path>` argument on the command line.
 
+### How Configuration Is Determined
+
+Spell checking is a two step process:
+
+1. **Determine which files to check** -- from command line globs (or the configuration's `files` setting if no
+   globs are given), or from `--file`/`--files`/`--file-list`, filtered against `ignorePaths`, `--exclude`, and
+   `.gitignore`.
+1. **Determine the settings, and check the document** -- merge the built-in defaults, the configuration loaded
+   at start up (the project's configuration file, found searching upward from the current directory or given
+   with `--config`, plus a few CLI flags like `--dictionary`, `--disable-dictionary`, and `--report`), and the
+   configuration file nearest the document, which overrides all of the above. Then apply `overrides` and
+   `languageSettings` that match the document, then any in-document directives (`cspell:ignore`, `cspell:words`,
+   etc.), which always take precedence.
+
+Most other CLI flags (`--no-progress`, `--show-suggestions`, `-v`/`--verbose`, `--color`, ...) only control what
+the CLI reports and are not part of this process.
+
+See [Configuration Resolution & Overrides](https://cspell.org/configuration/overrides/) and
+[In-Document Settings](https://cspell.org/configuration/document-settings/) for details.
+
 ### `cspell.json`
 
 #### Example `cspell.json` file
@@ -640,13 +661,13 @@ export default defineConfig({
 
   will cause cspell to ignore anything in the `node_modules` directory.
 
-- `maxNumberOfProblems` - defaults to **_100_** per file.
+- `maxNumberOfProblems` - defaults to **_10,000_** per file.
 
 - `minWordLength` - defaults to **_4_** - the minimum length of a word before it is checked.
 
 - `allowCompoundWords` - defaults to **_false_**; set to **true** to allow compound words by default.
 
-- `dictionaries` - list of the names of the dictionaries to use. See [Dictionaries](#Dictionaries) below.
+- `dictionaries` - list of the names of the dictionaries to use. See [Dictionaries](#dictionaries) below.
 
 - `dictionaryDefinitions` - this list defines any custom dictionaries to use. This is how you can include other languages like Spanish.
 
@@ -654,10 +675,10 @@ export default defineConfig({
 
   ```javascript
   "language": "en",
-  // Dictionaries "spanish", "ruby", and "corp-term" will always be checked.
+  // Dictionaries "spanish", "ruby", and "company-terms" will always be checked.
   // Including "spanish" in the list of dictionaries means both Spanish and English
   // words will be considered correct.
-  "dictionaries": ["spanish", "ruby", "corp-terms", "fonts"],
+  "dictionaries": ["spanish", "ruby", "company-terms", "fonts"],
   // Define each dictionary. Relative paths are relative to the config file.
   "dictionaryDefinitions": [
       { "name": "spanish", "path": "./spanish-words.txt"},
@@ -673,7 +694,7 @@ export default defineConfig({
 - `patterns` - this allows you to define named patterns to be used with
   `ignoreRegExpList` and `includeRegExpList`.
 
-- `languageSettings` - this allow for per programming language configuration settings. See [LanguageSettings](#LanguageSettings)
+- `languageSettings` - this allows for per programming language configuration settings. See [LanguageSettings](#languagesettings)
 
 - `overrides` - this allows for settings to be based upon the file name or path. It is useful for setting the language for localization.
 
@@ -701,7 +722,7 @@ The spell checker includes a set of default dictionaries.
 - **css** - _css_, _less_, and _scss_ related keywords
 - **cpp** - _C++_ related keywords
 - **csharp** - _C#_ related keywords
-- **latex** - LaTex related words
+- **latex** - LaTeX related words
 - **bash** - Bash/shell script keywords
 
 ### Miscellaneous Dictionaries
@@ -716,13 +737,12 @@ The spell checker includes a set of default dictionaries.
 - **description** - Optional description
 - **path** - Path to the file, can be relative or absolute. Relative path is relative to the
   current `cspell.json` file.
-- **repMap** - Optional replacement map use to replace character prior to searching the dictionary.
+- **repMap** - Optional replacement map used to replace characters prior to searching the dictionary.
   Example:
   ```javascript
       // Replace various tick marks with a single '
       "repMap": [["'|`|’", "'"]]
   ```
-  // Use Compounds
 - **useCompounds** - allow compound words
 
 ```javascript
@@ -767,7 +787,7 @@ There are two selector fields `locale` and `languageId`.
   use `"*"`.
 - `locale` defines which spoken languages to match against. A value of `"en-GB,nl"` will match against British English or Dutch.
   A value of `"*"` will match all spoken languages.
-- Most configuration values allowed in a `cspell.json` file can be define or redefine within the `languageSettings`.
+- Most configuration values allowed in a `cspell.json` file can be defined or redefined within the `languageSettings`.
 
 ```javascript
     "languageSettings": [

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-BWKRmSlw.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-CyAnKMRe.js";
 import { Link } from "cspell-lib";
 import chalk from "chalk";
 import * as iPath from "node:path";

package/dist/esm/{application-BWKRmSlw.js → application-CyAnKMRe.js}

@@ -1213,7 +1213,7 @@ try {
 const pkgDir = _dirname;
 const npmPackage = {
 	name: "cspell",
-	version: "10.3.1-alpha.1",
+	version: "10.3.2-alpha.0",
 	engines: { node: ">=22.18.0" }
 };
 //#endregion
@@ -3532,4 +3532,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-BWKRmSlw.js.map
+//# sourceMappingURL=application-CyAnKMRe.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-BWKRmSlw.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-CyAnKMRe.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-BWKRmSlw.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-CyAnKMRe.js";
 export * from "@cspell/cspell-types";
 export { IncludeExcludeFlag, checkText, createInit, getReporter as getDefaultReporter, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "10.3.1-alpha.1",
+  "version": "10.3.2-alpha.0",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -90,23 +90,23 @@
   },
   "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "10.3.1-alpha.1",
-    "@cspell/cspell-performance-monitor": "10.3.1-alpha.1",
-    "@cspell/cspell-pipe": "10.3.1-alpha.1",
-    "@cspell/cspell-types": "10.3.1-alpha.1",
-    "@cspell/cspell-worker": "10.3.1-alpha.1",
-    "@cspell/dynamic-import": "10.3.1-alpha.1",
-    "@cspell/url": "10.3.1-alpha.1",
+    "@cspell/cspell-json-reporter": "10.3.2-alpha.0",
+    "@cspell/cspell-performance-monitor": "10.3.2-alpha.0",
+    "@cspell/cspell-pipe": "10.3.2-alpha.0",
+    "@cspell/cspell-types": "10.3.2-alpha.0",
+    "@cspell/cspell-worker": "10.3.2-alpha.0",
+    "@cspell/dynamic-import": "10.3.2-alpha.0",
+    "@cspell/url": "10.3.2-alpha.0",
     "ansi-regex": "^6.3.0",
     "chalk": "^6.0.0",
     "chalk-template": "^1.1.2",
     "commander": "^15.0.0",
-    "cspell-config-lib": "10.3.1-alpha.1",
-    "cspell-dictionary": "10.3.1-alpha.1",
-    "cspell-gitignore": "10.3.1-alpha.1",
-    "cspell-glob": "10.3.1-alpha.1",
-    "cspell-io": "10.3.1-alpha.1",
-    "cspell-lib": "10.3.1-alpha.1",
+    "cspell-config-lib": "10.3.2-alpha.0",
+    "cspell-dictionary": "10.3.2-alpha.0",
+    "cspell-gitignore": "10.3.2-alpha.0",
+    "cspell-glob": "10.3.2-alpha.0",
+    "cspell-io": "10.3.2-alpha.0",
+    "cspell-lib": "10.3.2-alpha.0",
     "fast-json-stable-stringify": "^2.1.0",
     "flatted": "^3.4.4",
     "semver": "^7.8.5",
@@ -121,5 +121,5 @@
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.9"
   },
-  "gitHead": "aa0576e5b7e666a7e8645939871bcfe4fa2a7eb5"
+  "gitHead": "c7193065b82df0646e24ab6f6d370c12148f0efc"
 }