cspell 5.12.1 → 5.12.5

package/README.md

@@ -74,44 +74,59 @@ Usage: cspell lint [options] [files...]
 Check spelling
 
 Options:
-  -c, --config <cspell.json>  Configuration file to use.  By default cspell
-                              looks for cspell.json in the current directory.
-
-  -v, --verbose               display more information about the files being
-                              checked and the configuration
-
-  --locale <locale>           Set language locales. i.e. "en,fr" for English
-                              and French, or "en-GB" for British English.
-
-  --language-id <language>    Force programming language for unknown
-                              extensions. i.e. "php" or "scala"
-
-  --wordsOnly                 Only output the words not found in the
-                              dictionaries.
-
-  -u, --unique                Only output the first instance of a word not
-                              found in the dictionaries.
-
-  --debug                     Output information useful for debugging
-                              cspell.json files.
-
-  -e, --exclude <glob>        Exclude files matching the glob pattern. This
-                              option can be used multiple times to add multiple
-                              globs.
-
-  --no-issues                 Do not show the spelling errors.
-  --no-progress               Turn off progress messages
-  --no-summary                Turn off summary message in console
-  -s, --silent                Silent mode, suppress error messages
-  -r, --root <root folder>    Root directory, defaults to current directory.
-  --relative                  Issues are displayed relative to root.
-  --show-context              Show the surrounding text around an issue.
-  --show-suggestions          Show spelling suggestions.
-  --must-find-files           Error if no files are found (default: true)
-  --no-must-find-files        Do not error is no files are found
-  --no-color                  Turn off color.
-  --color                     Force color
-  -h, --help                  display help for command
+  -c, --config <cspell.json>   Configuration file to use.  By default cspell
+                               looks for cspell.json in the current directory.
+
+  -v, --verbose                display more information about the files being
+                               checked and the configuration
+
+  --locale <locale>            Set language locales. i.e. "en,fr" for English
+                               and French, or "en-GB" for British English.
+
+  --language-id <language>     Force programming language for unknown
+                               extensions. i.e. "php" or "scala"
+
+  --wordsOnly                  Only output the words not found in the
+                               dictionaries.
+
+  -u, --unique                 Only output the first instance of a word not
+                               found in the dictionaries.
+
+  --debug                      Output information useful for debugging
+                               cspell.json files.
+
+  -e, --exclude <glob>         Exclude files matching the glob pattern. This
+                               option can be used multiple times to add
+                               multiple globs.
+
+  --no-issues                  Do not show the spelling errors.
+  --no-progress                Turn off progress messages
+  --no-summary                 Turn off summary message in console
+  -s, --silent                 Silent mode, suppress error messages
+  -r, --root <root folder>     Root directory, defaults to current directory.
+  --relative                   Issues are displayed relative to root.
+  --show-context               Show the surrounding text around an issue.
+  --show-suggestions           Show spelling suggestions.
+  --no-must-find-files         Do not error if no files are found
+
+  --cache                      Only check changed files (default: false)
+  --cache-strategy <strategy>  Strategy to use for detecting changed files
+                               (choices: "metadata", "content")
+
+  --cache-location <path>      Path to the cache file or directory (default:
+                               ".cspellcache")
+
+  --gitignore                  Ignore files matching glob patterns found in
+                               .gitignore files.
+
+  --no-gitignore               Do NOT use .gitignore files.
+
+  --gitignore-root <path>      Prevent searching for .gitignore files past
+                               root.
+
+  --no-color                   Turn off color.
+  --color                      Force color
+  -h, --help                   display help for command
 
 
 Examples:

package/bin.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 'use strict';
 
 const app = require('./dist/app');

package/dist/application.js

