cspell 6.10.1 → 6.11.1

package/dist/app.d.ts

@@ -1,4 +1,4 @@
-import type { Command } from 'commander';
+import { Command } from 'commander';
 export { LinterCliOptions as Options } from './options';
 export { CheckFailed } from './util/errors';
 export declare function run(command?: Command, argv?: string[]): Promise<void>;

package/dist/app.js

@@ -21,11 +21,14 @@ async function run(command, argv) {
     if (!(0, semver_1.satisfies)(process.versions.node, npmPackage.engines.node)) {
         throw new errors_1.ApplicationError(`Unsupported NodeJS version (${process.versions.node}); ${npmPackage.engines.node} is required`);
     }
-    (0, commandLint_1.commandLint)(prog);
-    (0, commandTrace_1.commandTrace)(prog);
-    (0, commandCheck_1.commandCheck)(prog);
+    const optionFlags = new commander_1.Option('-f,--flag <flag:value>', 'Declare an execution flag value')
+        .hideHelp()
+        .argParser((value, prev) => prev?.concat(value) || [value]);
+    (0, commandLint_1.commandLint)(prog).addOption(optionFlags);
+    (0, commandTrace_1.commandTrace)(prog).addOption(optionFlags);
+    (0, commandCheck_1.commandCheck)(prog).addOption(optionFlags);
+    (0, commandSuggestion_1.commandSuggestion)(prog).addOption(optionFlags);
     (0, commandLink_1.commandLink)(prog);
-    (0, commandSuggestion_1.commandSuggestion)(prog);
     /*
         program
             .command('init')

package/dist/application.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
-import { CheckTextInfo, TraceResult } from 'cspell-lib';
+import { CheckTextInfo, FeatureFlags, TraceResult } from 'cspell-lib';
 import { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter';
 import { BaseOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from './options';
 export { IncludeExcludeFlag } from 'cspell-lib';
@@ -12,4 +12,5 @@ export declare type CheckTextResult = CheckTextInfo;
 export declare function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult>;
 export declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<TimedSuggestionsForWordResult>;
 export declare function createInit(): Promise<void>;
+export declare function parseApplicationFeatureFlags(flags: string[] | undefined): FeatureFlags;
 //# sourceMappingURL=application.d.ts.map

package/dist/application.js

@@ -23,10 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createInit = exports.suggestions = exports.checkText = exports.trace = exports.lint = exports.IncludeExcludeFlag = void 0;
+exports.parseApplicationFeatureFlags = exports.createInit = exports.suggestions = exports.checkText = exports.trace = exports.lint = exports.IncludeExcludeFlag = void 0;
 const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const cspell_lib_1 = require("cspell-lib");
 const cli_reporter_1 = require("./cli-reporter");
+const featureFlags_1 = require("./featureFlags");
 const lint_1 = require("./lint");
 const options_1 = require("./options");
 const repl_1 = require("./repl");
@@ -105,4 +106,15 @@ function createInit() {
     return Promise.reject();
 }
 exports.createInit = createInit;
+function registerApplicationFeatureFlags() {
+    const ff = (0, featureFlags_1.getFeatureFlags)();
+    const flags = [{ name: 'timer', description: 'Display elapsed time for command.' }];
+    flags.forEach((flag) => ff.register(flag));
+    return ff;
+}
+function parseApplicationFeatureFlags(flags) {
+    const ff = registerApplicationFeatureFlags();
+    return (0, featureFlags_1.parseFeatureFlags)(flags, ff);
+}
+exports.parseApplicationFeatureFlags = parseApplicationFeatureFlags;
 //# sourceMappingURL=application.js.map

package/dist/commandCheck.js

@@ -41,6 +41,7 @@ function commandCheck(prog) {
         .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) => {
+        App.parseApplicationFeatureFlags(options.flag);
         let issueCount = 0;
         for (const filename of files) {
             console.log(chalk.yellowBright(`Check file: ${filename}`));

package/dist/commandLint.js

@@ -100,6 +100,7 @@ function commandLint(prog) {
         .addHelpText('after', usage)
         .arguments('[globs...]')
         .action((fileGlobs, options) => {
+        App.parseApplicationFeatureFlags(options.flag);
         const { mustFindFiles, fileList } = options;
         return App.lint(fileGlobs, options).then((result) => {
             if (!fileGlobs.length && !result.files && !result.errors && !fileList) {

package/dist/commandSuggestion.js

@@ -64,6 +64,7 @@ function commandSuggestion(prog) {
         .option('--color', 'Force color')
         .arguments('[words...]')
         .action(async (words, options) => {
+        App.parseApplicationFeatureFlags(options.flag);
         options.useStdin = options.stdin;
         options.dictionaries = mergeArrays(options.dictionaries, options.dictionary);
         if (!words.length && !options.useStdin && !options.repl) {

package/dist/commandTrace.js

@@ -47,6 +47,7 @@ function commandTrace(prog) {
         .addOption(new commander_1.Option('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .arguments('[words...]')
         .action(async (words, options) => {
+        App.parseApplicationFeatureFlags(options.flag);
         let numFound = 0;
         for await (const results of App.trace(words, options)) {
             (0, traceEmitter_1.emitTraceResults)(results, { cwd: process.cwd() });

package/dist/featureFlags/featureFlags.d.ts

@@ -0,0 +1,4 @@
+import { FeatureFlags } from 'cspell-lib';
+export declare function getFeatureFlags(): FeatureFlags;
+export declare function parseFeatureFlags(flags: string[] | undefined, featureFlags?: FeatureFlags): FeatureFlags;
+//# sourceMappingURL=featureFlags.d.ts.map

package/dist/featureFlags/featureFlags.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFeatureFlags = exports.getFeatureFlags = void 0;
+const cspell_lib_1 = require("cspell-lib");
+function getFeatureFlags() {
+    return (0, cspell_lib_1.getSystemFeatureFlags)();
+}
+exports.getFeatureFlags = getFeatureFlags;
+function parseFeatureFlags(flags, featureFlags = getFeatureFlags()) {
+    if (!flags)
+        return featureFlags;
+    const flagsKvP = flags.map((f) => f.split(':', 2));
+    for (const flag of flagsKvP) {
+        const [name, value] = flag;
+        try {
+            featureFlags.setFlag(name, value);
+        }
+        catch (e) {
+            console.warn(`Unknown flag: "${name}"`);
+        }
+    }
+    return featureFlags;
+}
+exports.parseFeatureFlags = parseFeatureFlags;
+//# sourceMappingURL=featureFlags.js.map

package/dist/featureFlags/index.d.ts

@@ -0,0 +1,2 @@
+export { getFeatureFlags, parseFeatureFlags } from './featureFlags';
+//# sourceMappingURL=index.d.ts.map

package/dist/featureFlags/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFeatureFlags = exports.getFeatureFlags = void 0;
+var featureFlags_1 = require("./featureFlags");
+Object.defineProperty(exports, "getFeatureFlags", { enumerable: true, get: function () { return featureFlags_1.getFeatureFlags; } });
+Object.defineProperty(exports, "parseFeatureFlags", { enumerable: true, get: function () { return featureFlags_1.parseFeatureFlags; } });
+//# sourceMappingURL=index.js.map

package/dist/lint/lint.js

@@ -40,6 +40,7 @@ const reporters_1 = require("../util/reporters");
 const timer_1 = require("../util/timer");
 const util = __importStar(require("../util/util"));
 const chalk = require("chalk");
+const featureFlags_1 = require("../featureFlags");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const npmPackage = require('../../package.json');
 const version = npmPackage.version;
@@ -48,8 +49,13 @@ async function runLint(cfg) {
     let { reporter } = cfg;
     cspell.setLogger(getLoggerFromReporter(reporter));
     const configErrors = new Set();
+    const timer = (0, timer_1.getTimeMeasurer)();
     const lintResult = await run();
     await reporter.result(lintResult);
+    const elapsed = timer();
+    if ((0, featureFlags_1.getFeatureFlags)().getFlag('timer')) {
+        console.log(`Elapsed Time: ${elapsed.toFixed(2)}ms`);
+    }
     return lintResult;
     async function processFile(filename, configInfo, cache) {
         const getElapsedTimeMs = (0, timer_1.getTimeMeasurer)();

package/dist/options.d.ts

@@ -128,6 +128,12 @@ export interface BaseOptions {
      * Check In-Document CSpell directives for correctness.
      */
     validateDirectives?: boolean;
+    /**
+     * Execution flags.
+     * Used primarily for releasing experimental features.
+     * Flags are of the form key:value
+     */
+    flag?: string[];
 }
 export interface LinterCliOptions extends LinterOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "6.10.1",
