cspell 8.15.7 → 8.16.1

package/README.md

@@ -170,7 +170,8 @@ Options:
   --no-cache                   Do not use cache.
   --cache-reset                Reset the cache file.
   --cache-strategy <strategy>  Strategy to use for detecting changed files.
-                               (choices: "metadata", "content")
+                               (choices: "content", "metadata", default:
+                               "content")
   --cache-location <path>      Path to the cache file or directory. (default:
                                ".cspellcache")
   --dot                        Include files and directories starting with `.`
@@ -181,8 +182,8 @@ Options:
   --gitignore-root <path>      Prevent searching for .gitignore files past
                                root.
   --validate-directives        Validate in-document CSpell directives.
-  --no-color                   Turn off color.
   --color                      Force color.
+  --no-color                   Turn off color.
   --no-default-configuration   Do not load the default configuration and
                                dictionaries.
   --debug                      Output information useful for debugging
@@ -272,8 +273,8 @@ Options:
   --stdin                     Read words from stdin.
   --all                       Show all dictionaries.
   --only-found                Show only dictionaries that have the words.
+  --color                     Force color.
   --no-color                  Turn off color.
-  --color                     Force color
   --no-default-configuration  Do not load the default configuration and
                               dictionaries.
   -h, --help                  display help for command

package/dist/esm/cli-reporter.d.ts

