src/vs/platform/agentHost/common/meta/agentCustomizationMeta.ts
54 LOC · 54 covered · 0 uncovered · 4 ranges · 408 concepts · 3 introducers · 188 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.
/*---------------------------------------------------------------------------------------------
agentCustomizationMeta.ts ×2
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type { Mutable } from '../../../../base/common/types.js';
import type { AgentCustomization } from '../state/protocol/state.js';
/**
* Well-known typed view over a custom agent's `_meta` bag (see
* `AgentCustomization._meta`), populated by the host's customization discovery
* and read by the agents-window customization providers. Read it through
* {@link readAgentCustomizationMeta} rather than indexing `_meta` directly.
*/
export interface IAgentCustomizationMeta {
/**
* Whether the user may invoke this custom agent directly (e.g. from the
* agent picker). Absent is treated as `true` by convention — only an
* explicit `false` hides the agent from direct user invocation.
*/
readonly userInvocable?: boolean;
}
/**
* Reads the well-known {@link IAgentCustomizationMeta} keys from a custom
* agent's `_meta` bag, dropping unknown keys and wrong-typed values.
*/
export function readAgentCustomizationMeta(agent: AgentCustomization): IAgentCustomizationMeta {
if (!meta) {
return {};
}
const result: Mutable<IAgentCustomizationMeta> = {};
if (typeof meta['userInvocable'] === 'boolean') {
result.userInvocable = meta['userInvocable'];
}
return result;
}
/**
* Serializes a typed {@link IAgentCustomizationMeta} into the `_meta` record,
* dropping `undefined` entries and returning `undefined` when empty. Build a
* custom agent's `_meta` through this so producers stay in lock-step with
* {@link readAgentCustomizationMeta}.
*/
export function toAgentCustomizationMeta(meta: IAgentCustomizationMeta): Record<string, unknown> | undefined {
for (const [key, value] of Object.entries(meta)) {
if (value !== undefined) {
result[key] = value;
}
}
return Object.keys(result).length > 0 ? result : undefined;
}