cspell 6.31.1 → 7.0.0-alpha.2

package/README.md

@@ -58,13 +58,13 @@ cspell
 with:
 
 ```
-docker run -v -i -t $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest
+docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest
 ```
 
 **Example:**
 
 ```sh
-docker run -v -i -t $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest lint --help
+docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest lint --help
 ```
 
 ## Basic Usage

package/dist/esm/application.d.mts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
 import type { CheckTextInfo, FeatureFlags, TraceResult } from 'cspell-lib';
 import type { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter.mjs';

package/dist/esm/cli-reporter.mjs

@@ -1,4 +1,5 @@
 import chalk from 'chalk';
+import chalkTemplate from 'chalk-template';
 import { isSpellingDictionaryLoadError } from 'cspell-lib';
 import * as path from 'path';
 import { URI } from '../lib/uri.cjs';
@@ -157,7 +158,7 @@ function formatIssue(templateStr, issue, maxIssueTextWidth) {
         $quickFix: formatQuickFix(issue),
     };
     const t = template(templateStr.replace(/\$message/g, message));
-    return substitute(chalk(t), substitutions).trimEnd();
+    return substitute(chalkTemplate(t), substitutions).trimEnd();
 }
 function formatSuggestions(issue) {
     if (issue.suggestionsEx) {

package/dist/esm/util/constants.d.mts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 export declare const UTF8: BufferEncoding;
 export declare const STDIN = "stdin";
 export declare const STDINProtocol = "stdin://";

package/dist/esm/util/fileHelper.d.mts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import type { CSpellUserSettings, Document, Issue } from 'cspell-lib';
 import { URI } from '../../lib/uri.cjs';
 import type { GlobOptions } from './glob.mjs';

package/dist/lib/file-entry-cache.cjs

@@ -24,9 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFromFile = void 0;
-const file_entry_cache = __importStar(require("file-entry-cache"));
+/* This is to work around a bug in file-entry-cache that uses `this` */
+const fileEntryCache = __importStar(require("file-entry-cache"));
 function createFromFile(pathToCache, useChecksum) {
-    return file_entry_cache.createFromFile(pathToCache, useChecksum);
+    return fileEntryCache.createFromFile(pathToCache, useChecksum);
 }
 exports.createFromFile = createFromFile;
 //# sourceMappingURL=file-entry-cache.cjs.map

package/dist/lib/file-entry-cache.d.cts

@@ -1,4 +1,4 @@
 export type { FileDescriptor, FileEntryCache } from 'file-entry-cache';
-import * as file_entry_cache from 'file-entry-cache';
-export declare function createFromFile(pathToCache: string, useChecksum?: boolean): file_entry_cache.FileEntryCache;
+import type { FileEntryCache } from 'file-entry-cache';
+export declare function createFromFile(pathToCache: string, useChecksum?: boolean): FileEntryCache;
 //# sourceMappingURL=file-entry-cache.d.cts.map

package/dist/lib/pkgInfo.cjs

@@ -1,30 +1,8 @@
 "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.npmPackage = exports.pkgDir = void 0;
-const path = __importStar(require("path"));
-exports.pkgDir = path.join(__dirname, '../..');
+const path_1 = require("path");
+exports.pkgDir = (0, path_1.join)(__dirname, '../..');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 exports.npmPackage = require('../../package.json');
 //# sourceMappingURL=pkgInfo.cjs.map

package/package.json

@@ -1,36 +1,33 @@
 {
   "name": "cspell",
-  "version": "6.31.1",
+  "version": "7.0.0-alpha.2",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
-    "cspell": "bin.js",
+    "cspell": "bin.mjs",
     "cspell-esm": "bin.mjs"
   },
-  "type": "commonjs",
-  "main": "dist/cjs/index.js",
-  "types": "dist/cjs/index.d.ts",
+  "type": "module",
+  "types": "dist/esm/index.d.mts",
   "module": "dist/esm/index.mjs",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js"
+      "import": "./dist/esm/index.mjs"
     },
     "./app": {
-      "import": "./dist/esm/app.mjs",
-      "require": "./dist/cjs/app.js"
+      "import": "./dist/esm/app.mjs"
     },
     "./bin": {
-      "import": "./bin.mjs",
-      "require": "./bin.js"
+      "import": "./bin.mjs"
+    },
+    "./bin.mjs": {
+      "import": "./bin.mjs"
     },
     "./application": {
-      "import": "./dist/esm/application.mjs",
-      "require": "./dist/cjs/application.js"
+      "import": "./dist/esm/application.mjs"
     }
   },
   "files": [
-    "bin.js",
     "bin.mjs",
     "dist",
     "!dist/esm/**/*.js",
@@ -43,17 +40,16 @@
     "!**/*.map"
   ],
   "scripts": {
-    "clean": "shx rm -rf dist coverage temp .tsbuildinfo",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "tsc -b . && ts2mjs dist/esm && pnpm run build:api",
     "build:api": "rollup -c rollup.config.mjs",
-    "build:cjs": "tsc -b tsconfig.cjs.json",
     "build:esm": "tsc -b tsconfig.esm.json",
     "build:esm:ts2mjs": "tsc -b tsconfig.esm.json && ts2mjs dist/esm",
     "build:lib": "tsc -b src/lib/tsconfig.json",
     "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.js lint --help > static/help-lint.txt",
-    "build:readme:help:trace": "./bin.js trace --help > static/help-trace.txt",
+    "build:readme:help:lint": "./bin.mjs lint --help > static/help-lint.txt",
+    "build:readme:help:trace": "./bin.mjs trace --help > static/help-trace.txt",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "pnpm coverage:vitest && pnpm coverage:fix",
     "coverage:vitest": "vitest run --coverage",
@@ -88,36 +84,35 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "6.31.1",
-    "@cspell/dynamic-import": "6.31.1",
-    "chalk": "^4.1.2",
-    "commander": "^10.0.0",
-    "cspell-gitignore": "6.31.1",
-    "cspell-glob": "6.31.1",
-    "cspell-io": "6.31.1",
-    "cspell-lib": "6.31.1",
+    "@cspell/cspell-pipe": "7.0.0-alpha.2",
+    "@cspell/dynamic-import": "7.0.0-alpha.2",
+    "chalk": "^5.2.0",
+    "chalk-template": "^1.0.0",
+    "commander": "^10.0.1",
+    "cspell-gitignore": "7.0.0-alpha.2",
+    "cspell-glob": "7.0.0-alpha.2",
+    "cspell-io": "7.0.0-alpha.2",
+    "cspell-lib": "7.0.0-alpha.2",
     "fast-glob": "^3.2.12",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
-    "get-stdin": "^8.0.0",
-    "imurmurhash": "^0.1.4",
-    "semver": "^7.3.8",
-    "strip-ansi": "^6.0.1",
+    "get-stdin": "^9.0.0",
+    "semver": "^7.5.0",
+    "strip-ansi": "^7.0.1",
     "vscode-uri": "^3.0.7"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "6.31.1",
-    "@cspell/cspell-types": "6.31.1",
+    "@cspell/cspell-json-reporter": "7.0.0-alpha.2",
+    "@cspell/cspell-types": "7.0.0-alpha.2",
     "@types/file-entry-cache": "^5.0.2",
     "@types/glob": "^8.1.0",
-    "@types/imurmurhash": "^0.1.1",
     "@types/micromatch": "^4.0.2",
     "@types/semver": "^7.3.13",
     "micromatch": "^4.0.5",
-    "minimatch": "^7.4.3"
+    "minimatch": "^9.0.0"
   },
