cspell 8.19.2 → 8.19.3

package/dist/esm/application.mjs

@@ -6,7 +6,8 @@ import { getFeatureFlags, parseFeatureFlags } from './featureFlags/index.js';
 import { LintRequest, runLint } from './lint/index.js';
 import { fixLegacy } from './options.js';
 import { simpleRepl } from './repl/index.js';
-import { fileInfoToDocument, readConfig, readFileInfo } from './util/fileHelper.js';
+import { readConfig } from './util/configFileHelper.js';
+import { fileInfoToDocument, readFileInfo } from './util/fileHelper.js';
 import { finalizeReporter } from './util/reporters.js';
 import { readStdin } from './util/stdin.js';
 import { getTimeMeasurer } from './util/timer.js';

package/dist/esm/environment.d.ts

@@ -17,6 +17,14 @@ export interface CSpellEnvironmentVariables {
      */
     CSPELL_ENABLE_DICTIONARY_LOG_FIELDS?: string;
     CSPELL_GLOB_ROOT?: string;
+    /**
+     * Path to a specific CSpell config file.
+     */
+    CSPELL_CONFIG_PATH?: string;
+    /**
+     * Path to the default CSpell config file, used if no other config is found.
+     */
+    CSPELL_DEFAULT_CONFIG_PATH?: string;
 }
 export type EnvironmentKeys = keyof CSpellEnvironmentVariables;
 type EnvironmentKeyNames = {

package/dist/esm/environment.js

@@ -3,6 +3,8 @@ export const environmentKeys = {
     CSPELL_ENABLE_DICTIONARY_LOG_FILE: 'CSPELL_ENABLE_DICTIONARY_LOG_FILE',
     CSPELL_ENABLE_DICTIONARY_LOG_FIELDS: 'CSPELL_ENABLE_DICTIONARY_LOG_FIELDS',
     CSPELL_GLOB_ROOT: 'CSPELL_GLOB_ROOT',
+    CSPELL_CONFIG_PATH: 'CSPELL_CONFIG_PATH',
+    CSPELL_DEFAULT_CONFIG_PATH: 'CSPELL_DEFAULT_CONFIG_PATH',
 };
 export function getEnvironmentVariables() {
     return process.env;

package/dist/esm/lint/lint.js

@@ -14,8 +14,9 @@ import { getEnvironmentVariable, setEnvironmentVariable, truthy } from '../envir
 import { getFeatureFlags } from '../featureFlags/index.js';
 import { npmPackage } from '../pkgInfo.js';
 import { calcCacheSettings, createCache } from '../util/cache/index.js';
+import { readConfig } from '../util/configFileHelper.js';
 import { CheckFailed, toApplicationError, toError } from '../util/errors.js';
-import { fileInfoToDocument, filenameToUri, findFiles, isBinaryFile, isFile, isNotDir, readConfig, readFileInfo, readFileListFiles, resolveFilename, } from '../util/fileHelper.js';
+import { fileInfoToDocument, filenameToUri, findFiles, isBinaryFile, isFile, isNotDir, readFileInfo, readFileListFiles, resolveFilename, } from '../util/fileHelper.js';
 import { buildGlobMatcher, extractGlobsFromMatcher, extractPatterns, normalizeFileOrGlobsToRoot, normalizeGlobsToRoot, } from '../util/glob.js';
 import { prefetchIterable } from '../util/prefetch.js';
 import { loadReporters, mergeReporters } from '../util/reporters.js';

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.19.2";
+export declare const version = "8.19.3";
 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.19.2';
+export const version = '8.19.3';
 export const engines = { node: '>=18' };
 export const npmPackage = { name, version, engines };
 //# sourceMappingURL=pkgInfo.js.map

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

@@ -0,0 +1,15 @@
+import type { CSpellUserSettings } from 'cspell-lib';
+import { CSpellConfigFile } from '../options.js';
+export interface ConfigInfo {
+    source: string;
+    config: CSpellUserSettings;
+}
+export interface FileConfigInfo {
+    configInfo: ConfigInfo;
+    filename: string;
+    text: string;
+    languageIds: string[];
+}
+export declare function readConfig(configFile: string | CSpellConfigFile | undefined, root: string | undefined): Promise<ConfigInfo>;
+export declare function readConfigFile(filename: string | URL): Promise<CSpellConfigFile>;
+//# sourceMappingURL=configFileHelper.d.ts.map

package/dist/esm/util/configFileHelper.js

@@ -0,0 +1,43 @@
+import { toFilePathOrHref } from '@cspell/url';
+import * as cspell from 'cspell-lib';
+import { environmentKeys, getEnvironmentVariable } from '../environment.js';
+import { filenameToUrl } from './fileHelper.js';
+export async function readConfig(configFile, root) {
+    configFile ??= getEnvironmentVariable(environmentKeys.CSPELL_CONFIG_PATH);
+    if (configFile) {
+        const cfgFile = typeof configFile === 'string' ? await readConfigHandleError(configFile) : configFile;
+        return configFileToConfigInfo(cfgFile);
+    }
+    const config = await cspell.searchForConfig(root);
+    const defaultConfigFile = getEnvironmentVariable(environmentKeys.CSPELL_DEFAULT_CONFIG_PATH);
+    if (!config && defaultConfigFile) {
+        const cfgFile = await readConfigFile(defaultConfigFile).catch(() => undefined);
+        if (cfgFile) {
+            return configFileToConfigInfo(cfgFile);
+        }
+    }
+    return { source: config?.__importRef?.filename || 'None found', config: config || {} };
+}
+async function configFileToConfigInfo(cfgFile) {
+    const config = await cspell.resolveConfigFileImports(cfgFile);
+    const source = toFilePathOrHref(cfgFile.url);
+    return { source, config };
+}
+export function readConfigFile(filename) {
+    return cspell.readConfigFile(filename);
+}
+async function readConfigHandleError(filename) {
+    try {
+        return await readConfigFile(filename);
+    }
+    catch (e) {
+        const settings = {
+            __importRef: {
+                filename: filename.toString(),
+                error: e,
+            },
+        };
+        return { url: filenameToUrl(filename), settings };
+    }
+}
+//# sourceMappingURL=configFileHelper.js.map

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

@@ -1,20 +1,7 @@
 import type { BufferEncoding } from 'cspell-io';
-import type { CSpellUserSettings, Document, Issue } from 'cspell-lib';
+import type { Document, Issue } from 'cspell-lib';
 import * as cspell from 'cspell-lib';
-import { CSpellConfigFile } from '../options.js';
 import type { GlobOptions } from './glob.js';
-export interface ConfigInfo {
-    source: string;
-    config: CSpellUserSettings;
-}
-export interface FileConfigInfo {
-    configInfo: ConfigInfo;
-    filename: string;
-    text: string;
-    languageIds: string[];
-}
-export declare function readConfig(configFile: string | CSpellConfigFile | undefined, root: string | undefined): Promise<ConfigInfo>;
-export declare function readConfigFile(filename: string | URL): Promise<CSpellConfigFile>;
 export interface FileInfo {
     filename: string;
     text?: string;

package/dist/esm/util/fileHelper.js

@@ -1,11 +1,10 @@
 import { promises as fsp } from 'node:fs';
 import * as path from 'node:path';
+import streamConsumers from 'node:stream/consumers';
 import { fileURLToPath } from 'node:url';
-import { toFileDirURL, toFilePathOrHref, toFileURL } from '@cspell/url';
+import { toFileDirURL, toFileURL } from '@cspell/url';
 import { readFileText as cioReadFile, toURL } from 'cspell-io';
-import * as cspell from 'cspell-lib';
 import { fileToDocument, isBinaryFile as isUriBinaryFile } from 'cspell-lib';
-import getStdin from 'get-stdin';
 import { asyncAwait, asyncFlatten, asyncMap, asyncPipe, mergeAsyncIterables } from './async.js';
 import { FileUrlPrefix, STDIN, STDINProtocol, STDINUrlPrefix, UTF8 } from './constants.js';
 import { IOError, toApplicationError, toError } from './errors.js';
@@ -13,33 +12,6 @@ import { globP } from './glob.js';
 import { readStdin } from './stdin.js';
 import { isStdinUrl, resolveStdinUrl } from './stdinUrl.js';
 import { clean } from './util.js';
-export async function readConfig(configFile, root) {
-    if (configFile) {
-        const cfgFile = typeof configFile === 'string' ? await readConfigHandleError(configFile) : configFile;
-        const config = await cspell.resolveConfigFileImports(cfgFile);
-        const source = toFilePathOrHref(cfgFile.url);
-        return { source, config };
-    }
-    const config = await cspell.searchForConfig(root);
-    return { source: config?.__importRef?.filename || 'None found', config: config || {} };
-}
-export function readConfigFile(filename) {
-    return cspell.readConfigFile(filename);
-}
-async function readConfigHandleError(filename) {
-    try {
-        return await readConfigFile(filename);
-    }
-    catch (e) {
-        const settings = {
-            __importRef: {
-                filename: filename.toString(),
-                error: e,
-            },
-        };
-        return { url: filenameToUrl(filename), settings };
-    }
-}
 export function fileInfoToDocument(fileInfo, languageId, locale) {
     const { filename, text } = fileInfo;
     languageId = languageId || undefined;
@@ -90,7 +62,9 @@ export function resolveFilename(filename, cwd) {
 }
 export function readFileInfo(filename, encoding = UTF8, handleNotFound = false) {
     filename = resolveFilename(filename);
-    const pText = filename.startsWith(STDINProtocol) ? getStdin() : cioReadFile(filename, encoding);
+    const pText = filename.startsWith(STDINProtocol)
+        ? streamConsumers.text(process.stdin)
+        : cioReadFile(filename, encoding);
     return pText.then((text) => ({ text, filename }), (e) => {
         const error = toError(e);
         return handleNotFound && error.code === 'EISDIR'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "8.19.2",
+  "version": "8.19.3",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -81,22 +81,21 @@
   },
   "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "8.19.2",
-    "@cspell/cspell-pipe": "8.19.2",
-    "@cspell/cspell-types": "8.19.2",
-    "@cspell/dynamic-import": "8.19.2",
-    "@cspell/url": "8.19.2",
+    "@cspell/cspell-json-reporter": "8.19.3",
+    "@cspell/cspell-pipe": "8.19.3",
+    "@cspell/cspell-types": "8.19.3",
+    "@cspell/dynamic-import": "8.19.3",
+    "@cspell/url": "8.19.3",
     "chalk": "^5.4.1",
     "chalk-template": "^1.1.0",
     "commander": "^13.1.0",
-    "cspell-dictionary": "8.19.2",
-    "cspell-gitignore": "8.19.2",
-    "cspell-glob": "8.19.2",
-    "cspell-io": "8.19.2",
-    "cspell-lib": "8.19.2",
+    "cspell-dictionary": "8.19.3",
+    "cspell-gitignore": "8.19.3",
+    "cspell-glob": "8.19.3",
+    "cspell-io": "8.19.3",
+    "cspell-lib": "8.19.3",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^9.1.0",
-    "get-stdin": "^9.0.0",
     "semver": "^7.7.1",
     "tinyglobby": "^0.2.13"
   },
@@ -111,5 +110,5 @@
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.5"
   },
-  "gitHead": "f630ececa8cd91420aaaaa81c4ad910039457a06"
+  "gitHead": "cb6946b709da590d0c6175f9962799d18aa43e93"
 }