@machina.ai/cell-cli 1.49.0-rc4 → 1.49.0-rc6

package/dist/src/config/settings.test.js

@@ -45,7 +45,7 @@ import stripJsonComments from 'strip-json-comments'; // Will be mocked separatel
 import { isWorkspaceTrusted } from './trustedFolders.js';
 // These imports will get the versions from the vi.mock('./settings.js', ...) factory.
 import { loadSettings, USER_SETTINGS_PATH, // This IS the mocked path.
-getSystemSettingsPath, getSystemDefaultsPath, saveSettings, getDefaultsFromSchema, loadEnvironment, migrateDeprecatedSettings, SettingScope, LoadedSettings, sanitizeEnvVar, createTestMergedSettings, resetSettingsCacheForTesting, } from './settings.js';
+getSystemSettingsPath, getSystemDefaultsPath, saveSettings, getDefaultsFromSchema, loadEnvironment, migrateDeprecatedSettings, enforceAgentsMdSetting, SettingScope, LoadedSettings, sanitizeEnvVar, createTestMergedSettings, resetSettingsCacheForTesting, } from './settings.js';
 import { FatalConfigError, CELL_DIR, AuthType, Storage, } from '@google/gemini-cli-core';
 import { updateSettingsFilePreservingFormat } from '../utils/commentJson.js';
 import { getSettingsSchema, MergeStrategy, } from './settingsSchema.js';
@@ -204,13 +204,41 @@ describe('Settings Loading and Merging', () => {
                     },
                 },
             };