@@ -25,7 +25,7 @@ export interface ReporterIssue extends Issue {
 interface IOChalk {
     readonly chalk: ChalkInstance;
 }
-export interface ReporterOptions extends Pick<LinterCliOptions, 'debug' | 'issues' | 'issuesSummaryReport' | 'legacy' | 'progress' | 'relative' | 'root' | 'showContext' | 'showPerfSummary' | 'showSuggestions' | 'silent' | 'summary' | 'verbose' | 'wordsOnly'> {
+export interface ReporterOptions extends Pick<LinterCliOptions, 'color' | 'debug' | 'issues' | 'issuesSummaryReport' | 'legacy' | 'progress' | 'relative' | 'root' | 'showContext' | 'showPerfSummary' | 'showSuggestions' | 'silent' | 'summary' | 'verbose' | 'wordsOnly'> {
     fileGlobs: string[];
 }
 export declare function getReporter(options: ReporterOptions, config?: CSpellReporterConfiguration): FinalizedReporter;

package/dist/esm/cli-reporter.js

@@ -107,6 +107,8 @@ export function getReporter(options, config) {
         elapsedTimeMs: 0,
         perf: Object.create(null),
     };
+    const noColor = options.color === false;
+    const forceColor = options.color === true;
     const uniqueIssues = config?.unique || false;
     const defaultIssueTemplate = options.wordsOnly
         ? templateIssueWordsOnly
@@ -125,13 +127,14 @@ export function getReporter(options, config) {
     const issueTemplate = config?.issueTemplate || defaultIssueTemplate;
     assertCheckTemplate(issueTemplate);
     const console = config?.console || customConsole;
+    const colorLevel = noColor ? 0 : forceColor ? 2 : console.stdoutChannel.getColorLevel();
     const stdio = {
         ...console.stdoutChannel,
-        chalk: new Chalk({ level: console.stdoutChannel.getColorLevel() }),
+        chalk: new Chalk({ level: colorLevel }),
     };
     const stderr = {
         ...console.stderrChannel,
-        chalk: new Chalk({ level: console.stderrChannel.getColorLevel() }),
+        chalk: new Chalk({ level: colorLevel }),
     };
     const consoleError = (msg) => stderr.writeLine(msg);
     function createInfoLog(wrap) {

package/dist/esm/commandLint.js

@@ -1,6 +1,7 @@
 import { Option as CommanderOption } from 'commander';
 import * as App from './application.mjs';
 import { DEFAULT_CACHE_LOCATION } from './util/cache/index.js';
+import { canUseColor } from './util/canUseColor.js';
 import { CheckFailed } from './util/errors.js';
 import { unindent } from './util/unindent.js';
 // interface InitOptions extends Options {}
@@ -105,10 +106,9 @@ export function commandLint(prog) {
         .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([
-        'metadata',
-        'content',
-    ]))
+        .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.')
@@ -116,8 +116,8 @@ export function commandLint(prog) {
         .option('--gitignore-root <path>', 'Prevent searching for .gitignore files past root.', collect)
         .option('--validate-directives', 'Validate in-document CSpell directives.')
         .addOption(crOpt('--no-validate-directives', 'Do not validate in-document CSpell directives.').hideHelp())
-        .option('--no-color', 'Turn off color.')
-        .option('--color', 'Force color.')
+        .addOption(crOpt('--color', 'Force color.').default(undefined))
+        .addOption(crOpt('--no-color', 'Turn off color.').default(undefined))
         .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('--debug', 'Output information useful for debugging cspell.json files.')
@@ -141,6 +141,7 @@ export function commandLint(prog) {
         if (options.skipValidation) {
             options.cache = false;
         }
+        options.color ??= canUseColor(options.color);
         App.parseApplicationFeatureFlags(options.flag);
         const { mustFindFiles, fileList, files, file } = options;
         const result = await App.lint(fileGlobs, options);

package/dist/esm/commandTrace.js

@@ -3,6 +3,7 @@ import * as App from './application.mjs';
 import { console } from './console.js';
 import { isDictionaryPathFormat } from './emitters/DictionaryPathFormat.js';
 import { emitTraceResults } from './emitters/traceEmitter.js';
+import { canUseColor } from './util/canUseColor.js';
 import { CheckFailed } from './util/errors.js';
 export function commandTrace(prog) {
     return prog
@@ -23,8 +24,8 @@ export function commandTrace(prog) {
         .option('--stdin', 'Read words from stdin.')
         .option('--all', 'Show all dictionaries.')
         .addOption(new CommanderOption('--only-found', 'Show only dictionaries that have the words.').conflicts('all'))
-        .option('--no-color', 'Turn off color.')
-        .option('--color', 'Force color')
+        .addOption(new CommanderOption('--color', 'Force color.').default(undefined))
+        .addOption(new CommanderOption('--no-color', 'Turn off color.').default(undefined))
         .addOption(new CommanderOption('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
         .addOption(new CommanderOption('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .arguments('[words...]')
@@ -35,6 +36,7 @@ export function commandTrace(prog) {
             ? options.dictionaryPath
             : 'long';
         let prefix = '';
+        const useColor = canUseColor(options.color);
         for await (const results of App.trace(words, options)) {
             const byWord = groupBy(results, (r) => r.word);
             for (const split of results.splits) {
@@ -45,6 +47,7 @@ export function commandTrace(prog) {
                     dictionaryPathFormat,
                     prefix,
                     showWordFound: results.splits.length > 1,
+                    color: useColor,
                 });
                 prefix = '\n';
                 numFound += results.reduce((n, r) => n + (r.found ? 1 : 0), 0);

package/dist/esm/emitters/traceEmitter.d.ts

@@ -13,6 +13,7 @@ export interface EmitTraceOptions {
     iPath?: PathInterface;
     prefix?: string;
     showWordFound?: boolean;
+    color?: boolean | undefined;
 }
 export declare function emitTraceResults(word: string, found: boolean, results: TraceResult[], options: EmitTraceOptions): void;
 export declare function calcTraceResultsReport(word: string, found: boolean, results: TraceResult[], options: EmitTraceOptions): {

package/dist/esm/emitters/traceEmitter.js

@@ -13,6 +13,12 @@ export function emitTraceResults(word, found, results, options) {
     }
 }
 export function calcTraceResultsReport(word, found, results, options) {
+    if (options.color === true) {
+        chalk.level = 2;
+    }
+    else if (options.color === false) {
+        chalk.level = 0;
+    }
     const col = new Intl.Collator();
     results.sort((a, b) => col.compare(a.dictName, b.dictName));
     options.showWordFound && console.log(`${options.prefix || ''}${word}: ${found ? 'Found' : 'Not Found'}`);

package/dist/esm/options.d.ts

@@ -173,6 +173,12 @@ export interface BaseOptions {
      * 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;
 }
 export interface LinterCliOptions extends LinterOptions {
     /**

package/dist/esm/pkgInfo.d.ts

@@ -1,6 +1,6 @@
 export { pkgDir } from './dirname.js';
 export declare const name = "cspell";
-export declare const version = "8.15.7";
+export declare const version = "8.16.1";
 export declare const engines: {
     node: string;
 };

package/dist/esm/pkgInfo.js

@@ -1,7 +1,7 @@
 // This file is generated by tools/patch-version.mjs
 export { pkgDir } from './dirname.js';
 export const name = 'cspell';
-export const version = '8.15.7';
+export const version = '8.16.1';
 export const engines = { node: '>=18' };
 export const npmPackage = { name, version, engines };
 //# sourceMappingURL=pkgInfo.js.map

package/dist/esm/util/cache/createCache.js

@@ -24,7 +24,7 @@ export async function calcCacheSettings(config, cacheOptions, root) {
     const cs = config.cache ?? {};
     const useCache = cacheOptions.cache ?? cs.useCache ?? false;
     const cacheLocation = await resolveCacheLocation(path.resolve(root, cacheOptions.cacheLocation ?? cs.cacheLocation ?? DEFAULT_CACHE_LOCATION));
-    const cacheStrategy = cacheOptions.cacheStrategy ?? cs.cacheStrategy ?? 'metadata';
+    const cacheStrategy = cacheOptions.cacheStrategy ?? cs.cacheStrategy ?? 'content';
     const cacheFormat = cacheOptions.cacheFormat ?? cs.cacheFormat ?? 'universal';
     const optionals = {};
     if (cacheOptions.cacheReset) {

package/dist/esm/util/canUseColor.d.ts

@@ -0,0 +1,2 @@
+export declare function canUseColor(colorOption: boolean | undefined): boolean | undefined;
+//# sourceMappingURL=canUseColor.d.ts.map

package/dist/esm/util/canUseColor.js

@@ -0,0 +1,10 @@
+export function canUseColor(colorOption) {
+    if (colorOption !== undefined)
+        return colorOption;
+    if (!('NO_COLOR' in process.env))
+        return undefined;
+    if (!process.env['NO_COLOR'] || process.env['NO_COLOR'] === 'false')
+        return undefined;
+    return false;
+}
+//# sourceMappingURL=canUseColor.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "8.15.7",
+  "version": "8.16.1",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -81,19 +81,19 @@
   },
   "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "8.15.7",
-    "@cspell/cspell-pipe": "8.15.7",
-    "@cspell/cspell-types": "8.15.7",
-    "@cspell/dynamic-import": "8.15.7",
-    "@cspell/url": "8.15.7",
+    "@cspell/cspell-json-reporter": "8.16.1",
+    "@cspell/cspell-pipe": "8.16.1",
+    "@cspell/cspell-types": "8.16.1",
+    "@cspell/dynamic-import": "8.16.1",
+    "@cspell/url": "8.16.1",
     "chalk": "^5.3.0",
     "chalk-template": "^1.1.0",
     "commander": "^12.1.0",
-    "cspell-dictionary": "8.15.7",
-    "cspell-gitignore": "8.15.7",
-    "cspell-glob": "8.15.7",
-    "cspell-io": "8.15.7",
-    "cspell-lib": "8.15.7",
+    "cspell-dictionary": "8.16.1",
+    "cspell-gitignore": "8.16.1",
+    "cspell-glob": "8.16.1",
+    "cspell-io": "8.16.1",
+    "cspell-lib": "8.16.1",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^9.1.0",
     "get-stdin": "^9.0.0",
@@ -111,5 +111,5 @@
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.5"
   },
-  "gitHead": "9decdc45e8fd0d6bb9c3851813c2c0728d3c7c5e"
+  "gitHead": "773bb6e701ff0b7fbeb30e4621119bb4315415ad"
 }