-  "gitHead": "43c3652e27588f6643cf78fd764f12f497f89fbf"
+  "gitHead": "a1b7c5daeef5afdb14d6444318f450b9fd9c035a"
 }

package/bin.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-const app = require('./dist/cjs/app');
-const program = require('commander');
-
-app.run(program, process.argv).catch((e) => {
-    if (!(e instanceof program.CommanderError) && !(e instanceof app.CheckFailed)) {
-        console.log(e);
-        // It is possible an explicit exit code was set, use it if it was.
-        process.exitCode = process.exitCode || 1;
-    }
-    if (e instanceof app.CheckFailed) {
-        process.exitCode = e.exitCode;
-    }
-});

package/dist/cjs/app.d.ts

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

package/dist/cjs/app.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = exports.CheckFailed = void 0;
-const commander_1 = require("commander");
-const semver_1 = require("semver");
-const pkgInfo_cjs_1 = require("../lib/pkgInfo.cjs");
-const commandCheck_js_1 = require("./commandCheck.js");
-const commandLink_js_1 = require("./commandLink.js");
-const commandLint_js_1 = require("./commandLint.js");
-const commandSuggestion_js_1 = require("./commandSuggestion.js");
-const commandTrace_js_1 = require("./commandTrace.js");
-const errors_js_1 = require("./util/errors.js");
-var errors_js_2 = require("./util/errors.js");
-Object.defineProperty(exports, "CheckFailed", { enumerable: true, get: function () { return errors_js_2.CheckFailed; } });
-async function run(command, argv) {
-    const prog = command || commander_1.program;
-    const args = argv || process.argv;
-    prog.exitOverride();
-    prog.version(pkgInfo_cjs_1.npmPackage.version).description('Spelling Checker for Code').name('cspell');
-    if (!(0, semver_1.satisfies)(process.versions.node, pkgInfo_cjs_1.npmPackage.engines.node)) {
-        throw new errors_js_1.ApplicationError(`Unsupported NodeJS version (${process.versions.node}); ${pkgInfo_cjs_1.npmPackage.engines.node} is required`);
-    }
-    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_js_1.commandLint)(prog).addOption(optionFlags);
-    (0, commandTrace_js_1.commandTrace)(prog).addOption(optionFlags);
-    (0, commandCheck_js_1.commandCheck)(prog).addOption(optionFlags);
-    (0, commandSuggestion_js_1.commandSuggestion)(prog).addOption(optionFlags);
-    (0, commandLink_js_1.commandLink)(prog);
-    /*
-        program
-            .command('init')
-            .description('(Alpha) Initialize a cspell.json file.')
-            .option('-o, --output <cspell.json>', 'define where to write file.')
-            .option('--extends <cspell.json>', 'extend an existing cspell.json file.')
-            .action((options: InitOptions) => {
-                showHelp = false;
-                CSpellApplication.createInit(options).then(
-                    () => process.exit(0),
-                    () => process.exit(1)
-                );
-                console.log('Init');
-            });
-    */
-    prog.exitOverride();
-    await prog.parseAsync(args);
-}
-exports.run = run;
-//# sourceMappingURL=app.js.map

