cspell 5.19.2 → 5.19.5

package/dist/app.js

@@ -1,31 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = exports.CheckFailed = void 0;
 const commander_1 = require("commander");
-const path = __importStar(require("path"));
 const semver_1 = require("semver");
 const commandCheck_1 = require("./commandCheck");
 const commandLink_1 = require("./commandLink");
@@ -34,7 +10,7 @@ const commandSuggestion_1 = require("./commandSuggestion");
 const commandTrace_1 = require("./commandTrace");
 const errors_1 = require("./util/errors");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const npmPackage = require(path.join(__dirname, '..', 'package.json'));
+const npmPackage = require('../package.json');
 var errors_2 = require("./util/errors");
 Object.defineProperty(exports, "CheckFailed", { enumerable: true, get: function () { return errors_2.CheckFailed; } });
 async function run(command, argv) {

package/dist/application.js

@@ -43,11 +43,13 @@ function lint(fileGlobs, options, emitters) {
 }
 exports.lint = lint;
 async function* trace(words, options) {
+    var _a, _b;
     options = (0, options_1.fixLegacy)(options);
     const iWords = options.stdin ? (0, cspell_pipe_1.toAsyncIterable)(words, (0, stdin_1.readStdin)()) : words;
     const { languageId, locale, allowCompoundWords, ignoreCase } = options;
     const configFile = await (0, fileHelper_1.readConfig)(options.config, undefined);
-    const config = (0, cspell_lib_1.mergeSettings)((0, cspell_lib_1.getDefaultSettings)(), (0, cspell_lib_1.getGlobalSettings)(), configFile.config);
+    const loadDefault = (_b = (_a = options.defaultConfiguration) !== null && _a !== void 0 ? _a : configFile.config.loadDefaultConfiguration) !== null && _b !== void 0 ? _b : true;
+    const config = (0, cspell_lib_1.mergeSettings)((0, cspell_lib_1.getDefaultSettings)(loadDefault), (0, cspell_lib_1.getGlobalSettings)(), configFile.config);
     yield* (0, cspell_lib_1.traceWordsAsync)(iWords, config, { languageId, locale, ignoreCase, allowCompoundWords });
 }
 exports.trace = trace;
@@ -58,6 +60,7 @@ async function checkText(filename, options) {
     const settingsFromCommandLine = util.clean({
         languageId: options.languageId || undefined,
         language: options.locale || options.local || undefined,
+        loadDefaultConfiguration: options.defaultConfiguration,
     });
     const info = (0, fileHelper_1.calcFinalConfigInfo)(foundSettings, settingsFromCommandLine, filename, text);
     return (0, cspell_lib_1.checkText)(text, info.configInfo.config);

package/dist/cli-reporter.js

@@ -82,17 +82,13 @@ function reportProgressFileBegin(p) {
     const fn = (' '.repeat(fc.length) + p.fileNum).slice(-fc.length);
     const idx = fn + '/' + fc;
     const filename = chalk.gray(relativeFilename(p.filename));
-    process.stderr.write(`\r${idx} ${filename} ...`);
+    process.stderr.write(`\r${idx} ${filename}`);
 }
 function reportProgressFileComplete(p) {
-    const fc = '' + p.fileCount;
-    const fn = (' '.repeat(fc.length) + p.fileNum).slice(-fc.length);
-    const idx = fn + '/' + fc;
-    const filename = chalk.gray(relativeFilename(p.filename));
     const time = reportTime(p.elapsedTimeMs, !!p.cached);
     const skipped = p.processed === false ? ' skipped' : '';
     const hasErrors = p.numErrors ? chalk.red ` X` : '';
-    console.error(`\r${idx} ${filename} ${time}${skipped}${hasErrors}`);
+    console.error(` ${time}${skipped}${hasErrors}`);
 }
 function reportTime(elapsedTimeMs, cached) {
     if (cached)

package/dist/commandCheck.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commandCheck = void 0;
+const commander_1 = require("commander");
 const App = __importStar(require("./application"));
 const application_1 = require("./application");
 const errors_1 = require("./util/errors");
@@ -35,6 +36,8 @@ function commandCheck(prog) {
         .option('-c, --config <cspell.json>', 'Configuration file to use.  By default cspell looks for cspell.json in the current directory.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
+        .addOption(new commander_1.Option('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
+        .addOption(new commander_1.Option('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .action(async (files, options) => {
         let issueCount = 0;
         for (const filename of files) {

package/dist/commandLint.js

@@ -92,6 +92,8 @@ function commandLint(prog) {
         .option('--gitignore-root <path>', 'Prevent searching for .gitignore files past root.', collect)
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color.')
+        .addOption(new commander_1.Option('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
+        .addOption(new commander_1.Option('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .option('--debug', 'Output information useful for debugging cspell.json files.')
         .addHelpText('after', usage)
         .arguments('[globs...]')

package/dist/commandTrace.js

@@ -43,6 +43,8 @@ function commandTrace(prog) {
         .option('--stdin', 'Read words from stdin.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
+        .addOption(new commander_1.Option('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
+        .addOption(new commander_1.Option('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .arguments('[words...]')
         .action(async (words, options) => {
         let numFound = 0;

package/dist/lint/lint.js

@@ -24,15 +24,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runLint = void 0;
+const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const cspell_types_1 = require("@cspell/cspell-types");
-const commentJson = __importStar(require("comment-json"));
 const cspell_gitignore_1 = require("cspell-gitignore");
 const cspell_glob_1 = require("cspell-glob");
 const cspell = __importStar(require("cspell-lib"));
 const path = __importStar(require("path"));
 const util_1 = require("util");
 const vscode_uri_1 = require("vscode-uri");
-const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const cache_1 = require("../util/cache");
 const errors_1 = require("../util/errors");
 const fileHelper_1 = require("../util/fileHelper");
@@ -41,6 +40,9 @@ const reporters_1 = require("../util/reporters");
 const timer_1 = require("../util/timer");
 const util = __importStar(require("../util/util"));
 const chalk = require("chalk");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const npmPackage = require('../../package.json');
+const version = npmPackage.version;
 async function runLint(cfg) {
     let { reporter } = cfg;
     cspell.setLogger(getLoggerFromReporter(reporter));
@@ -49,7 +51,7 @@ async function runLint(cfg) {
     await reporter.result(lintResult);
     return lintResult;
     async function processFile(filename, configInfo, cache) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         const getElapsedTimeMs = (0, timer_1.getTimeMeasurer)();
         const cachedResult = await cache.getCachedLintResults(filename);
         if (cachedResult) {
@@ -77,10 +79,9 @@ async function runLint(cfg) {
         }
         const doc = (0, fileHelper_1.fileInfoToDocument)(fileInfo, cfg.options.languageId, cfg.locale);
         const { text } = fileInfo;
-        reporter.debug(`Filename: ${filename}, LanguageIds: ${(_a = doc.languageId) !== null && _a !== void 0 ? _a : 'default'}`);
         result.fileInfo = fileInfo;
         let spellResult = {};
-        reporter.info(`Checking: ${filename}, File type: ${(_b = doc.languageId) !== null && _b !== void 0 ? _b : 'auto'}, Language: ${(_c = doc.locale) !== null && _c !== void 0 ? _c : 'default'}`, cspell_types_1.MessageTypes.Info);
+        reporter.info(`Checking: ${filename}, File type: ${(_a = doc.languageId) !== null && _a !== void 0 ? _a : 'auto'}, Language: ${(_b = doc.locale) !== null && _b !== void 0 ? _b : 'default'}`, cspell_types_1.MessageTypes.Info);
         try {
             const validateOptions = { generateSuggestions: cfg.options.showSuggestions, numSuggestions: 5 };
             const r = await cspell.spellCheckDocument(doc, validateOptions, configInfo.config);
@@ -93,15 +94,23 @@ async function runLint(cfg) {
             result.errors += 1;
         }
         result.elapsedTimeMs = getElapsedTimeMs();
-        const config = (_d = spellResult.settingsUsed) !== null && _d !== void 0 ? _d : {};
+        const config = (_c = spellResult.settingsUsed) !== null && _c !== void 0 ? _c : {};
         result.configErrors += await reportConfigurationErrors(config);
-        const debugCfg = { config: { ...config, source: null }, source: spellResult.localConfigFilepath };
-        reporter.debug(commentJson.stringify(debugCfg, undefined, 2));
         const elapsed = result.elapsedTimeMs / 1000.0;
         const dictionaries = config.dictionaries || [];
         reporter.info(`Checked: ${filename}, File type: ${config.languageId}, Language: ${config.language} ... Issues: ${result.issues.length} ${elapsed}S`, cspell_types_1.MessageTypes.Info);
         reporter.info(`Config file Used: ${spellResult.localConfigFilepath || configInfo.source}`, cspell_types_1.MessageTypes.Info);
         reporter.info(`Dictionaries Used: ${dictionaries.join(', ')}`, cspell_types_1.MessageTypes.Info);
+        if (cfg.options.debug) {
+            const { id: _id, name: _name, __imports, __importRef, ...cfg } = config;
+            const debugCfg = {
+                filename,
+                languageId: (_e = (_d = doc.languageId) !== null && _d !== void 0 ? _d : cfg.languageId) !== null && _e !== void 0 ? _e : 'default',
+                config: { ...cfg, source: null },
+                source: spellResult.localConfigFilepath,
+            };
+            reporter.debug(JSON.stringify(debugCfg, undefined, 2));
+        }
         const dep = calcDependencies(config);
         cache.setCachedLintResults(result, dep.files);
         return result;
@@ -202,6 +211,9 @@ async function runLint(cfg) {
             process.env[cspell.ENV_CSPELL_GLOB_ROOT] = cfg.root;
         }
         const configInfo = await (0, fileHelper_1.readConfig)(cfg.configFile, cfg.root);
+        if (cfg.options.defaultConfiguration !== undefined) {
+            configInfo.config.loadDefaultConfiguration = cfg.options.defaultConfiguration;
+        }
         reporter = (0, reporters_1.mergeReporters)(cfg.reporter, ...(0, reporters_1.loadReporters)(configInfo.config));
         cspell.setLogger(getLoggerFromReporter(reporter));
         const globInfo = await determineGlobs(configInfo, cfg);
@@ -220,7 +232,7 @@ async function runLint(cfg) {
         // Get Exclusions from the config files.
         const { root } = cfg;
         try {
-            const cacheSettings = await (0, cache_1.calcCacheSettings)(configInfo.config, cfg.options, root);
+            const cacheSettings = await (0, cache_1.calcCacheSettings)(configInfo.config, { ...cfg.options, version }, root);
             const files = await determineFilesToCheck(configInfo, cfg, reporter, globInfo);
             return await processFiles(files, configInfo, cacheSettings);
         }

package/dist/options.d.ts

@@ -1,5 +1,5 @@
 import type { CacheOptions } from './util/cache';
-export interface LinterOptions extends BaseOptions, CacheOptions {
+export interface LinterOptions extends BaseOptions, Omit<CacheOptions, 'version'> {
     /**
      * Display verbose information
      */
@@ -119,6 +119,11 @@ export interface BaseOptions {
      * Locale to use.
      */
     locale?: string;
+    /**
+     * Load the default configuration
+     * @default true
+     */
+    defaultConfiguration?: boolean;
 }
 export interface LinterCliOptions extends Omit<LinterOptions, 'fileLists'> {
     legacy?: boolean;

package/dist/util/cache/CacheOptions.d.ts

@@ -1,5 +1,10 @@
 import type { CacheStrategy } from '@cspell/cspell-types';
 export 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.
      */

package/dist/util/cache/DiskCache.d.ts

@@ -11,6 +11,8 @@ interface CachedData {
     r: CachedFileResult;
     /** dependencies */
     d: string[];
+    /** meta version */
+    v: string;
 }
 interface CSpellCachedMetaData {
     data?: CachedData;
@@ -20,10 +22,11 @@ export declare type CSpellCacheMeta = (FileDescriptor['meta'] & CSpellCachedMeta
  * Caches cspell results on disk
  */
 export declare class DiskCache implements CSpellLintResultCache {
+    readonly version: string;
     private fileEntryCache;
     private changedDependencies;
     private knownDependencies;
-    constructor(cacheFileLocation: string, useCheckSum: boolean);
+    constructor(cacheFileLocation: string, useCheckSum: boolean, version: string);
     getCachedLintResults(filename: string): Promise<FileResult | undefined>;
     setCachedLintResults({ fileInfo, elapsedTimeMs: _, ...result }: FileResult, dependsUponFiles: string[]): void;
     reconcile(): void;

package/dist/util/cache/DiskCache.js

@@ -31,7 +31,8 @@ const fileHelper_1 = require("../../util/fileHelper");
  * Caches cspell results on disk
  */
 class DiskCache {
-    constructor(cacheFileLocation, useCheckSum) {
+    constructor(cacheFileLocation, useCheckSum, version) {
+        this.version = version;
         this.changedDependencies = new Set();
         this.knownDependencies = new Set();
         this.fileEntryCache = fileEntryCache.createFromFile((0, path_1.resolve)(cacheFileLocation), useCheckSum);
@@ -41,12 +42,18 @@ class DiskCache {
         const meta = fileDescriptor.meta;
         const data = meta === null || meta === void 0 ? void 0 : meta.data;
         const result = data === null || data === void 0 ? void 0 : data.r;
+        const versionMatches = this.version === (data === null || data === void 0 ? void 0 : data.v);
         // Cached lint results are valid if and only if:
         // 1. The file is present in the filesystem
         // 2. The file has not changed since the time it was previously linted
         // 3. The CSpell configuration has not changed since the time the file was previously linted
         // If any of these are not true, we will not reuse the lint results.
-        if (fileDescriptor.notFound || fileDescriptor.changed || !meta || !result || !this.checkDependencies(data.d)) {
+        if (fileDescriptor.notFound ||
+            fileDescriptor.changed ||
+            !meta ||
+            !result ||
+            !versionMatches ||
+            !this.checkDependencies(data.d)) {
             return undefined;
         }
         // Skip reading empty files and files without lint error
@@ -69,6 +76,7 @@ class DiskCache {
         const data = {
             r: result,
             d: dependsUponFiles,
+            v: this.version,
         };
         meta.data = data;
         this.cacheDependencies(dependsUponFiles);

package/dist/util/cache/createCache.d.ts

@@ -2,10 +2,25 @@ import { CacheSettings, CSpellSettings } from '@cspell/cspell-types';
 import { CacheOptions } from '.';
 import { CSpellLintResultCache } from './CSpellLintResultCache';
 export declare const DEFAULT_CACHE_LOCATION = ".cspellcache";
-export declare type CreateCacheSettings = Required<CacheSettings>;
+export interface CreateCacheSettings extends Required<CacheSettings> {
+    /**
+     * cspell version used to validate cache entries.
+     */
+    version: string;
+}
 /**
  * Creates CSpellLintResultCache (disk cache if caching is enabled in config or dummy otherwise)
  */
 export declare function createCache(options: CreateCacheSettings): CSpellLintResultCache;
 export declare function calcCacheSettings(config: CSpellSettings, cacheOptions: CacheOptions, root: string): Promise<CreateCacheSettings>;
+/**
+ * Normalizes the version and return only `major.minor + versionSuffix`
+ * @param version The cspell semantic version.
+ */
+declare function normalizeVersion(version: string): string;
+export declare const __testing__: {
+    normalizeVersion: typeof normalizeVersion;
+    versionSuffix: string;
+};
+export {};
 //# sourceMappingURL=createCache.d.ts.map

package/dist/util/cache/createCache.js

@@ -3,20 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcCacheSettings = exports.createCache = exports.DEFAULT_CACHE_LOCATION = void 0;
+exports.__testing__ = exports.calcCacheSettings = exports.createCache = exports.DEFAULT_CACHE_LOCATION = void 0;
+const assert_1 = __importDefault(require("assert"));
+const fs_extra_1 = require("fs-extra");
 const path_1 = __importDefault(require("path"));
+const errors_1 = require("../errors");
 const DiskCache_1 = require("./DiskCache");
 const DummyCache_1 = require("./DummyCache");
-const fs_extra_1 = require("fs-extra");
-const errors_1 = require("../errors");
 // cspell:word cspellcache
 exports.DEFAULT_CACHE_LOCATION = '.cspellcache';
+const versionSuffix = '';
 /**
  * Creates CSpellLintResultCache (disk cache if caching is enabled in config or dummy otherwise)
  */
 function createCache(options) {
     const { useCache, cacheLocation, cacheStrategy } = options;
-    return useCache ? new DiskCache_1.DiskCache(path_1.default.resolve(cacheLocation), cacheStrategy === 'content') : new DummyCache_1.DummyCache();
+    return useCache
+        ? new DiskCache_1.DiskCache(path_1.default.resolve(cacheLocation), cacheStrategy === 'content', normalizeVersion(options.version))
+        : new DummyCache_1.DummyCache();
 }
 exports.createCache = createCache;
 async function calcCacheSettings(config, cacheOptions, root) {
@@ -29,6 +33,7 @@ async function calcCacheSettings(config, cacheOptions, root) {
         useCache,
         cacheLocation,
         cacheStrategy,
+        version: cacheOptions.version,
     };
 }
 exports.calcCacheSettings = calcCacheSettings;
@@ -46,4 +51,17 @@ async function resolveCacheLocation(cacheLocation) {
         throw err;
     }
 }
+/**
+ * Normalizes the version and return only `major.minor + versionSuffix`
+ * @param version The cspell semantic version.
+ */
+function normalizeVersion(version) {
+    const parts = version.split('.').slice(0, 2);
+    (0, assert_1.default)(parts.length === 2);
+    return parts.join('.') + versionSuffix;
+}
+exports.__testing__ = {
+    normalizeVersion,
+    versionSuffix,
+};
 //# sourceMappingURL=createCache.js.map

package/dist/util/fileHelper.js

@@ -92,9 +92,11 @@ async function findFiles(globPatterns, options) {
 }
 exports.findFiles = findFiles;
 function calcFinalConfigInfo(configInfo, settingsFromCommandLine, filename, text) {
+    var _a, _b, _c;
     const ext = path.extname(filename);
     const fileSettings = cspell.calcOverrideSettings(configInfo.config, path.resolve(filename));
-    const settings = cspell.mergeSettings(cspell.getDefaultSettings(), cspell.getGlobalSettings(), fileSettings, settingsFromCommandLine);
+    const loadDefault = (_c = (_b = (_a = settingsFromCommandLine.loadDefaultConfiguration) !== null && _a !== void 0 ? _a : configInfo.config.loadDefaultConfiguration) !== null && _b !== void 0 ? _b : fileSettings.loadDefaultConfiguration) !== null && _c !== void 0 ? _c : true;
+    const settings = cspell.mergeSettings(cspell.getDefaultSettings(loadDefault), cspell.getGlobalSettings(), fileSettings, settingsFromCommandLine);
     const languageIds = settings.languageId ? [settings.languageId] : cspell.getLanguagesForExt(ext);
     const config = cspell.constructSettingsForText(settings, text, languageIds);
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "5.19.2",
+  "version": "5.19.5",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -70,13 +70,12 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "^5.19.2",
+    "@cspell/cspell-pipe": "^5.19.5",
     "chalk": "^4.1.2",
-    "commander": "^9.0.0",
-    "comment-json": "^4.2.2",
-    "cspell-gitignore": "^5.19.2",
-    "cspell-glob": "^5.19.2",
-    "cspell-lib": "^5.19.2",
+    "commander": "^9.1.0",
+    "cspell-gitignore": "^5.19.5",
+    "cspell-glob": "^5.19.5",
+    "cspell-lib": "^5.19.5",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.0.1",
@@ -91,8 +90,8 @@
     "node": ">=12.13.0"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^5.19.2",
-    "@cspell/cspell-types": "^5.19.2",
+    "@cspell/cspell-json-reporter": "^5.19.5",
+    "@cspell/cspell-types": "^5.19.5",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
@@ -101,11 +100,11 @@
     "@types/minimatch": "^3.0.5",
     "@types/semver": "^7.3.9",
     "jest": "^27.5.1",
-    "micromatch": "^4.0.4",
+    "micromatch": "^4.0.5",
     "minimatch": "^5.0.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.70.0",
+    "rollup": "^2.70.1",
     "rollup-plugin-dts": "^4.2.0"
   },
-  "gitHead": "6540cb9f716993c554dc50dd54dd76d553f8f5e4"
+  "gitHead": "0d113f01b51c3bc149a01269878d4217a58ecb97"
 }