+  "version": "6.11.1",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -70,12 +70,12 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "^6.10.1",
+    "@cspell/cspell-pipe": "^6.11.1",
     "chalk": "^4.1.2",
     "commander": "^9.4.0",
-    "cspell-gitignore": "^6.10.1",
-    "cspell-glob": "^6.10.1",
-    "cspell-lib": "^6.10.1",
+    "cspell-gitignore": "^6.11.1",
+    "cspell-glob": "^6.11.1",
+    "cspell-lib": "^6.11.1",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.1.0",
@@ -90,8 +90,8 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^6.10.1",
-    "@cspell/cspell-types": "^6.10.1",
+    "@cspell/cspell-json-reporter": "^6.11.1",
+    "@cspell/cspell-types": "^6.11.1",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^8.0.0",
@@ -99,12 +99,12 @@
     "@types/micromatch": "^4.0.2",
     "@types/minimatch": "^5.1.2",
     "@types/semver": "^7.3.12",
-    "jest": "^29.0.3",
+    "jest": "^29.1.1",
     "micromatch": "^4.0.5",
     "minimatch": "^5.1.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.79.0",
+    "rollup": "^2.79.1",
     "rollup-plugin-dts": "^4.2.2"
   },
-  "gitHead": "03625a3f7ca4ef85f3549ccae73d90d2cd3ac0f0"
+  "gitHead": "1a4559d3a82de15c7442ec15dbb3b7db99fb355e"
 }