Add support for agent-scoped hooks (#299029)

Author: pwang347

src/vs/workbench/contrib/chat/browser/aiCustomization/aiCustomizationListWidget.ts

@@ -43,7 +43,7 @@ import { IPathService } from '../../../../services/path/common/pathService.js';
 import { generateCustomizationDebugReport } from './aiCustomizationDebugPanel.js';
 import { parseHooksFromFile } from '../../common/promptSyntax/hookCompatibility.js';
 import { formatHookCommandLabel } from '../../common/promptSyntax/hookSchema.js';
-import { HOOK_METADATA } from '../../common/promptSyntax/hookTypes.js';
+import { HookType, HOOK_METADATA } from '../../common/promptSyntax/hookTypes.js';
 import { parse as parseJSONC } from '../../../../../base/common/json.js';
 import { Schemas } from '../../../../../base/common/network.js';
 import { OS } from '../../../../../base/common/platform.js';
@@ -65,6 +65,8 @@ export interface IAICustomizationListItem {
 	readonly description?: string;
 	readonly storage: PromptsStorage;
 	readonly promptType: PromptsType;
+	/** When set, overrides `storage` for display grouping purposes. */
+	readonly groupKey?: string;
 	nameMatches?: IMatch[];
 	descriptionMatches?: IMatch[];
 }
@@ -75,7 +77,7 @@ export interface IAICustomizationListItem {
 interface IGroupHeaderEntry {
 	readonly type: 'group-header';
 	readonly id: string;
-	readonly storage: PromptsStorage;
+	readonly groupKey: string;
 	readonly label: string;
 	readonly icon: ThemeIcon;
 	readonly count: number;
@@ -311,7 +313,7 @@ export class AICustomizationListWidget extends Disposable {
 	private allItems: IAICustomizationListItem[] = [];
 	private displayEntries: IListEntry[] = [];
 	private searchQuery: string = '';
-	private readonly collapsedGroups = new Set<PromptsStorage>();
+	private readonly collapsedGroups = new Set<string>();
 	private readonly dropdownActionDisposables = this._register(new DisposableStore());
 
 	private readonly delayedFilter = new Delayer<void>(200);
@@ -827,6 +829,37 @@ export class AICustomizationListWidget extends Disposable {
 					});
 				}
 			}
+
+			// Also include hooks defined in agent frontmatter (not in sessions window)
+			// TODO: add this back when Copilot CLI supports this
+			const agents = !this.workspaceService.isSessionsWindow ? await this.promptsService.getCustomAgents(CancellationToken.None) : [];
+			for (const agent of agents) {
+				if (!agent.hooks) {
+					continue;
+				}
+				for (const hookType of Object.values(HookType)) {
+					const hookCommands = agent.hooks[hookType];
+					if (!hookCommands || hookCommands.length === 0) {
+						continue;
+					}
+					const hookMeta = HOOK_METADATA[hookType];
+					for (let i = 0; i < hookCommands.length; i++) {
+						const hook = hookCommands[i];
+						const cmdLabel = formatHookCommandLabel(hook, OS);
+						const truncatedCmd = cmdLabel.length > 60 ? cmdLabel.substring(0, 57) + '...' : cmdLabel;
+						items.push({
+							id: `${agent.uri.toString()}#hook:${hookType}[${i}]`,
+							uri: agent.uri,
+							name: hookMeta?.label ?? hookType,
+							filename: basename(agent.uri),
+							description: `${agent.name}: ${truncatedCmd || localize('hookUnset', "(unset)")}`,
+							storage: agent.source.storage,
+							groupKey: 'agents',
+							promptType,
+						});
+					}
+				}
+			}
 		} else {
 			// For instructions, fetch prompt files and group by storage
 			const promptFiles = await this.promptsService.listPromptFiles(promptType, CancellationToken.None);
@@ -940,15 +973,17 @@ export class AICustomizationListWidget extends Disposable {
 		// Group items by storage
 		const promptType = sectionToPromptType(this.currentSection);
 		const visibleSources = new Set(this.workspaceService.getStorageSourceFilter(promptType).sources);
-		const groups: { storage: PromptsStorage; label: string; icon: ThemeIcon; description: string; items: IAICustomizationListItem[] }[] = [
-			{ storage: PromptsStorage.local, label: localize('workspaceGroup', "Workspace"), icon: workspaceIcon, description: localize('workspaceGroupDescription', "Customizations stored as files in your project folder and shared with your team via version control."), items: [] },
-			{ storage: PromptsStorage.user, label: localize('userGroup', "User"), icon: userIcon, description: localize('userGroupDescription', "Customizations stored locally on your machine in a central location. Private to you and available across all projects."), items: [] },
-			{ storage: PromptsStorage.extension, label: localize('extensionGroup', "Extensions"), icon: extensionIcon, description: localize('extensionGroupDescription', "Read-only customizations provided by installed extensions."), items: [] },
-			{ storage: PromptsStorage.plugin, label: localize('pluginGroup', "Plugins"), icon: pluginIcon, description: localize('pluginGroupDescription', "Read-only customizations provided by installed plugins."), items: [] },
-		].filter(g => visibleSources.has(g.storage));
+		const groups: { groupKey: string; label: string; icon: ThemeIcon; description: string; items: IAICustomizationListItem[] }[] = [
+			{ groupKey: PromptsStorage.local, label: localize('workspaceGroup', "Workspace"), icon: workspaceIcon, description: localize('workspaceGroupDescription', "Customizations stored as files in your project folder and shared with your team via version control."), items: [] },
+			{ groupKey: PromptsStorage.user, label: localize('userGroup', "User"), icon: userIcon, description: localize('userGroupDescription', "Customizations stored locally on your machine in a central location. Private to you and available across all projects."), items: [] },
+			{ groupKey: PromptsStorage.extension, label: localize('extensionGroup', "Extensions"), icon: extensionIcon, description: localize('extensionGroupDescription', "Read-only customizations provided by installed extensions."), items: [] },
+			{ groupKey: PromptsStorage.plugin, label: localize('pluginGroup', "Plugins"), icon: pluginIcon, description: localize('pluginGroupDescription', "Read-only customizations provided by installed plugins."), items: [] },
+			{ groupKey: 'agents', label: localize('agentsGroup', "Agents"), icon: agentIcon, description: localize('agentsGroupDescription', "Hooks defined in agent files."), items: [] },
+		].filter(g => visibleSources.has(g.groupKey as PromptsStorage) || g.groupKey === 'agents');
 
 		for (const item of matchedItems) {
-			const group = groups.find(g => g.storage === item.storage);
+			const key = item.groupKey ?? item.storage;
+			const group = groups.find(g => g.groupKey === key);
 			if (group) {
 				group.items.push(item);
 			}
@@ -967,12 +1002,12 @@ export class AICustomizationListWidget extends Disposable {
 				continue;
 			}
 
-			const collapsed = this.collapsedGroups.has(group.storage);
+			const collapsed = this.collapsedGroups.has(group.groupKey);
 
 			this.displayEntries.push({
 				type: 'group-header',
-				id: `group-${group.storage}`,
-				storage: group.storage,
+				id: `group-${group.groupKey}`,
+				groupKey: group.groupKey,
 				label: group.label,
 				icon: group.icon,
 				count: group.items.length,
@@ -997,10 +1032,10 @@ export class AICustomizationListWidget extends Disposable {
 	 * Toggles the collapsed state of a group.
 	 */
 	private toggleGroup(entry: IGroupHeaderEntry): void {
-		if (this.collapsedGroups.has(entry.storage)) {
-			this.collapsedGroups.delete(entry.storage);
+		if (this.collapsedGroups.has(entry.groupKey)) {
+			this.collapsedGroups.delete(entry.groupKey);
 		} else {
-			this.collapsedGroups.add(entry.storage);
+			this.collapsedGroups.add(entry.groupKey);
 		}
 		this.filterItems();
 	}

src/vs/workbench/contrib/chat/browser/promptSyntax/hookActions.ts

@@ -24,14 +24,14 @@ import { CancellationToken } from '../../../../../base/common/cancellation.js';
 import { IQuickInputButton, IQuickInputService, IQuickPick, IQuickPickItem, IQuickPickSeparator } from '../../../../../platform/quickinput/common/quickInput.js';
 import { IFileService } from '../../../../../platform/files/common/files.js';
 import { HOOK_METADATA, HOOKS_BY_TARGET, HookType, IHookTypeMeta } from '../../common/promptSyntax/hookTypes.js';
-import { getEffectiveCommandFieldKey } from '../../common/promptSyntax/hookSchema.js';
+import { formatHookCommandLabel, getEffectiveCommandFieldKey } from '../../common/promptSyntax/hookSchema.js';
 import { getCopilotCliHookTypeName, resolveCopilotCliHookType } from '../../common/promptSyntax/hookCopilotCliCompat.js';
 import { getHookSourceFormat, HookSourceFormat, buildNewHookEntry } from '../../common/promptSyntax/hookCompatibility.js';
 import { getClaudeHookTypeName, resolveClaudeHookType } from '../../common/promptSyntax/hookClaudeCompat.js';
 import { ILabelService } from '../../../../../platform/label/common/label.js';
 import { IEditorService } from '../../../../services/editor/common/editorService.js';
 import { ITextEditorSelection } from '../../../../../platform/editor/common/editor.js';
-import { findHookCommandSelection, parseAllHookFiles, IParsedHook } from './hookUtils.js';
+import { findHookCommandSelection, findHookCommandInYaml, parseAllHookFiles, IParsedHook } from './hookUtils.js';
 import { IWorkspaceContextService } from '../../../../../platform/workspace/common/workspace.js';
 import { IPathService } from '../../../../services/path/common/pathService.js';
 import { INotificationService } from '../../../../../platform/notification/common/notification.js';
@@ -348,7 +348,8 @@ export async function showConfigureHooksQuickPick(
 		workspaceRootUri,
 		userHome,
 		targetOS,
-		CancellationToken.None
+		CancellationToken.None,
+		{ includeAgentHooks: true }
 	);
 
 	// Count hooks per type
@@ -445,6 +446,10 @@ export async function showConfigureHooksQuickPick(
 					// Filter hooks by the selected type
 					const hooksOfType = hookEntries.filter(h => h.hookType === selectedHookType!.hookType);
 
+					// Separate hooks by source
+					const fileHooks = hooksOfType.filter(h => !h.agentName);
+					const agentHooks = hooksOfType.filter(h => h.agentName);
+
 					// Step 2: Show "Add new hook" + existing hooks of this type
 					const hookItems: (IHookQuickPickItem | IQuickPickSeparator)[] = [];
 
@@ -455,14 +460,14 @@ export async function showConfigureHooksQuickPick(
 						alwaysShow: true
 					});
 
-					// Add existing hooks
-					if (hooksOfType.length > 0) {
+					// Add existing file-based hooks
+					if (fileHooks.length > 0) {
 						hookItems.push({
 							type: 'separator',
 							label: localize('existingHooks', "Existing Hooks")
 						});
 
-						for (const entry of hooksOfType) {
+						for (const entry of fileHooks) {
 							const description = labelService.getUriLabel(entry.fileUri, { relative: true });
 							hookItems.push({
 								label: entry.commandLabel,
@@ -472,6 +477,26 @@ export async function showConfigureHooksQuickPick(
 						}
 					}
 
+					// Add agent-defined hooks grouped by agent name
+					if (agentHooks.length > 0) {
+						const agentNames = [...new Set(agentHooks.map(h => h.agentName!))];
+						for (const agentName of agentNames) {
+							hookItems.push({
+								type: 'separator',
+								label: localize('agentHooks', "Agent: {0}", agentName)
+							});
+
+							for (const entry of agentHooks.filter(h => h.agentName === agentName)) {
+								const description = labelService.getUriLabel(entry.fileUri, { relative: true });
+								hookItems.push({
+									label: entry.commandLabel,
+									description,
+									hookEntry: entry
+								});
+							}
+						}
+					}
+
 					// Auto-execute if only "Add new hook" is available (no existing hooks)
 					if (hooksOfType.length === 0) {
 						selectedHook = hookItems[0] as IHookQuickPickItem;
@@ -500,22 +525,34 @@ export async function showConfigureHooksQuickPick(
 						const entry = selectedHook.hookEntry;
 						let selection: ITextEditorSelection | undefined;
 
-						// Determine the command field name to highlight based on target platform
-						const commandFieldName = getEffectiveCommandFieldKey(entry.command, targetOS);
-
-						// Try to find the command field to highlight
-						if (commandFieldName) {
+						if (entry.agentName) {
+							// Agent hook: search the YAML frontmatter for the command
 							try {
 								const content = await fileService.readFile(entry.fileUri);
-								selection = findHookCommandSelection(
-									content.value.toString(),
-									entry.originalHookTypeId,
-									entry.index,
-									commandFieldName
-								);
+								const commandText = formatHookCommandLabel(entry.command, targetOS);
+								if (commandText) {
+									selection = findHookCommandInYaml(content.value.toString(), commandText);
+								}
 							} catch {
 								// Ignore errors and just open without selection
 							}
+						} else {
+							// File hook: use JSON-based selection finder
+							const commandFieldName = getEffectiveCommandFieldKey(entry.command, targetOS);
+
+							if (commandFieldName) {
+								try {
+									const content = await fileService.readFile(entry.fileUri);
+									selection = findHookCommandSelection(
+										content.value.toString(),
+										entry.originalHookTypeId,
+										entry.index,
+										commandFieldName
+									);
+								} catch {
+									// Ignore errors and just open without selection
+								}
+							}
 						}
 
 						if (options?.openEditor) {

src/vs/workbench/contrib/chat/browser/promptSyntax/hookUtils.ts

@@ -114,6 +114,54 @@ export function findHookCommandSelection(content: string, hookType: string, inde
 	};
 }
 
+/**
+ * Finds the selection range for a hook command string in a YAML/Markdown file
+ * (e.g., an agent `.md` file with YAML frontmatter).
+ *
+ * Searches for the command text within command field lines and selects the value.
+ * Supports all hook command field keys: command, windows, linux, osx, bash, powershell.
+ *
+ * @param content The full file content
+ * @param commandText The command string to locate
+ * @returns The selection range, or undefined if not found
+ */
+export function findHookCommandInYaml(content: string, commandText: string): ITextEditorSelection | undefined {
+	const commandFieldKeys = ['command', 'windows', 'linux', 'osx', 'bash', 'powershell'];
+	const lines = content.split('\n');
+	for (let i = 0; i < lines.length; i++) {
+		const line = lines[i];
+		const trimmed = line.trimStart();
+
+		// Only match lines whose YAML key is a known command field
+		const matchedKey = commandFieldKeys.find(key =>
+			trimmed.startsWith(`${key}:`) || trimmed.startsWith(`- ${key}:`)
+		);
+		if (!matchedKey) {
+			continue;
+		}
+
+		// Search after the colon to avoid matching within the key name itself
+		const colonIdx = line.indexOf(':');
+		const idx = line.indexOf(commandText, colonIdx + 1);
+		if (idx !== -1) {
+			// Verify this is a full match (not a substring of a longer command)
+			const afterIdx = idx + commandText.length;
+			const charAfter = afterIdx < line.length ? line.charCodeAt(afterIdx) : -1;
+			// Accept if what follows is end of line, a quote, or whitespace
+			if (charAfter === -1 || charAfter === 34 /* " */ || charAfter === 39 /* ' */ || charAfter === 32 /* space */ || charAfter === 9 /* tab */) {
+				return {
+					startLineNumber: i + 1,
+					startColumn: idx + 1,
+					endLineNumber: i + 1,
+					endColumn: idx + 1 + commandText.length
+				};
+			}
+		}
+	}
+
+	return undefined;
+}
+
 /**
  * Parsed hook information.
  */
@@ -129,11 +177,15 @@ export interface IParsedHook {
 	originalHookTypeId: string;
 	/** If true, this hook is disabled via `disableAllHooks: true` in its file */
 	disabled?: boolean;
+	/** If set, this hook came from a custom agent's frontmatter */
+	agentName?: string;
 }
 
 export interface IParseAllHookFilesOptions {
 	/** Additional file URIs to parse (e.g., files skipped due to disableAllHooks) */
 	additionalDisabledFileUris?: readonly URI[];
+	/** If true, also collect hooks from custom agent frontmatter */
+	includeAgentHooks?: boolean;
 }
 
 /**
@@ -227,5 +279,40 @@ export async function parseAllHookFiles(
 		}
 	}
 
+	// Collect hooks from custom agents' frontmatter
+	if (options?.includeAgentHooks) {
+		const agents = await promptsService.getCustomAgents(token);
+		for (const agent of agents) {
+			if (!agent.hooks) {
+				continue;
+			}
+			for (const hookTypeValue of Object.values(HookType)) {
+				const commands = agent.hooks[hookTypeValue];
+				if (!commands || commands.length === 0) {
+					continue;
+				}
+				const hookTypeMeta = HOOK_METADATA[hookTypeValue];
+				if (!hookTypeMeta) {
+					continue;
+				}
+				for (let i = 0; i < commands.length; i++) {
+					const command = commands[i];
+					const commandLabel = formatHookCommandLabel(command, os) || nls.localize('commands.hook.emptyCommand', '(empty command)');
+					parsedHooks.push({
+						hookType: hookTypeValue,
+						hookTypeLabel: hookTypeMeta.label,
+						command,
+						commandLabel,
+						fileUri: agent.uri,
+						filePath: labelService.getUriLabel(agent.uri, { relative: true }),
+						index: i,
+						originalHookTypeId: hookTypeValue,
+						agentName: agent.name,
+					});
+				}
+			}
+		}
+	}
+
 	return parsedHooks;
 }

src/vs/workbench/contrib/chat/common/chatService/chatServiceImpl.ts

@@ -53,7 +53,7 @@ import { ChatMessageRole, IChatMessage, ILanguageModelsService } from '../langua
 import { ILanguageModelToolsService } from '../tools/languageModelToolsService.js';
 import { ChatSessionOperationLog } from '../model/chatSessionOperationLog.js';
 import { IPromptsService } from '../promptSyntax/service/promptsService.js';
-import { ChatRequestHooks } from '../promptSyntax/hookSchema.js';
+import { ChatRequestHooks, mergeHooks } from '../promptSyntax/hookSchema.js';
 
 const serializedChatKey = 'interactive.sessions';
 
@@ -959,6 +959,20 @@ export class ChatService extends Disposable implements IChatService {
 				this.logService.warn('[ChatService] Failed to collect hooks:', error);
 			}
 
+			// Merge hooks from the selected custom agent's frontmatter (if any)
+			const agentName = options?.modeInfo?.modeInstructions?.name;
+			if (agentName) {
+				try {
+					const agents = await this.promptsService.getCustomAgents(token, model.sessionResource);
+					const customAgent = agents.find(a => a.name === agentName);
+					if (customAgent?.hooks) {
+						collectedHooks = mergeHooks(collectedHooks, customAgent.hooks);
+					}
+				} catch (error) {
+					this.logService.warn('[ChatService] Failed to collect agent hooks:', error);
+				}
+			}
+
 			const stopWatch = new StopWatch(false);
 			store.add(token.onCancellationRequested(() => {
 				this.trace('sendRequest', `Request for session ${model.sessionResource} was cancelled`);