cspell 9.1.2 → 9.1.5

package/dist/esm/application-DbOQYm56.d.ts

@@ -0,0 +1,116 @@
+import { BaseOptions, DictionariesOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from "./options-ChaXtdFn.js";
+import { CheckTextInfo, FeatureFlags, IncludeExcludeFlag, SuggestionsForWordResult, TraceResult, TraceWordResult } from "cspell-lib";
+import { CSpellReporter, RunResult } from "@cspell/cspell-types";
+
+//#region src/config/options.d.ts
+interface BaseConfigOptions {
+  /**
+  * The path to the configuration file to create / update.
+  * If not provided, a default file name will be used based on the format.
+  */
+  config?: string;
+  /**
+  * The list of configuration files or dictionary packages to import.
+  * This can be a list of file paths, package names, or URLs.
+  */
+  import?: string[];
+  /**
+  * The locale to use when spell checking (e.g., en, en-US, de).
+  */
+  locale?: string;
+  /**
+  * Whether to add comments to the configuration file.
+  * - `true` - comments will be added to the configuration file.
+  * - `false` - no comments will be added.
+  * - `undefined` - the default behavior will be used based on the format.
+  */
+  comments?: boolean;
+  /**
+  * Whether to remove all comments from the configuration file.
+  * - `true` - all comments will be removed.
+  * - `false` | `undefined` - no comments will be removed.
+  * @implies `comments: false`
+  */
+  removeComments?: boolean;
+  /**
+  * Whether to add the schema reference to the configuration file.
+  * - `true` - the schema reference will be added / updated.
+  * - `false` - no schema reference will be added.
+  */
+  schema?: boolean;
+  /**
+  * The list of dictionaries to enable in the configuration file.
+  * These are added to an existing configuration file or a new one.
+  * Existing dictionaries will not be removed.
+  */
+  dictionary?: string[];
+  /**
+  * Whether to write the configuration to stdout instead of a file.
+  */
+  stdout?: boolean;
+}
+interface InitOptions extends BaseConfigOptions {
+  /**
+  * The path where the configuration file will be written, it can be a file path or a URL.
+  * If not provided, a default file name will be used based on the format.
+  * The default will be `cspell.config.yaml` or `cspell.json` based on the format.
+  * @conflicts `config` - If `config` is provided, it will be used instead of `output`.
+  */
+  output?: string;
+  /**
+  * The format of the configuration file.
+  * @conflicts `config` - If `config` is provided, the format will be inferred from the file extension.
+  */
+  format?: "yaml" | "yml" | "json" | "jsonc";
+}
+//#endregion
+//#region src/emitters/suggestionsEmitter.d.ts
+interface TimedSuggestionsForWordResult extends SuggestionsForWordResult {
+  elapsedTimeMs?: number;
+}
+//#endregion
+//#region src/dictionaries/listDictionaries.d.ts
+interface ListDictionariesResult {
+  /**
+  * The name of the dictionary.
+  */
+  name: string;
+  /**
+  * The description of the dictionary.
+  */
+  description?: string | undefined;
+  /**
+  * The path to the dictionary file.
+  */
+  path?: string | undefined;
+  /**
+  * True if the dictionary is enabled.
+  */
+  enabled: boolean;
+  /**
+  * The inline dictionaries supported by the dictionary.
+  */
+  inline?: string[] | undefined;
+  /**
+  * the languages locales supported by the dictionary.
+  */
+  locales?: string[] | undefined;
+  /**
+  * The file types supported by the dictionary.
+  */
+  fileTypes?: string[] | undefined;
+}
+declare function listDictionaries(options: DictionariesOptions): Promise<ListDictionariesResult[]>;
+//#endregion
+//#region src/application.d.mts
+type AppError = NodeJS.ErrnoException;
+declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
+declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceWordResult>;
+type CheckTextResult = CheckTextInfo;
+declare function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult>;
+declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<TimedSuggestionsForWordResult>;
+declare function createInit(options: InitOptions): Promise<void>;
+declare function parseApplicationFeatureFlags(flags: string[] | undefined): FeatureFlags;
+//#endregion
+export { AppError, CheckTextResult, IncludeExcludeFlag, TraceResult, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };
+//# sourceMappingURL=application-DbOQYm56.d.ts.map

package/dist/esm/application.d.ts

@@ -0,0 +1,3 @@
+import "./options-ChaXtdFn.js";
+import { AppError, CheckTextResult, IncludeExcludeFlag, TraceResult, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace } from "./application-DbOQYm56.js";
+export { AppError, CheckTextResult, IncludeExcludeFlag, TraceResult, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/dist/esm/application.js

@@ -0,0 +1,3 @@
+import { IncludeExcludeFlag, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace } from "./application-D-NwS6qb.js";
+
+export { IncludeExcludeFlag, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/dist/esm/index.d.ts

@@ -0,0 +1,55 @@
+import { BaseOptions, LinterCliOptions, TraceOptions } from "./options-ChaXtdFn.js";
+import { AppError, CheckTextResult, IncludeExcludeFlag, TraceResult, checkText, createInit, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace } from "./application-DbOQYm56.js";
+import "chalk";
+import { CSpellReporter, CSpellSettings, ReporterConfiguration, RunResult } from "@cspell/cspell-types";
+import { WriteStream } from "node:tty";
+export * from "@cspell/cspell-types";
+
+//#region src/console.d.ts
+type Log = (format?: any, ...params: any[]) => void;
+type IOStream = NodeJS.WritableStream & Pick<WriteStream, "isTTY" | "rows" | "columns"> & Pick<Partial<WriteStream>, "hasColors" | "clearLine" | "getColorDepth">;
+interface IConsole {
+  readonly log: Log;
+  readonly error: Log;
+  readonly info: Log;
+  readonly warn: Log;
+  readonly stderrChannel: Channel;
+  readonly stdoutChannel: Channel;
+}
+interface Channel {
+  stream: IOStream;
+  write: (msg: string) => void;
+  writeLine: (msg: string) => void;
+  clearLine: (dir: -1 | 0 | 1, callback?: () => void) => boolean;
+  printLine: (format?: any, ...params: any[]) => void;
+  getColorLevel: () => 0 | 1 | 2 | 3;
+}
+//#endregion
+//#region src/models.d.ts
+type ReporterConsole = IConsole;
+interface CSpellReporterConfiguration extends Readonly<ReporterConfiguration>, Readonly<LinterCliOptions> {
+  /**
+  * The console to use for reporting.
+  * @since 8.11.1
+  */
+  readonly console?: ReporterConsole;
+}
+interface CSpellReporterModule {
+  getReporter: <T>(settings: T, config: CSpellReporterConfiguration) => CSpellReporter;
+}
+//#endregion
+//#region src/util/reporters.d.ts
+type FinalizedReporter = Required<CSpellReporter>;
+/**
+* Loads reporter modules configured in cspell config file
+*/
+
+//#endregion
+//#region src/cli-reporter.d.ts
+interface ReporterOptions extends Pick<LinterCliOptions, "color" | "debug" | "issues" | "issuesSummaryReport" | "legacy" | "progress" | "relative" | "root" | "showContext" | "showPerfSummary" | "showSuggestions" | "silent" | "summary" | "verbose" | "wordsOnly"> {
+  fileGlobs: string[];
+}
+declare function getReporter(options: ReporterOptions, config?: CSpellReporterConfiguration): FinalizedReporter;
+//#endregion
+export { AppError, BaseOptions, LinterCliOptions as CSpellApplicationOptions, CSpellReporterConfiguration, CSpellReporterModule, CheckTextResult, IncludeExcludeFlag, TraceOptions, TraceResult, checkText, createInit, getReporter as getDefaultReporter, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+import { IncludeExcludeFlag, checkText, createInit, getReporter, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace } from "./application-D-NwS6qb.js";
+
+export * from "@cspell/cspell-types"
+
+export { IncludeExcludeFlag, checkText, createInit, getReporter as getDefaultReporter, lint, listDictionaries, parseApplicationFeatureFlags, suggestions, trace };

package/dist/esm/options-ChaXtdFn.d.ts

@@ -0,0 +1,387 @@
+import { CSpellSettings, CacheFormat, CacheStrategy, ReporterConfiguration } from "@cspell/cspell-types";
+
+//#region src/util/cache/CacheOptions.d.ts
+interface CacheOptions {
+  /**
+  * The version of `cspell` that made the cache entry.
+  * Cache entries must match the `major.minor` version.
+  */
+  version: string;
+  /**
+  * Store the info about processed files in order to only operate on the changed ones.
+  */
+  cache?: boolean;
+  /**
+  * Path to the cache location. Can be a file or a directory.
+  * If none specified .cspellcache will be used.
+  * The file will be created in the directory where the cspell command is executed.
+  */
+  cacheLocation?: string;
+  /**
+  * Strategy to use for detecting changed files, default: metadata
+  */
+  cacheStrategy?: CacheStrategy;
+  /**
+  * Resets the cache
+  */
+  cacheReset?: boolean;
+  /**
+  * Format of the cache file.
+  * - `legacy` - use absolute paths in the cache file
+  * - `universal` - use a sharable format.
+  * @default 'legacy'
+  */
+  cacheFormat?: CacheFormat;
+}
+//#endregion
+//#region src/options.d.ts
+interface LinterOptions extends Omit<BaseOptions, "config">, Omit<CacheOptions, "version">, ReporterConfiguration {
+  /**
+  * Display verbose information
+  */
+  verbose?: boolean;
+  /**
+  * Show extensive output.
+  */
+  debug?: boolean;
+  /**
+  * a globs to exclude files from being checked.
+  */
+  exclude?: string[] | string;
+  /**
+  * Only report the words, no line numbers or file names.
+  */
+  wordsOnly?: boolean;
+  /**
+  * unique errors per file only.
+  */
+  unique?: boolean;
+  /**
+  * root directory, defaults to `cwd`
+  */
+  root?: string;
+  /**
+  * Determine if files / directories starting with `.` should be part
+  * of the glob search.
+  * @default false
+  */
+  dot?: boolean;
+  /**
+  * Show part of a line where an issue is found.
+  * - if true, it will show the default number of characters on either side.
+  * - if a number, the number of characters to show on either side of the issue.
+  */
+  showContext?: boolean | number;
+  /**
+  * Show suggestions for spelling errors.
+  */
+  showSuggestions?: boolean;
+  /**
+  * Enable filtering out files matching globs found in `.gitignore` files.
+  */
+  gitignore?: boolean;
+  /**
+  * Stop searching for a `.gitignore`s when a root is reached.
+  */
+  gitignoreRoot?: string | string[];
+  /**
+  * List of files that contains the paths to files to be spell checked.
+  * The files in the lists will be filtered against the glob patterns.
+  * - an entry of `stdin` means to read the file list from **`stdin`**
+  * The resulting files are filtered against the `files` globs found in the configuration.
+  */
+  fileList?: string[] | undefined;
+  /**
+  * List of file paths to spell check. These can be relative or absolute
+  * paths, but not Globs. Relative paths are relative to {@link LinterOptions.root}.
+  * The files are combined with the file paths read from {@link LinterOptions.fileList}.
+  * These files are filtered against the `files` globs found in the configuration.
+  */
+  files?: string[] | undefined;
+  /**
+  * Alias of {@link LinterOptions.files}.
+  */
+  file?: string[] | undefined;
+  /**
+  * Use the `files` configuration to filter the files found.
+  */
+  filterFiles?: boolean | undefined;
+  /**
+  * Files must be found and processed otherwise it is considered an error.
+  */
+  mustFindFiles?: boolean;
+  /**
+  * List of dictionary names to use.
+  */
+  dictionary?: string[] | undefined;
+  /**
+  * List of dictionary names to disable.
+  */
+  disableDictionary?: string[] | undefined;
+  /**
+  * Stop processing and exit if an issue or error is found.
+  */
+  failFast?: boolean;
+  /**
+  * Keep going even if an error is found.
+  */
+  continueOnError?: boolean;
+  /**
+  * Optional list of reporters to use, overriding any specified in the
+  * configuration.
+  */
+  reporter?: string[];
+  /**
+  * Load and parse documents, but do not spell check.
+  */
+  skipValidation?: boolean;
+  /**
+  * Path to configuration file.
+  */
+  config?: string | CSpellConfigFile;
+}
+interface TraceOptions extends BaseOptions {
+  /**
+  * Use stdin for the input.
+  */
+  stdin?: boolean;
+  /**
+  * Enable the `allowCompoundWords` option.
+  */
+  allowCompoundWords?: boolean;
+  /**
+  * Ignore case and accents when searching for words.
+  */
+  ignoreCase?: boolean;
+  /**
+  * Show all dictionaries, not just the ones that contain the words or are enabled.
+  */
+  all?: boolean;
+  /**
+  * Show only dictionaries that contain the words.
+  * If `all` is set, this option is ignored.
+  */
+  onlyFound?: boolean;
+  /**
+  * Names of dictionaries to use.
+  */
+  dictionary?: string[] | undefined;
+  /**
+  * Configure how to display the dictionary path.
+  */
+  dictionaryPath?: "hide" | "long" | "short" | "full";
+}
+interface SuggestionOptions extends BaseOptions {
+  /**
+  * Strict case and accent checking
+  * @default true
+  */
+  strict?: boolean;
+  /**
+  * List of dictionaries to use. If specified, only that list of dictionaries will be used.
+  */
+  dictionaries?: string[] | undefined;
+  /**
+  * The number of suggestions to make.
+  * @default 8
+  */
+  numSuggestions?: number;
+  /**
+  * Max number of changes / edits to the word to get to a suggestion matching suggestion.
+  * @default 4
+  */
+  numChanges?: number;
+  /**
+  * If multiple suggestions have the same edit / change "cost", then included them even if
+  * it causes more than `numSuggestions` to be returned.
+  * @default true
+  */
+  includeTies?: boolean;
+  /**
+  * Use stdin for the input
+  */
+  useStdin?: boolean | undefined;
+  /**
+  * Use REPL interface for making suggestions.
+  */
+  repl?: boolean;
+}
+interface DictionariesOptions {
+  /**
+  * Path to configuration file.
+  */
+  config?: string;
+  /**
+  * Load the default configuration
+  * @default true
+  */
+  defaultConfiguration?: boolean;
+  /**
+  * Use color in the output.
+  * `true` to force color, `false` to turn off color.
+  * `undefined` to use color if the output is a TTY.
+  */
+  color?: boolean | undefined;
+  /**
+  * Show enabled:
+  * - `true` to show only enabled dictionaries.
+  * - `false` to show only disabled dictionaries.
+  * - `undefined` to show all dictionaries.
+  */
+  enabled?: boolean | undefined;
+  /**
+  * The locale to use when listing dictionaries.
+  */
+  locale?: string;
+  /**
+  * The file type to use when listing dictionaries.
+  */
+  fileType?: string;
+  /**
+  * show the language locales supported by the dictionary.
+  */
+  showLocales?: boolean;
+  /**
+  * show the file types supported by the dictionary.
+  */
+  showFileTypes?: boolean;
+  /**
+  * Dhow the location of the dictionary.
+  */
+  showLocation?: boolean;
+  pathFormat?: "hide" | "short" | "long" | "full";
+}
+interface LegacyOptions {
+  local?: string;
+}
+interface BaseOptions {
+  /**
+  * Path to configuration file.
+  */
+  config?: string;
+  /**
+  * Programming Language ID.
+  */
+  languageId?: string;
+  /**
+  * Locale to use.
+  */
+  locale?: string;
+  /**
+  * Load the default configuration
+  * @default true
+  */
+  defaultConfiguration?: boolean;
+  /**
+  * Check In-Document CSpell directives for correctness.
+  */
+  validateDirectives?: boolean;
+  /**
+  * Return an exit code if there are issues found.
+  * @default true
+  */
+  exitCode?: boolean;
+  /**
+  * Execution flags.
+  * Used primarily for releasing experimental features.
+  * Flags are of the form key:value
+  */
+  flag?: string[];
+  /**
+  * Use color in the output.
+  * `true` to force color, `false` to turn off color.
+  * `undefined` to use color if the output is a TTY.
+  */
+  color?: boolean | undefined;
+}
+interface LinterCliOptions extends LinterOptions {
+  /**
+  * Show legacy output
+  */
+  legacy?: boolean;
+  /**
+  * Show summary at the end
+  */
+  summary?: boolean;
+  /**
+  * Show issues
+  */
+  issues?: boolean;
+  /**
+  * Run in silent mode.
+  * @default false
+  */
+  silent?: boolean;
+  /**
+  * Show progress
+  */
+  progress?: boolean;
+  /**
+  * issues are shown with a relative path to the root or `cwd`
+  */
+  relative?: boolean;
+  /**
+  * Files must be found or cli will exit with an error.
+  */
+  mustFindFiles?: boolean;
+  /**
+  * Generate a summary report of issues.
+  */
+  issuesSummaryReport?: boolean;
+  /**
+  * Generate a summary report of performance.
+  */
+  showPerfSummary?: boolean;
+  /**
+  * Set the template to use when reporting issues.
+  *
+  * The template is a string that can contain the following placeholders:
+  * - `$filename` - the file name
+  * - `$col` - the column number
+  * - `$row` - the row number
+  * - `$text` - the word that is misspelled
+  * - `$message` - the issues message: "unknown word", "word is misspelled", etc.
+  * - `$messageColored` - the issues message with color based upon the message type.
+  * - `$uri` - the URI of the file
+  * - `$suggestions` - suggestions for the misspelled word (if requested)
+  * - `$quickFix` - possible quick fixes for the misspelled word.
+  * - `$contextFull` - the full context of the misspelled word.
+  * - `$contextLeft` - the context to the left of the misspelled word.
+  * - `$contextRight` - the context to the right of the misspelled word.
+  *
+  * Color is supported using the following template pattern:
+  * - `{<style[.style]> <text>}` - where `<style>` is a style name and `<text>` is the text to style.
+  *
+  * Styles
+  * - `bold`, `italic`, `underline`, `strikethrough`, `dim`, `inverse`
+  * - `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
+  *
+  * Example:
+  * @example "{green $filename}:{yellow $row}:{yellow $col} $message {red $text} $quickFix {dim $suggestions}"
+  * @since 8.12.0
+  */
+  issueTemplate?: string;
+  /**
+  * Prevents searching for local configuration files
+  *
+  * When `--no-config-search` is passed on the command line, this will be `true`.
+  * If the flag is not passed, it defaults to `false`.
+  */
+  configSearch?: boolean;
+  /**
+  * Directory paths at which CSpell should stop searching for configuration files.
+  *
+  * These are set via one or more `--stop-config-search-at <dir>` CLI options.
+  * If no flags are passed, this will be `undefined`.
+  */
+  stopConfigSearchAt?: string[];
+  report?: ReportChoices | undefined;
+}
+type ReportChoices = "all" | "simple" | "typos" | "flagged";
+interface CSpellConfigFile {
+  url: URL;
+  settings: CSpellSettings;
+}
+//#endregion
+export { BaseOptions, DictionariesOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions };
+//# sourceMappingURL=options-ChaXtdFn.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "9.1.2",
+  "version": "9.1.5",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -9,14 +9,14 @@
   },
   "type": "module",
   "sideEffects": false,
-  "types": "dist/esm/index.d.mts",
-  "module": "dist/esm/index.mjs",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.mjs"
+      "import": "./dist/esm/index.js"
     },
     "./app": {
-      "import": "./dist/esm/app.mjs"
+      "import": "./dist/esm/app.js"
     },
     "./bin": {
       "import": "./bin.mjs"
@@ -25,24 +25,26 @@
       "import": "./bin.mjs"
     },
     "./application": {
-      "import": "./dist/esm/application.mjs"
+      "import": "./dist/esm/application.js"
     }
   },
   "files": [
     "bin.mjs",
     "dist",
-    "!**/*.tsbuildInfo",
     "!**/__mocks__",
-    "!**/test/**",
-    "!**/*.test.*",
+    "!**/*.map",
+    "!**/*.perf.*",
     "!**/*.spec.*",
-    "!**/*.map"
+    "!**/*.test.*",
+    "!**/*.tsbuildInfo",
+    "!**/perf/**",
+    "!**/test/**",
+    "!dist/tsc"
   ],
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
-    "build": "tsc -p . && pnpm run build:api",
-    "build:api": "rollup -c rollup.config.mjs",
-    "build:esm": "tsc -p .",
+    "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",
@@ -81,20 +83,20 @@
   },
   "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "9.1.2",
