cspell-lib 6.7.0 → 6.8.2

package/dist/LanguageIds.js

@@ -16,6 +16,8 @@ exports.languageExtensionDefinitions = [
     { id: 'clojure', extensions: ['.clj', '.cljs', '.cljx', '.clojure', '.edn'] },
     { id: 'coffeescript', extensions: ['.coffee', '.cson'] },
     { id: 'c', extensions: ['.c'] },
+    // cspell:ignore cmake
+    { id: 'cmake', extensions: ['.cmake'], filenames: ['CMakeLists.txt'] },
     {
         id: 'cpp',
         extensions: ['.cpp', '.cc', '.cxx', '.hpp', '.hh', '.hxx', '.h', '.mm', '.ino', '.inl'],

package/dist/Settings/CSpellSettingsServer.d.ts

@@ -4,10 +4,6 @@ import { OptionalOrUndefined } from '../util/types';
 declare type CSpellSettingsWST = AdvancedCSpellSettingsWithSourceTrace;
 declare type CSpellSettingsWSTO = OptionalOrUndefined<AdvancedCSpellSettingsWithSourceTrace>;
 declare type CSpellSettingsI = CSpellSettingsInternal;
-export declare const configSettingsFileVersion0_1 = "0.1";
-export declare const configSettingsFileVersion0_2 = "0.2";
-export declare const currentSettingsFileVersion = "0.2";
-export declare const ENV_CSPELL_GLOB_ROOT = "CSPELL_GLOB_ROOT";
 declare function mergeObjects(left: undefined, right: undefined): undefined;
 declare function mergeObjects<T>(left: T, right: undefined): T;
 declare function mergeObjects<T>(left: T, right: T): T;

package/dist/Settings/CSpellSettingsServer.js

@@ -26,18 +26,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__testing__ = exports.extractDependencies = exports.getSources = exports.checkFilenameMatchesGlob = exports.toInternalSettings = exports.finalizeSettings = exports.calcOverrideSettings = exports.mergeInDocSettings = exports.mergeSettings = exports.ENV_CSPELL_GLOB_ROOT = exports.currentSettingsFileVersion = exports.configSettingsFileVersion0_2 = exports.configSettingsFileVersion0_1 = void 0;
+exports.__testing__ = exports.extractDependencies = exports.getSources = exports.checkFilenameMatchesGlob = exports.toInternalSettings = exports.finalizeSettings = exports.calcOverrideSettings = exports.mergeInDocSettings = exports.mergeSettings = void 0;
 const assert_1 = __importDefault(require("assert"));
 const cspell_glob_1 = require("cspell-glob");
 const path = __importStar(require("path"));
 const CSpellSettingsInternalDef_1 = require("../Models/CSpellSettingsInternalDef");
 const util = __importStar(require("../util/util"));
+const constants_1 = require("./constants");
 const DictionarySettings_1 = require("./DictionarySettings");
 const patterns_1 = require("./patterns");
-exports.configSettingsFileVersion0_1 = '0.1';
-exports.configSettingsFileVersion0_2 = '0.2';
-exports.currentSettingsFileVersion = exports.configSettingsFileVersion0_2;
-exports.ENV_CSPELL_GLOB_ROOT = 'CSPELL_GLOB_ROOT';
 function _unique(a) {
     return [...new Set(a)];
 }
@@ -157,7 +154,7 @@ function merge(left, right) {
     return settings;
 }
 function versionBasedMergeList(left, right, version) {
-    if (version === exports.configSettingsFileVersion0_1) {
+    if (version === constants_1.configSettingsFileVersion0_1) {
         return takeRightOtherwiseLeft(left, right);
     }
     return mergeListUnique(left, right);
@@ -269,9 +266,9 @@ function mergeSources(left, right) {
     };
 }
 function max(a, b) {
-    if (a === undefined)
+    if (a === undefined || a === null)
         return b;
-    if (b === undefined)
+    if (b === undefined || b === null)
         return a;
     return a > b ? a : b;
 }
@@ -321,7 +318,7 @@ function extractDependencies(settings) {
 }
 exports.extractDependencies = extractDependencies;
 function resolveCwd() {
-    const envGlobRoot = process.env[exports.ENV_CSPELL_GLOB_ROOT];
+    const envGlobRoot = process.env[constants_1.ENV_CSPELL_GLOB_ROOT];
     const cwd = envGlobRoot || process.cwd();
     return cwd;
 }

package/dist/Settings/Controller/configLoader/configLoader.d.ts

@@ -0,0 +1,137 @@
+import type { CSpellSettingsWithSourceTrace, CSpellUserSettings, ImportFileRef, PnPSettings as PnPSettingsStrict } from '@cspell/cspell-types';
+import { CSpellIO } from 'cspell-io';
+import { URI } from 'vscode-uri';
+import { CSpellSettingsInternal } from '../../../Models/CSpellSettingsInternalDef';
+import { OptionalOrUndefined } from '../../../util/types';
+import { LoaderResult } from '../pnpLoader';
+import { normalizeCacheSettings } from './normalizeRawSettings';
+export declare type CSpellSettingsWST = CSpellSettingsWithSourceTrace;
+export declare type CSpellSettingsI = CSpellSettingsInternal;
+declare type PnPSettings = OptionalOrUndefined<PnPSettingsStrict>;
+export declare const sectionCSpell = "cSpell";
+export declare const defaultFileName = "cspell.json";
+export declare const defaultConfigFilenames: readonly string[];
+export declare class ConfigLoader {
+    readonly cspellIO: CSpellIO;
+    /**
+     * Use `createConfigLoader`
+     * @param cspellIO - CSpellIO interface for reading files.
+     */
+    protected constructor(cspellIO: CSpellIO);
+    protected cachedFiles: Map<string, CSpellSettingsInternal>;
+    protected cspellConfigExplorer: {
+        readonly search: (searchFrom?: string | undefined) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
+        readonly load: (filepath: string) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
+        readonly clearLoadCache: () => void;
+        readonly clearSearchCache: () => void;
+        readonly clearCaches: () => void;
+    };
+    protected cspellConfigExplorerSync: {
+        readonly search: (searchFrom?: string | undefined) => import("cosmiconfig/dist/types").CosmiconfigResult;
+        readonly load: (filepath: string) => import("cosmiconfig/dist/types").CosmiconfigResult;
+        readonly clearLoadCache: () => void;
+        readonly clearSearchCache: () => void;
+        readonly clearCaches: () => void;
+    };
+    protected globalSettings: CSpellSettingsI | undefined;
+    /**
+     * Read / import a cspell configuration file.
+     * @param filename - the path to the file.
+     *   Supported types: json, yaml, js, and cjs. ES Modules are not supported.
+     *   - absolute path `/absolute/path/to/file`
+     *   - relative path `./path/to/file` (relative to the current working directory)
+     *   - package `@cspell/dict-typescript/cspell-ext.json`
+     */
+    readSettings(filename: string): CSpellSettingsI;
+    readSettings(filename: string, defaultValues: CSpellSettingsWST): CSpellSettingsI;
+    /**
+     * Read / import a cspell configuration file.
+     * @param filename - the path to the file.
+     *   Supported types: json, yaml, js, and cjs. ES Modules are not supported.
+     *   - absolute path `/absolute/path/to/file`
+     *   - relative path `./path/to/file` (relative to `relativeTo`)
+     *   - package `@cspell/dict-typescript/cspell-ext.json` searches for node_modules relative to `relativeTo`
+     * @param relativeTo - absolute path to start searching for relative files or node_modules.
+     */
+    readSettings(filename: string, relativeTo?: string): CSpellSettingsI;
+    readSettings(filename: string, relativeTo: string, defaultValues: CSpellSettingsWST): CSpellSettingsI;
+    readSettings(filename: string, relativeToOrDefault?: CSpellSettingsWST | string): CSpellSettingsI;
+    getGlobalSettings(): CSpellSettingsI;
+    clearCachedSettingsFiles(): void;
+    /**
+     * Read a config file and inject the fileRef.
+     * @param fileRef - filename plus context, injected into the resulting config.
+     */
+    protected readConfig(fileRef: ImportFileRef): CSpellSettingsWST;
+    protected importSettings(fileRef: ImportFileRef, defaultValues: CSpellSettingsWST | undefined, pnpSettings: PnPSettings): CSpellSettingsI;
+    /**
+     * normalizeSettings handles correcting all relative paths, anchoring globs, and importing other config files.
+     * @param rawSettings - raw configuration settings
+     * @param pathToSettingsFile - path to the source file of the configuration settings.
+     */
+    protected normalizeSettings(rawSettings: CSpellSettingsWST, pathToSettingsFile: string, pnpSettings: PnPSettings): CSpellSettingsI;
+}
+declare class ConfigLoaderInternal extends ConfigLoader {
+    constructor(cspellIO: CSpellIO);
+    get _cachedFiles(): Map<string, CSpellSettingsInternal>;
+    get _cspellConfigExplorer(): {
+        readonly search: (searchFrom?: string | undefined) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
+        readonly load: (filepath: string) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
+        readonly clearLoadCache: () => void;
+        readonly clearSearchCache: () => void;
+        readonly clearCaches: () => void;
+    };
+    get _cspellConfigExplorerSync(): {
+        readonly search: (searchFrom?: string | undefined) => import("cosmiconfig/dist/types").CosmiconfigResult;
+        readonly load: (filepath: string) => import("cosmiconfig/dist/types").CosmiconfigResult;
+        readonly clearLoadCache: () => void;
+        readonly clearSearchCache: () => void;
+        readonly clearCaches: () => void;
+    };
+    readonly _readConfig: (fileRef: ImportFileRef) => CSpellSettingsWithSourceTrace;
+    readonly _normalizeSettings: (rawSettings: CSpellSettingsWithSourceTrace, pathToSettingsFile: string, pnpSettings: OptionalOrUndefined<PnPSettingsStrict>) => CSpellSettingsInternal;
+}
+export declare function searchForConfig(searchFrom: string | undefined, pnpSettings?: PnPSettings): Promise<CSpellSettingsI | undefined>;
+export declare function searchForConfigSync(searchFrom: string | undefined, pnpSettings?: PnPSettings): CSpellSettingsI | undefined;
+/**
+ * Load a CSpell configuration files.
+ * @param file - path or package reference to load.
+ * @param pnpSettings - PnP settings
+ * @returns normalized CSpellSettings
+ */
+export declare function loadConfig(file: string, pnpSettings?: PnPSettings): Promise<CSpellSettingsI>;
+/**
+ * Load a CSpell configuration files.
+ * @param filename - path or package reference to load.
+ * @param pnpSettings - PnP settings
+ * @returns normalized CSpellSettings
+ */
+export declare function loadConfigSync(filename: string, pnpSettings?: PnPSettings): CSpellSettingsI;
+export declare function loadPnP(pnpSettings: PnPSettings, searchFrom: URI): Promise<LoaderResult>;
+export declare function loadPnPSync(pnpSettings: PnPSettings, searchFrom: URI): LoaderResult;
+export declare function readRawSettings(filename: string, relativeTo?: string): CSpellSettingsWST;
+/**
+ *
+ * @param filenames - settings files to read
+ * @returns combined configuration
+ * @deprecated true
+ */
+export declare function readSettingsFiles(filenames: string[]): CSpellSettingsI;
+export declare function getGlobalSettings(): CSpellSettingsI;
+export declare function getCachedFileSize(): number;
+export declare function clearCachedSettingsFiles(): void;
+declare function validateRawConfigVersion(config: CSpellUserSettings | {
+    version: unknown;
+}, fileRef: ImportFileRef): void;
+declare function validateRawConfigExports(config: CSpellUserSettings, fileRef: ImportFileRef): void;
+export declare function createConfigLoader(cspellIO?: CSpellIO): ConfigLoader;
+declare function getDefaultConfigLoaderInternal(): ConfigLoaderInternal;
+export declare function getDefaultConfigLoader(): ConfigLoader;
+export declare const __testing__: {
+    getDefaultConfigLoaderInternal: typeof getDefaultConfigLoaderInternal;
+    normalizeCacheSettings: typeof normalizeCacheSettings;
+    validateRawConfigExports: typeof validateRawConfigExports;
+    validateRawConfigVersion: typeof validateRawConfigVersion;
+};
+export {};
+//# sourceMappingURL=configLoader.d.ts.map