cspell-lib 5.16.0 → 5.18.0

package/dist/Models/CSpellSettingsInternalDef.d.ts

@@ -0,0 +1,23 @@
+import { CSpellSettingsWithSourceTrace, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, DictionaryDefinitionPreferred } from '@cspell/cspell-types';
+import { WeightMap } from 'cspell-trie-lib';
+export declare const SymbolCSpellSettingsInternal: unique symbol;
+export interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTrace, 'dictionaryDefinitions'> {
+    [SymbolCSpellSettingsInternal]: true;
+    dictionaryDefinitions?: DictionaryDefinitionInternal[];
+}
+declare type DictionaryDefinitionCustomUniqueFields = Omit<DictionaryDefinitionCustom, keyof DictionaryDefinitionPreferred>;
+export interface DictionaryDefinitionInternal extends Readonly<DictionaryDefinitionPreferred>, Readonly<Partial<DictionaryDefinitionCustomUniqueFields>>, Readonly<DictionaryDefinitionAugmented> {
+    /**
+     * Optional weight map used to improve suggestions.
+     */
+    readonly weightMap?: WeightMap | undefined;
+    /** The path to the config file that contains this dictionary definition */
+    readonly __source?: string | undefined;
+}
+export interface DictionaryDefinitionInternalWithSource extends DictionaryDefinitionInternal {
+    readonly __source: string;
+}
+export declare function createCSpellSettingsInternal(parts?: Partial<CSpellSettingsInternal>): CSpellSettingsInternal;
+export declare function isCSpellSettingsInternal(cs: CSpellSettingsInternal | CSpellSettingsWithSourceTrace): cs is CSpellSettingsInternal;
+export {};
+//# sourceMappingURL=CSpellSettingsInternalDef.d.ts.map

package/dist/Models/CSpellSettingsInternalDef.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCSpellSettingsInternal = exports.createCSpellSettingsInternal = exports.SymbolCSpellSettingsInternal = void 0;
+exports.SymbolCSpellSettingsInternal = Symbol('CSpellSettingsInternal');
+function createCSpellSettingsInternal(parts = {}) {
+    return {
+        ...parts,
+        [exports.SymbolCSpellSettingsInternal]: true,
+    };
+}
+exports.createCSpellSettingsInternal = createCSpellSettingsInternal;
+function isCSpellSettingsInternal(cs) {
+    return !!cs[exports.SymbolCSpellSettingsInternal];
+}
+exports.isCSpellSettingsInternal = isCSpellSettingsInternal;
+//# sourceMappingURL=CSpellSettingsInternalDef.js.map

package/dist/Settings/CSpellSettingsServer.d.ts

@@ -1,71 +1,50 @@
-import type { CSpellSettingsWithSourceTrace, CSpellUserSettings, Glob, ImportFileRef, PnPSettings } from '@cspell/cspell-types';
-import { URI } from 'vscode-uri';
-import { LoaderResult } from './pnpLoader';
+import type { CSpellSettingsWithSourceTrace, Glob, ImportFileRef } from '@cspell/cspell-types';
+import { CSpellSettingsInternal } from '../Models/CSpellSettingsInternalDef';
+declare type CSpellSettingsWST = CSpellSettingsWithSourceTrace;
+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 sectionCSpell = "cSpell";
-export declare const defaultFileName = "cspell.json";
 export declare const ENV_CSPELL_GLOB_ROOT = "CSPELL_GLOB_ROOT";
-export declare const defaultConfigFilenames: readonly string[];
-declare type CSpellSettings = CSpellSettingsWithSourceTrace;
+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;
+declare function mergeObjects<T>(left: undefined, right: T): T;
+export declare function mergeSettings(left: CSpellSettingsWST | CSpellSettingsI, ...settings: (CSpellSettingsWST | CSpellSettingsI)[]): CSpellSettingsI;
+export declare function mergeInDocSettings(left: CSpellSettingsWST, right: CSpellSettingsWST): CSpellSettingsWST;
+export declare function calcOverrideSettings(settings: CSpellSettingsWST, filename: string): 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.
+ *
+ * @param settings - settings to finalize
+ * @returns settings where all globs and file paths have been resolved.
  */
