cspell 9.1.3 → 9.2.0

package/README.md

@@ -562,9 +562,11 @@ _cspell_'s behavior can be controlled through a config file. By default it looks
 - `cSpell.json`
 - `cspell.config.js`
 - `cspell.config.cjs`
+- `cspell.config.mjs`
 - `cspell.config.json`
 - `cspell.config.yaml`
 - `cspell.config.yml`
+- `cspell.config.toml`
 - `cspell.yaml`
 - `cspell.yml`
 
@@ -574,32 +576,35 @@ Or you can specify a path to a config file with the `--config <path>` argument o
 
 #### Example `cspell.json` file
 
-```javascript
+```jsonc
 // cSpell Settings
 {
-    // Version of the setting file.  Always 0.2
-    "version": "0.2",
-    // language - current active spelling language
-    "language": "en",
-    // words - list of words to be always considered correct
-    "words": [
-        "mkdirp",
-        "tsmerge",
-        "githubusercontent",
-        "streetsidesoftware",
-        "vsmarketplacebadge",
-        "visualstudio"
-    ],
-    // flagWords - list of words to be always considered incorrect
-    // This is useful for offensive words and common spelling errors.
-    // For example "hte" should be "the"
-    "flagWords": [
-        "hte"
-    ]
+  // Version of the setting file.  Always 0.2
+  "version": "0.2",
+  // language - current active spelling language
+  "language": "en",
+  // words - list of words to be always considered correct
+  "words": ["mkdirp", "tsmerge", "githubusercontent", "streetsidesoftware", "vsmarketplacebadge", "visualstudio"],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": ["hte"]
 }
 ```
 
-### cspell.json sections
+#### Example `cspell.config.mjs` file
+
+```js
+// @ts-check
+
+import { defineConfig } from 'cspell';
+
+export default defineConfig({
+  words: ['mycompany']
+});
+```
+
+### Configuration Sections
 
 - `version` - currently always 0.2 - controls how the settings in the configuration file behave.
 
@@ -657,6 +662,8 @@ Or you can specify a path to a config file with the `--config <path>` argument o
 
 - `languageSettings` - this allow 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.
+
 ## Dictionaries
 
 The spell checker includes a set of default dictionaries.
@@ -811,4 +818,5 @@ Example:
     cspell:words Verdana
     cspell:ignore ieeees beees treeees
     cspell:ignore amet
+    cspell:ignore mycompany
 -->

package/bin.mjs

@@ -3,7 +3,7 @@ import { format } from 'node:util';
 
 import { CommanderError, program } from 'commander';
 
-import { ApplicationError, CheckFailed, run } from './dist/esm/app.mjs';
+import { ApplicationError, CheckFailed, run } from './dist/esm/app.js';
 
 run(program, process.argv).catch((e) => {
     if (!(e instanceof CommanderError) && !(e instanceof CheckFailed)) {

package/dist/esm/app.d.ts

@@ -0,0 +1,19 @@
+import { LinterCliOptions } from "./options-ChaXtdFn.js";
+import { Command } from "commander";
+
+//#region src/util/errors.d.ts
+declare class CheckFailed extends Error {
+  readonly exitCode: string;
+  constructor(message: string, exitCode?: number);
+}
+declare class ApplicationError extends Error {
+  readonly exitCode: string;
+  readonly cause?: number;
+  constructor(message: string, exitCode?: number, cause?: Error | undefined);
+}
+//#endregion
+//#region src/app.d.mts
+declare function run(command?: Command, argv?: string[]): Promise<void>;
+//#endregion
+export { ApplicationError, CheckFailed, type LinterCliOptions as Options, run };
+//# sourceMappingURL=app.d.ts.map