@@ -36,10 +36,10 @@ function lint(files, options, emitters) {
 exports.lint = lint;
 async function trace(words, options) {
     const { local } = options;
-    const { languageId, locale = local } = options;
+    const { languageId, locale = local, allowCompoundWords, ignoreCase } = options;
     const configFile = await (0, fileHelper_1.readConfig)(options.config, undefined);
     const config = cspell.mergeSettings(cspell.getDefaultSettings(), cspell.getGlobalSettings(), configFile.config);
-    const results = await (0, cspell_lib_1.traceWords)(words, config, { languageId, locale });
+    const results = await (0, cspell_lib_1.traceWords)(words, config, { languageId, locale, ignoreCase, allowCompoundWords });
     return results;
 }
 exports.trace = trace;

package/dist/commandLint.js

@@ -51,7 +51,8 @@ function commandLint(prog) {
         .option('--locale <locale>', 'Set language locales. i.e. "en,fr" for English and French, or "en-GB" for British English.')
         .option('--language-id <language>', 'Force programming language for unknown extensions. i.e. "php" or "scala"')
         .addOption(new commander_1.Option('--languageId <language>', 'Force programming language for unknown extensions. i.e. "php" or "scala"').hideHelp())
-        .option('--wordsOnly', 'Only output the words not found in the dictionaries.')
+        .option('--words-only', 'Only output the words not found in the dictionaries.')
+        .addOption(new commander_1.Option('--wordsOnly', 'Only output the words not found in the dictionaries.').hideHelp())
         .option('-u, --unique', 'Only output the first instance of a word not found in the dictionaries.')
         .option('--debug', 'Output information useful for debugging cspell.json files.')
         .option('-e, --exclude <glob>', 'Exclude files matching the glob pattern. This option can be used multiple times to add multiple globs. ', collect)

package/dist/commandTrace.js

@@ -20,6 +20,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commandTrace = void 0;
+const commander_1 = require("commander");
 const App = __importStar(require("./application"));
 const traceEmitter_1 = require("./traceEmitter");
 const errors_1 = require("./util/errors");
@@ -30,7 +31,12 @@ function commandTrace(prog) {
   Search for words in the configuration and dictionaries.`)
         .option('-c, --config <cspell.json>', 'Configuration file to use.  By default cspell looks for cspell.json in the current directory.')
         .option('--locale <locale>', 'Set language locales. i.e. "en,fr" for English and French, or "en-GB" for British English.')
-        .option('--languageId <language>', 'Force programming language for unknown extensions. i.e. "php" or "scala"')
+        .option('--language-id <language>', 'Use programming language. i.e. "php" or "scala"')
+        .addOption(new commander_1.Option('--languageId <language>', 'Use programming language. i.e. "php" or "scala"').hideHelp())
+        .option('--allow-compound-words', 'Turn on allowCompoundWords')
+        .addOption(new commander_1.Option('--allowCompoundWords', 'Turn on allowCompoundWords').hideHelp())
+        .option('--no-allow-compound-words', 'Turn off allowCompoundWords')
+        .option('--no-ignore-case', 'Do not ignore case and accents when searching for words')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
         .arguments('<words...>')

package/dist/lint.js

@@ -174,7 +174,7 @@ async function runLint(cfg) {
         cspell.setLogger(getLoggerFromReporter(reporter));
         const useGitignore = (_b = (_a = cfg.options.gitignore) !== null && _a !== void 0 ? _a : configInfo.config.useGitignore) !== null && _b !== void 0 ? _b : false;
         const gitignoreRoots = (_c = cfg.options.gitignoreRoot) !== null && _c !== void 0 ? _c : configInfo.config.gitignoreRoot;
-        const gitIgnore = useGitignore ? generateGitIgnore(gitignoreRoots) : undefined;
+        const gitIgnore = useGitignore ? await generateGitIgnore(gitignoreRoots) : undefined;
         const cliGlobs = cfg.files;
         const allGlobs = cliGlobs.length ? cliGlobs : configInfo.config.files || [];
         const combinedGlobs = (0, glob_1.normalizeGlobsToRoot)(allGlobs, cfg.root, false);
@@ -240,7 +240,10 @@ Options:
     }
     function filterFiles(files, globMatcher) {
         const patterns = globMatcher.patterns;
-        const excludeInfo = patterns.map(extractGlobSource).map(({ glob, source }) => `Glob: ${glob} from ${source}`);
+        const excludeInfo = patterns
+            .map(extractGlobSource)
+            .map(({ glob, source }) => `Glob: ${glob} from ${source}`)
+            .filter(util.uniqueFn());
         reporter.info(`Exclusion Globs: \n    ${excludeInfo.join('\n    ')}\n`, cspell_types_1.MessageTypes.Info);
         const result = files.filter(util.uniqueFn()).filter((filename) => !isExcluded(filename, globMatcher));
         return result;
@@ -302,8 +305,13 @@ function getLoggerFromReporter(reporter) {
         error,
     };
 }
-function generateGitIgnore(roots) {
-    const root = typeof roots === 'string' ? [roots] : roots;
+async function generateGitIgnore(roots) {
+    const root = (typeof roots === 'string' ? [roots].filter((r) => !!r) : roots) || [];
+    if (!(root === null || root === void 0 ? void 0 : root.length)) {
+        const cwd = process.cwd();
+        const repo = (await (0, cspell_gitignore_1.findRepoRoot)(cwd)) || cwd;
+        root.push(repo);
+    }
     return new cspell_gitignore_1.GitIgnore(root === null || root === void 0 ? void 0 : root.map((p) => path.resolve(p)));
 }
 //# sourceMappingURL=lint.js.map

package/dist/options.d.ts

@@ -56,7 +56,10 @@ export interface CSpellApplicationOptions extends BaseOptions {
      */
     gitignoreRoot?: string | string[];
 }
-export declare type TraceOptions = BaseOptions;
+export interface TraceOptions extends BaseOptions {
+    allowCompoundWords?: boolean;
+    ignoreCase?: boolean;
+}
 export interface BaseOptions {
     config?: string;
     languageId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "5.12.1",
+  "version": "5.12.5",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -70,11 +70,11 @@
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
     "chalk": "^4.1.2",
-    "commander": "^8.2.0",
+    "commander": "^8.3.0",
     "comment-json": "^4.1.1",
-    "cspell-gitignore": "^5.12.1",
-    "cspell-glob": "^5.12.0",
-    "cspell-lib": "^5.12.1",
+    "cspell-gitignore": "^5.12.5",
+    "cspell-glob": "^5.12.4",
+    "cspell-lib": "^5.12.5",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.0.0",
@@ -88,18 +88,18 @@
     "node": ">=12.13.0"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^5.12.1",
-    "@cspell/cspell-types": "^5.12.1",
+    "@cspell/cspell-json-reporter": "^5.12.5",
+    "@cspell/cspell-types": "^5.12.4",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
-    "@types/glob": "^7.1.4",
+    "@types/glob": "^7.2.0",
     "@types/imurmurhash": "^0.1.1",
     "@types/micromatch": "^4.0.2",
     "@types/minimatch": "^3.0.5",
-    "jest": "^27.2.4",
+    "jest": "^27.3.1",
     "micromatch": "^4.0.4",
     "minimatch": "^3.0.4",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "43a626145377e1f760ad51fc58701313c7a26243"
+  "gitHead": "84a21d1f7cbd17cc9633aafdff6dce19d6de35b5"
 }