-declare function normalizeSettings(rawSettings: CSpellSettings, pathToSettingsFile: string, pnpSettings: PnPSettings): CSpellSettings;
-export declare function readSettings(filename: string): CSpellSettings;
-export declare function readSettings(filename: string, defaultValues: CSpellSettings): CSpellSettings;
-export declare function readSettings(filename: string, relativeTo: string): CSpellSettings;
-export declare function readSettings(filename: string, relativeTo: string, defaultValues: CSpellSettings): CSpellSettings;
-export declare function searchForConfig(searchFrom: string | undefined, pnpSettings?: PnPSettings): Promise<CSpellSettings | undefined>;
-export declare function loadConfig(file: string, pnpSettings?: PnPSettings): Promise<CSpellSettings>;
-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): CSpellSettings;
+export declare function finalizeSettings(settings: CSpellSettingsWST | CSpellSettingsI): CSpellSettingsI;
+export declare function toInternalSettings(settings: undefined): undefined;
+export declare function toInternalSettings(settings: CSpellSettingsI | CSpellSettingsWST): CSpellSettingsI;
+export declare function toInternalSettings(settings?: CSpellSettingsI | CSpellSettingsWST): CSpellSettingsI | undefined;
 /**
- *
- * @param filenames - settings files to read
- * @returns combined configuration
+ * @param filename - filename
+ * @param globs - globs
+ * @returns true if it matches
  * @deprecated true
+ * @deprecationMessage No longer actively supported. Use package: `cspell-glob`.
  */
-export declare function readSettingsFiles(filenames: string[]): CSpellSettings;
-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;
-declare function mergeObjects<T>(left: undefined, right: T): T;
-export declare function mergeSettings(left: CSpellSettings, ...settings: CSpellSettings[]): CSpellSettings;
-export declare function mergeInDocSettings(left: CSpellSettings, right: CSpellSettings): CSpellSettings;
-export declare function calcOverrideSettings(settings: CSpellSettings, filename: string): CSpellSettings;
-export declare function finalizeSettings(settings: CSpellSettings): CSpellSettings;
-export declare function getGlobalSettings(): CSpellSettings;
-export declare function getCachedFileSize(): number;
-export declare function clearCachedSettingsFiles(): void;
 export declare function checkFilenameMatchesGlob(filename: string, globs: Glob | Glob[]): boolean;
 /**
  * Return a list of Setting Sources used to create this Setting.
  * @param settings the settings to search
  */
-export declare function getSources(settings: CSpellSettings): CSpellSettings[];
+export declare function getSources(settings: CSpellSettingsWST): CSpellSettingsWST[];
 export interface ImportFileRefWithError extends ImportFileRef {
     error: Error;
 }
-export declare function extractImportErrors(settings: CSpellSettings): ImportFileRefWithError[];
 export interface ConfigurationDependencies {
     configFiles: string[];
     dictionaryFiles: string[];
 }
-export declare function extractDependencies(settings: CSpellSettings): ConfigurationDependencies;
-declare function normalizeCacheSettings(settings: Pick<CSpellSettings, 'cache'>, pathToSettingsDir: string): Pick<CSpellSettings, 'cache'>;
-declare function validateRawConfigVersion(config: CSpellUserSettings | {
-    version: unknown;
-}, fileRef: ImportFileRef): void;
-declare function validateRawConfigExports(config: CSpellUserSettings, fileRef: ImportFileRef): void;
+export declare function extractDependencies(settings: CSpellSettingsWST | CSpellSettingsI): ConfigurationDependencies;
 export declare const __testing__: {
     mergeObjects: typeof mergeObjects;
-    normalizeCacheSettings: typeof normalizeCacheSettings;
-    normalizeSettings: typeof normalizeSettings;
-    validateRawConfigExports: typeof validateRawConfigExports;
-    validateRawConfigVersion: typeof validateRawConfigVersion;
 };
 export {};
 //# sourceMappingURL=CSpellSettingsServer.d.ts.map