src/vs/platform/agentHost/common/agentCustomizationSettings.ts
96 LOC · 82 covered · 14 uncovered · 19 ranges · 3662 concepts · 7 introducers · 1707 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
agentCustomizationSettings.ts ×7
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type { ConfigPropertySchema, RootState } from './state/protocol/state.js';
export const AGENT_CUSTOMIZATION_SETTINGS_META_KEY = 'vscode.agentCustomizationSettings';
export interface IAgentCustomizationSettingDescriptor {
readonly key: string;
readonly group: string;
readonly kind?: 'multiline';
readonly saveLabel?: string;
}
export interface IAgentCustomizationSettingsDescriptor {
readonly provider: string;
readonly title: string;
readonly description: string;
readonly settings: readonly IAgentCustomizationSettingDescriptor[];
readonly configurationFile?: {
readonly resource: string;
readonly title: string;
readonly description: string;
readonly openLabel: string;
readonly documentationUrl?: string;
readonly documentationLabel?: string;
};
}
export interface IAgentCustomizationSettingsRegistration extends IAgentCustomizationSettingsDescriptor {
readonly properties: Readonly<Record<string, ConfigPropertySchema>>;
}
function isAgentCustomizationSettingDescriptor(value: unknown): value is IAgentCustomizationSettingDescriptor {
agentCustomizationSettings.ts ×6
if (!value || typeof value !== 'object') {
return false;
}
const setting = value as Partial<IAgentCustomizationSettingDescriptor>;
agentCustomizationSettings.ts ×6
return typeof setting.key === 'string'
&& typeof setting.group === 'string'
&& (setting.kind === undefined || setting.kind === 'multiline')
&& (setting.saveLabel === undefined || typeof setting.saveLabel === 'string');
}
function isAgentCustomizationSettingsDescriptor(value: unknown): value is IAgentCustomizationSettingsDescriptor {
agentCustomizationSettings.ts ×6
if (!value || typeof value !== 'object') {
return false;
}
const entry = value as Partial<IAgentCustomizationSettingsDescriptor>;
agentCustomizationSettings.ts ×6
if (typeof entry.provider !== 'string' || typeof entry.title !== 'string' || typeof entry.description !== 'string' || !Array.isArray(entry.settings) || !entry.settings.every(isAgentCustomizationSettingDescriptor)) {
}
return file === undefined || (!!file
&& typeof file.resource === 'string'
&& typeof file.title === 'string'
&& typeof file.description === 'string'
&& typeof file.openLabel === 'string'
&& (file.documentationUrl === undefined || typeof file.documentationUrl === 'string')
&& (file.documentationLabel === undefined || typeof file.documentationLabel === 'string'));
export function getAgentCustomizationSettingsEntries(state: RootState | undefined): readonly IAgentCustomizationSettingsDescriptor[] {
const value = meta?.[AGENT_CUSTOMIZATION_SETTINGS_META_KEY];
return Array.isArray(value) ? value.filter(isAgentCustomizationSettingsDescriptor) : [];
}
export function withAgentCustomizationSettings(state: RootState | undefined, entries: readonly IAgentCustomizationSettingsDescriptor[]): Record<string, unknown> {
return { ...state?._meta, [AGENT_CUSTOMIZATION_SETTINGS_META_KEY]: entries };
agentCustomizationSettings.ts ×1
}
export function readAgentCustomizationSettings(state: RootState | undefined, provider: string): IAgentCustomizationSettingsDescriptor | undefined {
return getAgentCustomizationSettingsEntries(state).find(entry => entry.provider === provider);
}
export function getProviderBackedRootConfigKeys(state: RootState | undefined): ReadonlySet<string> {
return new Set(getAgentCustomizationSettingsEntries(state).flatMap(entry => entry.settings.map(setting => setting.key)));
agentCustomizationSettings.ts ×1
}
export function preserveProviderBackedRootConfigValues(state: RootState | undefined, replacement: Readonly<Record<string, unknown>>): Record<string, unknown> {
const current = state?.config?.values;
if (!current) {
return values;
}
for (const key of getProviderBackedRootConfigKeys(state)) {
if (!Object.hasOwn(values, key) && Object.hasOwn(current, key)) {
values[key] = current[key];
}
}
return values;
}