-    "@cspell/cspell-pipe": "9.1.2",
-    "@cspell/cspell-types": "9.1.2",
-    "@cspell/dynamic-import": "9.1.2",
-    "@cspell/url": "9.1.2",
+    "@cspell/cspell-json-reporter": "9.1.5",
+    "@cspell/cspell-pipe": "9.1.5",
+    "@cspell/cspell-types": "9.1.5",
+    "@cspell/dynamic-import": "9.1.5",
+    "@cspell/url": "9.1.5",
     "chalk": "^5.4.1",
     "chalk-template": "^1.1.0",
     "commander": "^14.0.0",
-    "cspell-config-lib": "9.1.2",
-    "cspell-dictionary": "9.1.2",
-    "cspell-gitignore": "9.1.2",
-    "cspell-glob": "9.1.2",
-    "cspell-io": "9.1.2",
-    "cspell-lib": "9.1.2",
+    "cspell-config-lib": "9.1.5",
+    "cspell-dictionary": "9.1.5",
+    "cspell-gitignore": "9.1.5",
+    "cspell-glob": "9.1.5",
+    "cspell-io": "9.1.5",
+    "cspell-lib": "9.1.5",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^9.1.0",
     "semver": "^7.7.2",
@@ -111,5 +113,5 @@
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.5"
   },
-  "gitHead": "231a39f34c2c586ebb596ae7b2a832a996a80a1e"
+  "gitHead": "6303813cb5da37e88b3ccab7ce5bcf09373f5cf2"
 }

package/dist/esm/app.d.mts

@@ -1,5 +0,0 @@
-import type { Command } from 'commander';
-export { LinterCliOptions as Options } from './options.js';
-export { ApplicationError, CheckFailed } from './util/errors.js';
-export declare function run(command?: Command, argv?: string[]): Promise<void>;
-//# sourceMappingURL=app.d.mts.map