-            if (scope === 'user') {
-                expect(settings.user.settings).toEqual(expectedWithAuth);
+            const expectedWithMerged = structuredClone(expectedWithAuth);
+            if (expectedWithMerged.context?.fileName) {
+                const fn = expectedWithMerged.context.fileName;
+                expectedWithMerged.context.fileName = Array.isArray(fn)
+                    ? fn.includes('AGENTS.md')
+                        ? fn
+                        : ['AGENTS.md', ...fn]
+                    : fn === 'AGENTS.md'
+                        ? fn
+                        : ['AGENTS.md', fn];
             }
             else {
-                expect(settings[scope].settings).toEqual(content);
+                if (!expectedWithMerged.context) {
+                    expectedWithMerged.context = {};
+                }
+                expectedWithMerged.context.fileName = ['AGENTS.md', 'GEMINI.md'];
+            }
+            const expectedScopeSettings = structuredClone(scope === 'user' ? expectedWithAuth : content);
+            if (scope === 'user' || scope === 'workspace') {
+                if (!expectedScopeSettings.context) {
+                    expectedScopeSettings.context = {};
+                }
+                const fn = expectedScopeSettings.context.fileName;
+                expectedScopeSettings.context.fileName = fn
+                    ? Array.isArray(fn)
+                        ? fn.includes('AGENTS.md')
+                            ? fn
+                            : ['AGENTS.md', ...fn]
+                        : fn === 'AGENTS.md'
+                            ? fn
+                            : ['AGENTS.md', fn]
+                    : ['AGENTS.md', 'GEMINI.md'];
             }
-            expect(settings.merged).toMatchObject(expectedWithAuth);
+            expect(settings[scope].settings).toEqual(expectedScopeSettings);
+            expect(settings.merged).toMatchObject(expectedWithMerged);
         });
         it('should merge system, user and workspace settings, with system taking precedence over workspace, and workspace over user', () => {
             mockFsExistsSync.mockImplementation((p) => {
@@ -268,13 +296,22 @@ describe('Settings Loading and Merging', () => {
             expect(settings.system.settings).toEqual(systemSettingsContent);
             expect(settings.user.settings).toEqual({
                 ...userSettingsContent,
+                context: {
+                    fileName: ['AGENTS.md', 'USER_CONTEXT.md'],
+                },
                 security: {
                     auth: {
                         selectedType: AuthType.KEYCLOAK,
                     },
                 },
             });
-            expect(settings.workspace.settings).toEqual(workspaceSettingsContent);
+            expect(settings.workspace.settings).toEqual({
+                ...workspaceSettingsContent,
+                context: {
+                    ...workspaceSettingsContent.context,
+                    fileName: ['AGENTS.md', 'WORKSPACE_CONTEXT.md'],
+                },
+            });
             expect(settings.merged).toMatchObject({
                 ui: {
                     theme: 'system-theme',
@@ -285,7 +322,7 @@ describe('Settings Loading and Merging', () => {
                 },
                 telemetry: { enabled: false },
                 context: {
-                    fileName: 'WORKSPACE_CONTEXT.md',
+                    fileName: ['AGENTS.md', 'WORKSPACE_CONTEXT.md'],
                 },
                 mcp: {
                     allowed: ['server1', 'server2'],
@@ -407,13 +444,23 @@ describe('Settings Loading and Merging', () => {
             expect(settings.system.settings).toEqual(systemSettingsContent);
             expect(settings.user.settings).toEqual({
                 ...userSettingsContent,
+                context: {
+                    ...userSettingsContent.context,
+                    fileName: ['AGENTS.md', 'USER_CONTEXT.md'],
+                },
                 security: {
                     auth: {
                         selectedType: AuthType.KEYCLOAK,
                     },
                 },
             });
-            expect(settings.workspace.settings).toEqual(workspaceSettingsContent);
+            expect(settings.workspace.settings).toEqual({
+                ...workspaceSettingsContent,
+                context: {
+                    ...workspaceSettingsContent.context,
+                    fileName: ['AGENTS.md', 'WORKSPACE_CONTEXT.md'],
+                },
+            });
             expect(settings.merged).toEqual({
                 context: {
                     discoveryMaxDirs: 200,
@@ -424,7 +471,7 @@ describe('Settings Loading and Merging', () => {
                         '/workspace/dir',
                         '/system/dir',
                     ],
-                    fileName: 'WORKSPACE_CONTEXT.md',
+                    fileName: ['AGENTS.md', 'WORKSPACE_CONTEXT.md'],
                 },
                 mcpServers: {},
                 ui: { theme: 'system-theme' },
@@ -619,13 +666,19 @@ describe('Settings Loading and Merging', () => {
                 description: 'contextFileName in user settings',
                 path: USER_SETTINGS_PATH,
                 content: { context: { fileName: 'CUSTOM.md' } },
-                expected: { key: 'context.fileName', value: 'CUSTOM.md' },
+                expected: {
+                    key: 'context.fileName',
+                    value: ['AGENTS.md', 'CUSTOM.md'],
+                },
             },
             {
                 description: 'contextFileName in workspace settings',
                 path: MOCK_WORKSPACE_SETTINGS_PATH,
                 content: { context: { fileName: 'PROJECT_SPECIFIC.md' } },
-                expected: { key: 'context.fileName', value: 'PROJECT_SPECIFIC.md' },
+                expected: {
+                    key: 'context.fileName',
+                    value: ['AGENTS.md', 'PROJECT_SPECIFIC.md'],
+                },
             },
             {
                 description: 'excludedProjectEnvVars in user settings',
@@ -701,7 +754,7 @@ describe('Settings Loading and Merging', () => {
                 'WORKSPACE_VAR',
             ]);
         });
-        it('should default contextFileName to undefined if not in any settings file', () => {
+        it('should default contextFileName to include AGENTS.md and GEMINI.md if not in any settings file', () => {
             mockFsExistsSync.mockImplementation((p) => normalizePath(p) === normalizePath(USER_SETTINGS_PATH) ||
                 normalizePath(p) === normalizePath(MOCK_WORKSPACE_SETTINGS_PATH));
             const userSettingsContent = { ui: { theme: 'dark' } };
@@ -714,7 +767,10 @@ describe('Settings Loading and Merging', () => {
                 return '';
             });
             const settings = loadSettings(MOCK_WORKSPACE_DIR);
-            expect(settings.merged.context?.fileName).toBeUndefined();
+            expect(settings.merged.context?.fileName).toEqual([
+                'AGENTS.md',
+                'GEMINI.md',
+            ]);
         });
         it.each([
             {
@@ -1631,7 +1687,10 @@ describe('Settings Loading and Merging', () => {
             });
             const settings = loadSettings(MOCK_WORKSPACE_DIR);
             expect(settings.merged.tools?.sandbox).toBe(true);
-            expect(settings.merged.context?.fileName).toBe('WORKSPACE.md');
+            expect(settings.merged.context?.fileName).toEqual([
+                'AGENTS.md',
+                'WORKSPACE.md',
+            ]);
             expect(settings.merged.ui?.theme).toBe('dark');
         });
         it('should NOT merge workspace settings when workspace is not trusted', () => {
@@ -1658,7 +1717,10 @@ describe('Settings Loading and Merging', () => {
             });
             const settings = loadSettings(MOCK_WORKSPACE_DIR);
             expect(settings.merged.tools?.sandbox).toBe(false); // User setting
-            expect(settings.merged.context?.fileName).toBe('USER.md'); // User setting
+            expect(settings.merged.context?.fileName).toEqual([
+                'AGENTS.md',
+                'USER.md',
+            ]); // User setting
             expect(settings.merged.ui?.theme).toBe('dark'); // User setting
         });
         it('should NOT merge workspace settings when workspace trust is undefined', () => {
@@ -1685,7 +1747,10 @@ describe('Settings Loading and Merging', () => {
             });
             const settings = loadSettings(MOCK_WORKSPACE_DIR);
             expect(settings.merged.tools?.sandbox).toBe(false); // User setting
-            expect(settings.merged.context?.fileName).toBe('USER.md'); // User setting
+            expect(settings.merged.context?.fileName).toEqual([
+                'AGENTS.md',
+                'USER.md',
+            ]); // User setting
         });
     });
     describe('loadEnvironment', () => {
@@ -2144,6 +2209,86 @@ describe('Settings Loading and Merging', () => {
             });
         });
     });
+    describe('enforceAgentsMdSetting', () => {
+        let mockFsExistsSync;
+        beforeEach(() => {
+            vi.resetAllMocks();
+            mockFsExistsSync = vi.mocked(fs.existsSync);
+            vi.spyOn(trustedFolders, 'isWorkspaceTrusted').mockReturnValue({
+                isTrusted: true,
+                source: undefined,
+            });
+        });
+        afterEach(() => {
+            vi.restoreAllMocks();
+        });
+        it('should do nothing if context or context.fileName is missing from existing file', () => {
+            const userSettingsContent = { ui: { theme: 'dark' } };
+            mockFsExistsSync.mockReturnValue(true);
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = false;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).not.toHaveBeenCalled();
+        });
+        it('should migrate context.fileName from custom string to array starting with AGENTS.md', () => {
+            const userSettingsContent = { context: { fileName: 'CUSTOM.md' } };
+            mockFsExistsSync.mockReturnValue(true);
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = false;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).toHaveBeenCalledWith(SettingScope.User, 'context', expect.objectContaining({ fileName: ['AGENTS.md', 'CUSTOM.md'] }));
+        });
+        it('should prepend AGENTS.md if context.fileName is an array not containing agents.md', () => {
+            const userSettingsContent = {
+                context: { fileName: ['PROJECT.md', 'OTHER.md'] },
+            };
+            mockFsExistsSync.mockReturnValue(true);
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = false;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).toHaveBeenCalledWith(SettingScope.User, 'context', expect.objectContaining({
+                fileName: ['AGENTS.md', 'PROJECT.md', 'OTHER.md'],
+            }));
+        });
+        it('should not do anything if AGENTS.md is already in context.fileName array', () => {
+            const userSettingsContent = {
+                context: { fileName: ['AGENTS.md', 'GEMINI.md'] },
+            };
+            mockFsExistsSync.mockReturnValue(true);
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = false;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).not.toHaveBeenCalled();
+        });
+        it('should not mutate files if settingsFile is read-only', () => {
+            const userSettingsContent = { context: { fileName: 'CUSTOM.md' } };
+            mockFsExistsSync.mockReturnValue(true);
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = true;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).not.toHaveBeenCalled();
+        });
+        it('should not do anything if settings file does not physically exist', () => {
+            const userSettingsContent = { context: { fileName: 'CUSTOM.md' } };
+            mockFsExistsSync.mockReturnValue(false); // File does not exist on disk
+            const loadedSettings = createMockSettings(userSettingsContent);
+            loadedSettings.user.path = USER_SETTINGS_PATH;
+            loadedSettings.user.readOnly = false;
+            const setValueSpy = vi.spyOn(loadedSettings, 'setValue');
+            enforceAgentsMdSetting(loadedSettings);
+            expect(setValueSpy).not.toHaveBeenCalled();
+        });
+    });
     describe('saveSettings', () => {
         it('should save settings using updateSettingsFilePreservingFormat', () => {
             const mockUpdateSettings = vi.mocked(updateSettingsFilePreservingFormat);