settingsCache.ts
utils/settings/settingsCache.ts
No strong subsystem tag
81
Lines
2416
Bytes
10
Exports
3
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with general runtime concerns. It contains 81 lines, 3 detected imports, and 10 detected exports.
Important relationships
Detected exports
getSessionSettingsCachesetSessionSettingsCachegetCachedSettingsForSourcesetCachedSettingsForSourcegetCachedParsedFilesetCachedParsedFileresetSettingsCachegetPluginSettingsBasesetPluginSettingsBaseclearPluginSettingsBase
Keywords
settingsvoidsourcesettingsjsonsessionsettingscachepersourcecachesettingsourcesettingswitherrorsparsedsettingsparsefilecache
Detected imports
./constants.js./types.js./validation.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import type { SettingSource } from './constants.js'
import type { SettingsJson } from './types.js'
import type { SettingsWithErrors, ValidationError } from './validation.js'
let sessionSettingsCache: SettingsWithErrors | null = null
export function getSessionSettingsCache(): SettingsWithErrors | null {
return sessionSettingsCache
}
export function setSessionSettingsCache(value: SettingsWithErrors): void {
sessionSettingsCache = value
}
/**
* Per-source cache for getSettingsForSource. Invalidated alongside the
* merged sessionSettingsCache — same resetSettingsCache() triggers
* (settings write, --add-dir, plugin init, hooks refresh).
*/
const perSourceCache = new Map<SettingSource, SettingsJson | null>()
export function getCachedSettingsForSource(
source: SettingSource,
): SettingsJson | null | undefined {
// undefined = cache miss; null = cached "no settings for this source"
return perSourceCache.has(source) ? perSourceCache.get(source) : undefined
}
export function setCachedSettingsForSource(
source: SettingSource,
value: SettingsJson | null,
): void {
perSourceCache.set(source, value)
}
/**
* Path-keyed cache for parseSettingsFile. Both getSettingsForSource and
* loadSettingsFromDisk call parseSettingsFile on the same paths during
* startup — this dedupes the disk read + zod parse.
*/
type ParsedSettings = {
settings: SettingsJson | null
errors: ValidationError[]
}
const parseFileCache = new Map<string, ParsedSettings>()
export function getCachedParsedFile(path: string): ParsedSettings | undefined {
return parseFileCache.get(path)
}
export function setCachedParsedFile(path: string, value: ParsedSettings): void {
parseFileCache.set(path, value)
}
export function resetSettingsCache(): void {
sessionSettingsCache = null
perSourceCache.clear()
parseFileCache.clear()
}
/**
* Plugin settings base layer for the settings cascade.
* pluginLoader writes here after loading plugins;
* loadSettingsFromDisk reads it as the lowest-priority base.
*/
let pluginSettingsBase: Record<string, unknown> | undefined
export function getPluginSettingsBase(): Record<string, unknown> | undefined {
return pluginSettingsBase
}
export function setPluginSettingsBase(
settings: Record<string, unknown> | undefined,
): void {
pluginSettingsBase = settings
}
export function clearPluginSettingsBase(): void {
pluginSettingsBase = undefined
}