package/dist/cjs/application.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
-import type { CheckTextInfo, FeatureFlags, TraceResult } from 'cspell-lib';
-import type { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter.js';
-import type { BaseOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from './options.js';
-export type { TraceResult } from 'cspell-lib';
-export { IncludeExcludeFlag } from 'cspell-lib';
-export type AppError = NodeJS.ErrnoException;
-export declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
-export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceResult[]>;
-export 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/cjs/application.js

@@ -1,121 +0,0 @@
-"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.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_js_1 = require("./cli-reporter.js");
-const index_js_1 = require("./featureFlags/index.js");
-const index_js_2 = require("./lint/index.js");
-const options_js_1 = require("./options.js");
-const index_js_3 = require("./repl/index.js");
-const fileHelper_js_1 = require("./util/fileHelper.js");
-const reporters_js_1 = require("./util/reporters.js");
-const stdin_js_1 = require("./util/stdin.js");
-const timer_js_1 = require("./util/timer.js");
-const util = __importStar(require("./util/util.js"));
-var cspell_lib_2 = require("cspell-lib");
-Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return cspell_lib_2.IncludeExcludeFlag; } });
-function lint(fileGlobs, options, reporter) {
-    options = (0, options_js_1.fixLegacy)(options);
-    const cfg = new index_js_2.LintRequest(fileGlobs, options, (0, reporters_js_1.finalizeReporter)(reporter) ?? (0, cli_reporter_js_1.getReporter)({ ...options, fileGlobs }));
-    return (0, index_js_2.runLint)(cfg);
-}
-exports.lint = lint;
-async function* trace(words, options) {
-    options = (0, options_js_1.fixLegacy)(options);
-    const iWords = options.stdin ? (0, cspell_pipe_1.toAsyncIterable)(words, (0, stdin_js_1.readStdin)()) : words;
-    const { languageId, locale, allowCompoundWords, ignoreCase } = options;
-    const configFile = await (0, fileHelper_js_1.readConfig)(options.config, undefined);
-    const loadDefault = options.defaultConfiguration ?? configFile.config.loadDefaultConfiguration ?? 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, util.clean({ languageId, locale, ignoreCase, allowCompoundWords }));
-}
-exports.trace = trace;
-async function checkText(filename, options) {
-    options = (0, options_js_1.fixLegacy)(options);
-    const fileInfo = await (0, fileHelper_js_1.readFileInfo)(filename);
-    const { locale, languageId, validateDirectives } = options;
-    const doc = (0, fileHelper_js_1.fileInfoToDocument)(fileInfo, languageId, locale);
-    const checkOptions = {
-        configFile: options.config,
-        validateDirectives,
-    };
-    const settingsFromCommandLine = util.clean({
-        languageId,
-        language: locale,
-        loadDefaultConfiguration: options.defaultConfiguration,
-    });
-    return (0, cspell_lib_1.checkTextDocument)(doc, util.clean({ ...checkOptions }), settingsFromCommandLine);
-}
-exports.checkText = checkText;
-async function* suggestions(words, options) {
-    options = (0, options_js_1.fixLegacy)(options);
-    const configFile = await (0, fileHelper_js_1.readConfig)(options.config, undefined);
-    let timer;
-    function tapStart() {
-        timer = (0, timer_js_1.getTimeMeasurer)();
-    }
-    function mapStart(v) {
-        tapStart();
-        return v;
-    }
-    function mapEnd(v) {
-        const elapsedTimeMs = timer?.();
-        return elapsedTimeMs ? { ...v, elapsedTimeMs } : v;
-    }
-    const iWords = options.repl
-        ? (0, cspell_pipe_1.pipeAsync)((0, cspell_pipe_1.toAsyncIterable)(words, (0, index_js_3.simpleRepl)()), (0, cspell_pipe_1.opTap)(tapStart))
-        : options.useStdin
-            ? (0, cspell_pipe_1.pipeAsync)((0, cspell_pipe_1.toAsyncIterable)(words, (0, stdin_js_1.readStdin)()), (0, cspell_pipe_1.opTap)(tapStart))
-            : words.map(mapStart);
-    try {
-        const results = (0, cspell_pipe_1.pipeAsync)((0, cspell_lib_1.suggestionsForWords)(iWords, util.clean({ ...options }), configFile.config), (0, cspell_pipe_1.opMap)(mapEnd));
-        yield* results;
-    }
-    catch (e) {
-        if (!(e instanceof cspell_lib_1.SuggestionError))
-            throw e;
-        console.error(e.message);
-        process.exitCode = 1;
-    }
-}
-exports.suggestions = suggestions;
-function createInit() {
-    return Promise.reject();
-}
-exports.createInit = createInit;
-function registerApplicationFeatureFlags() {
-    const ff = (0, index_js_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, index_js_1.parseFeatureFlags)(flags, ff);
-}
-exports.parseApplicationFeatureFlags = parseApplicationFeatureFlags;
-//# sourceMappingURL=application.js.map

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

@@ -1,16 +0,0 @@
-import type { Issue } from '@cspell/cspell-types';
-import type { LinterCliOptions } from './options.js';
-import type { FinalizedReporter } from './util/reporters.js';
-export interface ReporterIssue extends Issue {
-    filename: string;
-}
-export interface ReporterOptions extends Pick<LinterCliOptions, 'debug' | 'issues' | 'legacy' | 'progress' | 'relative' | 'root' | 'showContext' | 'showSuggestions' | 'silent' | 'summary' | 'verbose' | 'wordsOnly'> {
-    fileGlobs: string[];
-}
-export declare function getReporter(options: ReporterOptions): FinalizedReporter;
-declare function formatIssue(templateStr: string, issue: ReporterIssue, maxIssueTextWidth: number): string;
-export declare const __testing__: {
-    formatIssue: typeof formatIssue;
-};
-export {};
-//# sourceMappingURL=cli-reporter.d.ts.map