feat(cli): align hooks enable/disable with skills and improve completion (#16822)

2026-04-22 19:14:33 -07:00 · 2026-01-27 20:56:06 -05:00
parent 130b596c80
commit 2c09785748
6 changed files with 695 additions and 150 deletions
@@ -0,0 +1,182 @@
+/**
+ * @license
+ * Copyright 2026 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { enableHook, disableHook } from './hookSettings.js';
+import { SettingScope, type LoadedSettings } from '../config/settings.js';
+
+describe('hookSettings', () => {
+  let mockSettings: LoadedSettings;
+  let mockUser: {
+    path: string;
+    settings: { hooksConfig: { disabled: string[] } };
+  };
+  let mockWorkspace: {
+    path: string;
+    settings: { hooksConfig: { disabled: string[] } };
+  };
+  let mockSetValue: ReturnType<typeof vi.fn>;
+
+  beforeEach(() => {
+    mockUser = {
+      path: '/mock/user.json',
+      settings: { hooksConfig: { disabled: [] } },
+    };
+    mockWorkspace = {
+      path: '/mock/workspace.json',
+      settings: { hooksConfig: { disabled: [] } },
+    };
+    mockSetValue = vi.fn();
+
+    mockSettings = {
+      forScope: (scope: SettingScope) => {
+        if (scope === SettingScope.User) return mockUser;
+        if (scope === SettingScope.Workspace) return mockWorkspace;
+        return mockUser; // Default/Fallback
+      },
+      setValue: mockSetValue,
+    } as unknown as LoadedSettings;
+  });
+
+  describe('enableHook', () => {
+    it('should return no-op if hook is not disabled in any scope', () => {
+      const result = enableHook(mockSettings, 'test-hook');
+
+      expect(result.status).toBe('no-op');
+      expect(result.action).toBe('enable');
+      expect(result.modifiedScopes).toHaveLength(0);
+      expect(result.alreadyInStateScopes).toHaveLength(2); // User + Workspace
+      expect(mockSetValue).not.toHaveBeenCalled();
+    });
+
+    it('should enable hook in User scope if disabled there', () => {
+      mockUser.settings.hooksConfig.disabled = ['test-hook'];
+
+      const result = enableHook(mockSettings, 'test-hook');
+
+      expect(result.status).toBe('success');
+      expect(result.modifiedScopes).toEqual([
+        { scope: SettingScope.User, path: '/mock/user.json' },
+      ]);
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.User,
+        'hooksConfig.disabled',
+        [],
+      );
+    });
+
+    it('should enable hook in Workspace scope if disabled there', () => {
+      mockWorkspace.settings.hooksConfig.disabled = ['test-hook'];
+
+      const result = enableHook(mockSettings, 'test-hook');
+
+      expect(result.status).toBe('success');
+      expect(result.modifiedScopes).toEqual([
+        { scope: SettingScope.Workspace, path: '/mock/workspace.json' },
+      ]);
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.Workspace,
+        'hooksConfig.disabled',
+        [],
+      );
+    });
+
+    it('should enable hook in BOTH scopes if disabled in both', () => {
+      mockUser.settings.hooksConfig.disabled = ['test-hook', 'other'];
+      mockWorkspace.settings.hooksConfig.disabled = ['test-hook'];
+
+      const result = enableHook(mockSettings, 'test-hook');
+
+      expect(result.status).toBe('success');
+      expect(result.modifiedScopes).toHaveLength(2);
+      expect(result.modifiedScopes).toContainEqual({
+        scope: SettingScope.User,
+        path: '/mock/user.json',
+      });
+      expect(result.modifiedScopes).toContainEqual({
+        scope: SettingScope.Workspace,
+        path: '/mock/workspace.json',
+      });
+
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.Workspace,
+        'hooksConfig.disabled',
+        [],
+      );
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.User,
+        'hooksConfig.disabled',
+        ['other'],
+      );
+    });
+  });
+
+  describe('disableHook', () => {
+    it('should disable hook in the requested scope', () => {
+      const result = disableHook(
+        mockSettings,
+        'test-hook',
+        SettingScope.Workspace,
+      );
+
+      expect(result.status).toBe('success');
+      expect(result.modifiedScopes).toEqual([
+        { scope: SettingScope.Workspace, path: '/mock/workspace.json' },
+      ]);
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.Workspace,
+        'hooksConfig.disabled',
+        ['test-hook'],
+      );
+    });
+
+    it('should return no-op if already disabled in requested scope', () => {
+      mockWorkspace.settings.hooksConfig.disabled = ['test-hook'];
+
+      const result = disableHook(
+        mockSettings,
+        'test-hook',
+        SettingScope.Workspace,
+      );
+
+      expect(result.status).toBe('no-op');
+      expect(mockSetValue).not.toHaveBeenCalled();
+    });
+
+    it('should disable in requested scope and report if already disabled in other scope', () => {
+      // User has it disabled
+      mockUser.settings.hooksConfig.disabled = ['test-hook'];
+
+      // We request disable in Workspace
+      const result = disableHook(
+        mockSettings,
+        'test-hook',
+        SettingScope.Workspace,
+      );
+
+      expect(result.status).toBe('success');
+      expect(result.modifiedScopes).toEqual([
+        { scope: SettingScope.Workspace, path: '/mock/workspace.json' },
+      ]);
+      expect(result.alreadyInStateScopes).toEqual([
+        { scope: SettingScope.User, path: '/mock/user.json' },
+      ]);
+      expect(mockSetValue).toHaveBeenCalledWith(
+        SettingScope.Workspace,
+        'hooksConfig.disabled',
+        ['test-hook'],
+      );
+    });
+
+    it('should return error if invalid scope provided', () => {
+      // @ts-expect-error - Testing runtime check
+      const result = disableHook(mockSettings, 'test-hook', 'InvalidScope');
+
+      expect(result.status).toBe('error');
+      expect(result.error).toContain('Invalid settings scope');
+    });
+  });
+});