Ignore folders files (#651)
# Add .gitignore-Aware File Filtering to gemini-cli This pull request introduces .gitignore-based file filtering to the gemini-cli, ensuring that git-ignored files are automatically excluded from file-related operations and suggestions throughout the CLI. The update enhances usability, reduces noise from build artifacts and dependencies, and provides new configuration options for fine-tuning file discovery. Key Improvements .gitignore File Filtering All @ (at) commands, file completions, and core discovery tools now honor .gitignore patterns by default. Git-ignored files (such as node_modules/, dist/, .env, and .git) are excluded from results unless explicitly overridden. The behavior can be customized via a new fileFiltering section in settings.json, including options for: Turning .gitignore respect on/off. Adding custom ignore patterns. Allowing or excluding build artifacts. Configuration & Documentation Updates settings.json schema extended with fileFiltering options. Documentation updated to explain new filtering controls and usage patterns. Testing New and updated integration/unit tests for file filtering logic, configuration merging, and edge cases. Test coverage ensures .gitignore filtering works as intended across different workflows. Internal Refactoring Core file discovery logic refactored for maintainability and extensibility. Underlying tools (ls, glob, read-many-files) now support git-aware filtering out of the box. Co-authored-by: N. Taylor Mullen <ntaylormullen@google.com>
This commit is contained in:
Keith Ballinger
GitHub
parent
d85f09ac51
commit
c313762ba0
|
|
@ -43,7 +43,7 @@ Slash commands provide meta-level control over the CLI itself. They can typicall
|
|||
|
||||
## At Commands (`@`)
|
||||
|
||||
At commands are used to quickly include the content of files or directories as part of your prompt to Gemini.
|
||||
At commands are used to quickly include the content of files or directories as part of your prompt to Gemini. These commands now feature git-aware filtering.
|
||||
|
||||
- **`@<path_to_file_or_directory>`**
|
||||
|
||||
|
|
@ -58,6 +58,7 @@ At commands are used to quickly include the content of files or directories as p
|
|||
- Spaces in paths should be escaped with a backslash (e.g., `@My\ Documents/file.txt`).
|
||||
- The command uses the `read_many_files` tool internally. The content is fetched and then prepended or inserted into your query before being sent to the Gemini model.
|
||||
- The text before and after the `@<path>` part of your query is preserved and sent along with the file content.
|
||||
- **Git-Aware Filtering:** By default, git-ignored files (like `node_modules/`, `dist/`, `.env`, `.git/`) are automatically excluded. This behavior can be configured via the `fileFiltering` settings.
|
||||
- **File Types:** The command is intended for text-based files. While it might attempt to read any file, binary files or very large files might be skipped or truncated by the underlying `read_many_files` tool to ensure performance and relevance. The tool will typically indicate if files were skipped.
|
||||
- **Output:** The CLI will show a tool call message indicating that `read_many_files` was used, along with an improved display message detailing the status (e.g., number of files read, total size) and the path(s) that were processed.
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,22 @@ When you create a `.gemini/settings.json` file for project-specific settings, or
|
|||
- **Default:** `GEMINI.md`
|
||||
- **Example:** `"contextFileName": "AGENTS.md"`
|
||||
|
||||
- **`fileFiltering`** (object, optional):
|
||||
|
||||
- **Description:** Controls git-aware file filtering behavior for @ commands and file discovery tools.
|
||||
- **Properties:**
|
||||
- **`respectGitIgnore`** (boolean, default: `true`): Whether to respect .gitignore patterns when discovering files. When enabled, git-ignored files (like `node_modules/`, `dist/`, `.env`) are automatically excluded from @ commands and file listing operations.
|
||||
- **`customIgnorePatterns`** (array of strings, default: `[]`): Additional patterns to ignore beyond git-ignored files. Useful for excluding specific directories or file types.
|
||||
- **`allowBuildArtifacts`** (boolean, default: `false`): Whether to include build artifacts and generated files in file discovery operations.
|
||||
- **Example:**
|
||||
```json
|
||||
"fileFiltering": {
|
||||
"respectGitIgnore": true,
|
||||
"customIgnorePatterns": ["temp/", "*.log"],
|
||||
"allowBuildArtifacts": false
|
||||
}
|
||||
```
|
||||
|
||||
- **`coreTools`** (array of strings, optional):
|
||||
- **Description:** Allows you to specify a list of core tool names that should be made available to the model. This can be used to restrict or customize the set of built-in tools.
|
||||
- **Example:** `"coreTools": ["ReadFileTool", "GlobTool", "SearchText"]`.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,113 @@
|
|||
# PR #651 Test Failures - Investigation and Fixes
|
||||
|
||||
## Summary
|
||||
|
||||
Fixed test failures in PR #651 "Ignore folders files" that were preventing CI from passing. All tests now pass successfully.
|
||||
|
||||
## Issues Found and Fixed
|
||||
|
||||
### 1. ShellTool Constructor URL Error (9 test failures)
|
||||
|
||||
**Problem**:
|
||||
|
||||
- Tests in `src/config/config.integration.test.ts` were failing with "The URL must be of scheme file" error
|
||||
- Error occurred at line 39 in `packages/core/src/tools/shell.ts`
|
||||
- The ShellTool constructor was trying to create URLs using `import.meta.url` which is not a valid file URL in test environments
|
||||
|
||||
**Root Cause**:
|
||||
|
||||
- The original code directly called `new URL('shell.md', import.meta.url)` without error handling
|
||||
- In test environments, `import.meta.url` may not be a proper file:// URL
|
||||
- There were incomplete changes already in the file attempting to fix this, but the fix was flawed
|
||||
|
||||
**Solution**:
|
||||
|
||||
- Added proper try-catch error handling around URL creation and file reading
|
||||
- Created fallback schema and description for test environments
|
||||
- Moved URL creation inside the try block to be properly caught
|
||||
- Fixed linting error by changing `any` type to `object` for `toolParameterSchema`
|
||||
|
||||
**Files Changed**:
|
||||
|
||||
- `packages/core/src/tools/shell.ts`
|
||||
|
||||
### 2. atCommandProcessor Test Parameter Mismatch (1 test failure)
|
||||
|
||||
**Problem**:
|
||||
|
||||
- Test "should process a file path case-insensitively" in `atCommandProcessor.test.ts` was failing
|
||||
- Expected tool call with `{ paths: [queryPath] }` but actual call included `respectGitIgnore: true` parameter
|
||||
|
||||
**Root Cause**:
|
||||
|
||||
- The implementation was updated to include `respectGitIgnore` parameter as part of the file filtering functionality
|
||||
- The test expectation wasn't updated to match the new implementation
|
||||
- This is a legitimate behavior change - the atCommandProcessor now passes git ignore settings to tools
|
||||
|
||||
**Solution**:
|
||||
|
||||
- Updated test expectation to include `respectGitIgnore: true` parameter
|
||||
- This aligns the test with the actual implementation behavior
|
||||
|
||||
**Files Changed**:
|
||||
|
||||
- `packages/cli/src/ui/hooks/atCommandProcessor.test.ts`
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### ShellTool Fix
|
||||
|
||||
```typescript
|
||||
// Before (failing)
|
||||
const descriptionUrl = new URL('shell.md', import.meta.url);
|
||||
const toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
||||
|
||||
// After (working)
|
||||
try {
|
||||
const descriptionUrl = new URL('shell.md', import.meta.url);
|
||||
toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
||||
// ... similar for schema
|
||||
} catch {
|
||||
// Fallback for test environments
|
||||
toolDescription = 'Execute shell commands';
|
||||
toolParameterSchema = {
|
||||
/* minimal schema */
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### atCommandProcessor Test Fix
|
||||
|
||||
```typescript
|
||||
// Before (failing)
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [queryPath] },
|
||||
abortController.signal,
|
||||
);
|
||||
|
||||
// After (working)
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [queryPath], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
- All tests now pass locally
|
||||
- Fixed linting errors (removed `any` type usage)
|
||||
- Code properly formatted with Prettier
|
||||
- Committed changes and pushed to remote
|
||||
|
||||
## Key Learnings
|
||||
|
||||
1. **Test Environment Differences**: Test environments may have different behavior for ES modules and `import.meta.url`
|
||||
2. **Feature Integration**: When adding new features (like file filtering), all related tests need to be updated to match new parameter expectations
|
||||
3. **Error Handling**: Always add proper fallbacks for file system operations that might fail in different environments
|
||||
4. **Incremental Development**: Incomplete fixes can sometimes make problems worse - it's important to complete the error handling logic properly
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Monitor CI to ensure tests continue passing
|
||||
- Consider if any other tools might have similar `import.meta.url` issues
|
||||
- Verify that the file filtering functionality works as expected in real usage
|
||||
|
|
@ -1621,6 +1621,13 @@
|
|||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@types/minimatch": {
|
||||
"version": "5.1.2",
|
||||
"resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz",
|
||||
"integrity": "sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@types/node": {
|
||||
"version": "20.17.57",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.57.tgz",
|
||||
|
|
@ -2481,7 +2488,6 @@
|
|||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
|
||||
"integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/base64-js": {
|
||||
|
|
@ -9553,18 +9559,44 @@
|
|||
"diff": "^7.0.0",
|
||||
"dotenv": "^16.4.7",
|
||||
"fast-glob": "^3.3.3",
|
||||
"minimatch": "^10.0.0",
|
||||
"shell-quote": "^1.8.2",
|
||||
"strip-ansi": "^7.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/diff": "^7.0.2",
|
||||
"@types/dotenv": "^6.1.1",
|
||||
"@types/minimatch": "^5.1.2",
|
||||
"typescript": "^5.3.3",
|
||||
"vitest": "^3.1.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
}
|
||||
},
|
||||
"packages/core/node_modules/brace-expansion": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
|
||||
"integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"balanced-match": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"packages/core/node_modules/minimatch": {
|
||||
"version": "10.0.1",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz",
|
||||
"integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"brace-expansion": "^2.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": "20 || >=22"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/isaacs"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,213 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { tmpdir } from 'os';
|
||||
import { Config, ConfigParameters } from '@gemini-code/core';
|
||||
|
||||
// Mock file discovery service and tool registry
|
||||
vi.mock('@gemini-code/core', async () => {
|
||||
const actual = await vi.importActual('@gemini-code/core');
|
||||
return {
|
||||
...actual,
|
||||
FileDiscoveryService: vi.fn().mockImplementation(() => ({
|
||||
initialize: vi.fn(),
|
||||
})),
|
||||
createToolRegistry: vi.fn().mockResolvedValue({}),
|
||||
};
|
||||
});
|
||||
|
||||
describe('Configuration Integration Tests', () => {
|
||||
let tempDir: string;
|
||||
let originalEnv: NodeJS.ProcessEnv;
|
||||
|
||||
beforeEach(() => {
|
||||
tempDir = fs.mkdtempSync(path.join(tmpdir(), 'gemini-cli-test-'));
|
||||
originalEnv = { ...process.env };
|
||||
process.env.GEMINI_API_KEY = 'test-api-key';
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
process.env = originalEnv;
|
||||
if (fs.existsSync(tempDir)) {
|
||||
fs.rmSync(tempDir, { recursive: true });
|
||||
}
|
||||
});
|
||||
|
||||
describe('File Filtering Configuration', () => {
|
||||
it('should load default file filtering settings', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: undefined, // Should default to true
|
||||
fileFilteringAllowBuildArtifacts: undefined, // Should default to false
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
|
||||
it('should load custom file filtering settings from configuration', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: false,
|
||||
fileFilteringAllowBuildArtifacts: true,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(false);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(true);
|
||||
});
|
||||
|
||||
it('should merge user and workspace file filtering settings', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: true,
|
||||
fileFilteringAllowBuildArtifacts: true,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(true);
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Configuration Integration', () => {
|
||||
it('should handle partial configuration objects gracefully', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: false,
|
||||
fileFilteringAllowBuildArtifacts: undefined, // Should default to false
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
// Specified settings should be applied
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(false);
|
||||
|
||||
// Missing settings should use defaults
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle empty configuration objects gracefully', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: undefined,
|
||||
fileFilteringAllowBuildArtifacts: undefined,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
// All settings should use defaults
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle missing configuration sections gracefully', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
// Missing fileFiltering configuration
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
// All git-aware settings should use defaults
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Real-world Configuration Scenarios', () => {
|
||||
it('should handle a security-focused configuration', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: true,
|
||||
fileFilteringAllowBuildArtifacts: false,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle a development-focused configuration', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: true,
|
||||
fileFilteringAllowBuildArtifacts: true,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle a CI/CD environment configuration', async () => {
|
||||
const configParams: ConfigParameters = {
|
||||
apiKey: 'test-key',
|
||||
model: 'test-model',
|
||||
sandbox: false,
|
||||
targetDir: tempDir,
|
||||
debugMode: false,
|
||||
userAgent: 'test-agent',
|
||||
fileFilteringRespectGitIgnore: false, // CI might need to see all files
|
||||
fileFilteringAllowBuildArtifacts: true,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(false);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -214,6 +214,10 @@ export async function loadCliConfig(
|
|||
vertexai: useVertexAI,
|
||||
showMemoryUsage:
|
||||
argv.show_memory_usage || settings.showMemoryUsage || false,
|
||||
// Git-aware file filtering settings
|
||||
fileFilteringRespectGitIgnore: settings.fileFiltering?.respectGitIgnore,
|
||||
fileFilteringAllowBuildArtifacts:
|
||||
settings.fileFiltering?.allowBuildArtifacts,
|
||||
};
|
||||
|
||||
const config = createServerConfig(configParams);
|
||||
|
|
|
|||
|
|
@ -32,6 +32,13 @@ export interface Settings {
|
|||
showMemoryUsage?: boolean;
|
||||
contextFileName?: string;
|
||||
title?: string;
|
||||
|
||||
// Git-aware file filtering settings
|
||||
fileFiltering?: {
|
||||
respectGitIgnore?: boolean;
|
||||
allowBuildArtifacts?: boolean;
|
||||
};
|
||||
|
||||
// Add other settings here.
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -60,6 +60,9 @@ async function main() {
|
|||
const { config, modelWasSwitched, originalModelBeforeSwitch, finalModel } =
|
||||
await loadCliConfig(settings.merged);
|
||||
|
||||
// Initialize centralized FileDiscoveryService
|
||||
await config.getFileService();
|
||||
|
||||
if (modelWasSwitched && originalModelBeforeSwitch) {
|
||||
console.log(
|
||||
`[INFO] Your configured model (${originalModelBeforeSwitch}) was temporarily unavailable. Switched to ${finalModel} for this session.`,
|
||||
|
|
|
|||
|
|
@ -68,6 +68,7 @@ export const InputPrompt: React.FC<InputPromptProps> = ({
|
|||
config.getTargetDir(),
|
||||
isAtCommand(buffer.text) || isSlashCommand(buffer.text),
|
||||
slashCommands,
|
||||
config,
|
||||
);
|
||||
|
||||
const resetCompletionState = completion.resetCompletionState;
|
||||
|
|
|
|||
|
|
@ -5,8 +5,9 @@
|
|||
*/
|
||||
|
||||
import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest';
|
||||
import type { Mocked } from 'vitest';
|
||||
import { handleAtCommand } from './atCommandProcessor.js';
|
||||
import { Config } from '@gemini-code/core';
|
||||
import { Config, FileDiscoveryService } from '@gemini-code/core';
|
||||
import { ToolCallStatus } from '../types.js';
|
||||
import { UseHistoryManagerReturn } from './useHistoryManager.js';
|
||||
import * as fsPromises from 'fs/promises';
|
||||
|
|
@ -18,6 +19,9 @@ const mockConfig = {
|
|||
getToolRegistry: mockGetToolRegistry,
|
||||
getTargetDir: mockGetTargetDir,
|
||||
isSandboxed: vi.fn(() => false),
|
||||
getFileService: vi.fn(),
|
||||
getFileFilteringRespectGitIgnore: vi.fn(() => true),
|
||||
getFileFilteringAllowBuildArtifacts: vi.fn(() => false),
|
||||
} as unknown as Config;
|
||||
|
||||
const mockReadManyFilesExecute = vi.fn();
|
||||
|
|
@ -48,8 +52,17 @@ vi.mock('fs/promises', async () => {
|
|||
};
|
||||
});
|
||||
|
||||
vi.mock('@gemini-code/core', async () => {
|
||||
const actual = await vi.importActual('@gemini-code/core');
|
||||
return {
|
||||
...actual,
|
||||
FileDiscoveryService: vi.fn(),
|
||||
};
|
||||
});
|
||||
|
||||
describe('handleAtCommand', () => {
|
||||
let abortController: AbortController;
|
||||
let mockFileDiscoveryService: Mocked<FileDiscoveryService>;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.resetAllMocks();
|
||||
|
|
@ -73,6 +86,23 @@ describe('handleAtCommand', () => {
|
|||
llmContent: 'No files found',
|
||||
returnDisplay: '',
|
||||
});
|
||||
|
||||
// Mock FileDiscoveryService
|
||||
mockFileDiscoveryService = {
|
||||
initialize: vi.fn(),
|
||||
shouldIgnoreFile: vi.fn(() => false),
|
||||
filterFiles: vi.fn((files) => files),
|
||||
getIgnoreInfo: vi.fn(() => ({ gitIgnored: [], customIgnored: [] })),
|
||||
isGitRepository: vi.fn(() => true),
|
||||
};
|
||||
vi.mocked(FileDiscoveryService).mockImplementation(
|
||||
() => mockFileDiscoveryService,
|
||||
);
|
||||
|
||||
// Mock getFileService to return the mocked FileDiscoveryService
|
||||
mockConfig.getFileService = vi
|
||||
.fn()
|
||||
.mockResolvedValue(mockFileDiscoveryService);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
|
|
@ -143,7 +173,7 @@ ${fileContent}`,
|
|||
125,
|
||||
);
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [filePath] },
|
||||
{ paths: [filePath], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(mockAddItem).toHaveBeenCalledWith(
|
||||
|
|
@ -191,7 +221,7 @@ ${fileContent}`,
|
|||
126,
|
||||
);
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [resolvedGlob] },
|
||||
{ paths: [resolvedGlob], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
|
|
@ -295,7 +325,7 @@ ${fileContent}`,
|
|||
signal: abortController.signal,
|
||||
});
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [unescapedPath] },
|
||||
{ paths: [unescapedPath], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
});
|
||||
|
|
@ -325,7 +355,7 @@ ${content2}`,
|
|||
signal: abortController.signal,
|
||||
});
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [file1, file2] },
|
||||
{ paths: [file1, file2], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(result.processedQuery).toEqual([
|
||||
|
|
@ -368,7 +398,7 @@ ${content2}`,
|
|||
signal: abortController.signal,
|
||||
});
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [file1, file2] },
|
||||
{ paths: [file1, file2], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(result.processedQuery).toEqual([
|
||||
|
|
@ -434,7 +464,7 @@ ${content2}`,
|
|||
});
|
||||
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [file1, resolvedFile2] },
|
||||
{ paths: [file1, resolvedFile2], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(result.processedQuery).toEqual([
|
||||
|
|
@ -538,7 +568,7 @@ ${fileContent}`,
|
|||
// If the mock is simpler, it might use queryPath if stat(queryPath) succeeds.
|
||||
// The most important part is that *some* version of the path that leads to the content is used.
|
||||
// Let's assume it uses the path from the query if stat confirms it exists (even if different case on disk)
|
||||
{ paths: [queryPath] },
|
||||
{ paths: [queryPath], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(mockAddItem).toHaveBeenCalledWith(
|
||||
|
|
@ -557,4 +587,154 @@ ${fileContent}`,
|
|||
]);
|
||||
expect(result.shouldProceed).toBe(true);
|
||||
});
|
||||
|
||||
describe('git-aware filtering', () => {
|
||||
it('should skip git-ignored files in @ commands', async () => {
|
||||
const gitIgnoredFile = 'node_modules/package.json';
|
||||
const query = `@${gitIgnoredFile}`;
|
||||
|
||||
// Mock the file discovery service to report this file as git-ignored
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockImplementation(
|
||||
(path: string) => path === gitIgnoredFile,
|
||||
);
|
||||
|
||||
const result = await handleAtCommand({
|
||||
query,
|
||||
config: mockConfig,
|
||||
addItem: mockAddItem,
|
||||
onDebugMessage: mockOnDebugMessage,
|
||||
messageId: 200,
|
||||
signal: abortController.signal,
|
||||
});
|
||||
|
||||
expect(mockFileDiscoveryService.shouldIgnoreFile).toHaveBeenCalledWith(
|
||||
gitIgnoredFile,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
`Path ${gitIgnoredFile} is git-ignored and will be skipped.`,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
'Ignored 1 git-ignored files: node_modules/package.json',
|
||||
);
|
||||
expect(mockReadManyFilesExecute).not.toHaveBeenCalled();
|
||||
expect(result.processedQuery).toEqual([{ text: query }]);
|
||||
expect(result.shouldProceed).toBe(true);
|
||||
});
|
||||
|
||||
it('should process non-git-ignored files normally', async () => {
|
||||
const validFile = 'src/index.ts';
|
||||
const query = `@${validFile}`;
|
||||
const fileContent = 'console.log("Hello world");';
|
||||
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockReturnValue(false);
|
||||
mockReadManyFilesExecute.mockResolvedValue({
|
||||
llmContent: `
|
||||
--- ${validFile} ---
|
||||
${fileContent}`,
|
||||
returnDisplay: 'Read 1 file.',
|
||||
});
|
||||
|
||||
const result = await handleAtCommand({
|
||||
query,
|
||||
config: mockConfig,
|
||||
addItem: mockAddItem,
|
||||
onDebugMessage: mockOnDebugMessage,
|
||||
messageId: 201,
|
||||
signal: abortController.signal,
|
||||
});
|
||||
|
||||
expect(mockFileDiscoveryService.shouldIgnoreFile).toHaveBeenCalledWith(
|
||||
validFile,
|
||||
);
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [validFile], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(result.processedQuery).toEqual([
|
||||
{ text: `@${validFile}` },
|
||||
{ text: '\n--- Content from referenced files ---' },
|
||||
{ text: `\nContent from @${validFile}:\n` },
|
||||
{ text: fileContent },
|
||||
{ text: '\n--- End of content ---' },
|
||||
]);
|
||||
expect(result.shouldProceed).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle mixed git-ignored and valid files', async () => {
|
||||
const validFile = 'README.md';
|
||||
const gitIgnoredFile = '.env';
|
||||
const query = `@${validFile} @${gitIgnoredFile}`;
|
||||
const fileContent = '# Project README';
|
||||
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockImplementation(
|
||||
(path: string) => path === gitIgnoredFile,
|
||||
);
|
||||
mockReadManyFilesExecute.mockResolvedValue({
|
||||
llmContent: `
|
||||
--- ${validFile} ---
|
||||
${fileContent}`,
|
||||
returnDisplay: 'Read 1 file.',
|
||||
});
|
||||
|
||||
const result = await handleAtCommand({
|
||||
query,
|
||||
config: mockConfig,
|
||||
addItem: mockAddItem,
|
||||
onDebugMessage: mockOnDebugMessage,
|
||||
messageId: 202,
|
||||
signal: abortController.signal,
|
||||
});
|
||||
|
||||
expect(mockFileDiscoveryService.shouldIgnoreFile).toHaveBeenCalledWith(
|
||||
validFile,
|
||||
);
|
||||
expect(mockFileDiscoveryService.shouldIgnoreFile).toHaveBeenCalledWith(
|
||||
gitIgnoredFile,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
`Path ${gitIgnoredFile} is git-ignored and will be skipped.`,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
'Ignored 1 git-ignored files: .env',
|
||||
);
|
||||
expect(mockReadManyFilesExecute).toHaveBeenCalledWith(
|
||||
{ paths: [validFile], respectGitIgnore: true },
|
||||
abortController.signal,
|
||||
);
|
||||
expect(result.processedQuery).toEqual([
|
||||
{ text: `@${validFile} @${gitIgnoredFile}` },
|
||||
{ text: '\n--- Content from referenced files ---' },
|
||||
{ text: `\nContent from @${validFile}:\n` },
|
||||
{ text: fileContent },
|
||||
{ text: '\n--- End of content ---' },
|
||||
]);
|
||||
expect(result.shouldProceed).toBe(true);
|
||||
});
|
||||
|
||||
it('should always ignore .git directory files', async () => {
|
||||
const gitFile = '.git/config';
|
||||
const query = `@${gitFile}`;
|
||||
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockReturnValue(true);
|
||||
|
||||
const result = await handleAtCommand({
|
||||
query,
|
||||
config: mockConfig,
|
||||
addItem: mockAddItem,
|
||||
onDebugMessage: mockOnDebugMessage,
|
||||
messageId: 203,
|
||||
signal: abortController.signal,
|
||||
});
|
||||
|
||||
expect(mockFileDiscoveryService.shouldIgnoreFile).toHaveBeenCalledWith(
|
||||
gitFile,
|
||||
);
|
||||
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
||||
`Path ${gitFile} is git-ignored and will be skipped.`,
|
||||
);
|
||||
expect(mockReadManyFilesExecute).not.toHaveBeenCalled();
|
||||
expect(result.processedQuery).toEqual([{ text: query }]);
|
||||
expect(result.shouldProceed).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -134,9 +134,14 @@ export async function handleAtCommand({
|
|||
|
||||
addItem({ type: 'user', text: query }, userMessageTimestamp);
|
||||
|
||||
// Get centralized file discovery service
|
||||
const fileDiscovery = await config.getFileService();
|
||||
const respectGitIgnore = config.getFileFilteringRespectGitIgnore();
|
||||
|
||||
const pathSpecsToRead: string[] = [];
|
||||
const atPathToResolvedSpecMap = new Map<string, string>();
|
||||
const contentLabelsForDisplay: string[] = [];
|
||||
const ignoredPaths: string[] = [];
|
||||
|
||||
const toolRegistry = await config.getToolRegistry();
|
||||
const readManyFilesTool = toolRegistry.getTool('read_many_files');
|
||||
|
|
@ -176,6 +181,16 @@ export async function handleAtCommand({
|
|||
return { processedQuery: null, shouldProceed: false };
|
||||
}
|
||||
|
||||
// Check if path should be ignored by git
|
||||
if (fileDiscovery.shouldIgnoreFile(pathName)) {
|
||||
const reason = respectGitIgnore
|
||||
? 'git-ignored and will be skipped'
|
||||
: 'ignored by custom patterns';
|
||||
onDebugMessage(`Path ${pathName} is ${reason}.`);
|
||||
ignoredPaths.push(pathName);
|
||||
continue;
|
||||
}
|
||||
|
||||
let currentPathSpec = pathName;
|
||||
let resolvedSuccessfully = false;
|
||||
|
||||
|
|
@ -305,6 +320,14 @@ export async function handleAtCommand({
|
|||
}
|
||||
initialQueryText = initialQueryText.trim();
|
||||
|
||||
// Inform user about ignored paths
|
||||
if (ignoredPaths.length > 0) {
|
||||
const ignoreType = respectGitIgnore ? 'git-ignored' : 'custom-ignored';
|
||||
onDebugMessage(
|
||||
`Ignored ${ignoredPaths.length} ${ignoreType} files: ${ignoredPaths.join(', ')}`,
|
||||
);
|
||||
}
|
||||
|
||||
// Fallback for lone "@" or completely invalid @-commands resulting in empty initialQueryText
|
||||
if (pathSpecsToRead.length === 0) {
|
||||
onDebugMessage('No valid file paths found in @ commands to read.');
|
||||
|
|
@ -324,7 +347,10 @@ export async function handleAtCommand({
|
|||
|
||||
const processedQueryParts: PartUnion[] = [{ text: initialQueryText }];
|
||||
|
||||
const toolArgs = { paths: pathSpecsToRead };
|
||||
const toolArgs = {
|
||||
paths: pathSpecsToRead,
|
||||
respectGitIgnore, // Use configuration setting
|
||||
};
|
||||
let toolCallDisplay: IndividualToolCallDisplay;
|
||||
|
||||
try {
|
||||
|
|
|
|||
|
|
@ -161,6 +161,7 @@ export const useSlashCommandProcessor = (
|
|||
}
|
||||
},
|
||||
},
|
||||
|
||||
{
|
||||
name: 'corgi',
|
||||
action: (_mainCommand, _subCommand, _args) => {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,228 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
||||
import type { Mocked } from 'vitest';
|
||||
import { renderHook, act } from '@testing-library/react';
|
||||
import { useCompletion } from './useCompletion.js';
|
||||
import * as fs from 'fs/promises';
|
||||
import { FileDiscoveryService } from '@gemini-code/core';
|
||||
|
||||
// Mock dependencies
|
||||
vi.mock('fs/promises');
|
||||
vi.mock('@gemini-code/core', async () => {
|
||||
const actual = await vi.importActual('@gemini-code/core');
|
||||
return {
|
||||
...actual,
|
||||
FileDiscoveryService: vi.fn(),
|
||||
isNodeError: vi.fn((error) => error.code === 'ENOENT'),
|
||||
escapePath: vi.fn((path) => path),
|
||||
unescapePath: vi.fn((path) => path),
|
||||
getErrorMessage: vi.fn((error) => error.message),
|
||||
};
|
||||
});
|
||||
|
||||
describe('useCompletion git-aware filtering integration', () => {
|
||||
let mockFileDiscoveryService: Mocked<FileDiscoveryService>;
|
||||
let mockConfig: {
|
||||
fileFiltering?: { enabled?: boolean; respectGitignore?: boolean };
|
||||
};
|
||||
const testCwd = '/test/project';
|
||||
const slashCommands = [
|
||||
{ name: 'help', description: 'Show help', action: vi.fn() },
|
||||
{ name: 'clear', description: 'Clear screen', action: vi.fn() },
|
||||
];
|
||||
|
||||
beforeEach(() => {
|
||||
mockFileDiscoveryService = {
|
||||
initialize: vi.fn(),
|
||||
shouldIgnoreFile: vi.fn(),
|
||||
filterFiles: vi.fn(),
|
||||
getIgnoreInfo: vi.fn(() => ({ gitIgnored: [], customIgnored: [] })),
|
||||
};
|
||||
|
||||
mockConfig = {
|
||||
getFileFilteringRespectGitIgnore: vi.fn(() => true),
|
||||
getFileFilteringAllowBuildArtifacts: vi.fn(() => false),
|
||||
getFileService: vi.fn().mockResolvedValue(mockFileDiscoveryService),
|
||||
};
|
||||
|
||||
vi.mocked(FileDiscoveryService).mockImplementation(
|
||||
() => mockFileDiscoveryService,
|
||||
);
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
it('should filter git-ignored directories from @ completions', async () => {
|
||||
// Mock fs.readdir to return both regular and git-ignored directories
|
||||
vi.mocked(fs.readdir).mockResolvedValue([
|
||||
{ name: 'src', isDirectory: () => true },
|
||||
{ name: 'node_modules', isDirectory: () => true },
|
||||
{ name: 'dist', isDirectory: () => true },
|
||||
{ name: 'README.md', isDirectory: () => false },
|
||||
{ name: '.env', isDirectory: () => false },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>);
|
||||
|
||||
// Mock git ignore service to ignore certain files
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockImplementation(
|
||||
(path: string) =>
|
||||
path.includes('node_modules') ||
|
||||
path.includes('dist') ||
|
||||
path.includes('.env'),
|
||||
);
|
||||
|
||||
const { result } = renderHook(() =>
|
||||
useCompletion('@', testCwd, true, slashCommands, mockConfig),
|
||||
);
|
||||
|
||||
// Wait for async operations to complete
|
||||
await act(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 150)); // Account for debounce
|
||||
});
|
||||
|
||||
expect(result.current.suggestions).toHaveLength(2);
|
||||
expect(result.current.suggestions).toEqual(
|
||||
expect.arrayContaining([
|
||||
{ label: 'src/', value: 'src/' },
|
||||
{ label: 'README.md', value: 'README.md' },
|
||||
]),
|
||||
);
|
||||
expect(result.current.showSuggestions).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle recursive search with git-aware filtering', async () => {
|
||||
// Mock the recursive file search scenario
|
||||
vi.mocked(fs.readdir).mockImplementation(
|
||||
async (dirPath: string | Buffer | URL) => {
|
||||
if (dirPath === testCwd) {
|
||||
return [
|
||||
{ name: 'src', isDirectory: () => true },
|
||||
{ name: 'node_modules', isDirectory: () => true },
|
||||
{ name: 'temp', isDirectory: () => true },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>;
|
||||
}
|
||||
if (dirPath.endsWith('/src')) {
|
||||
return [
|
||||
{ name: 'index.ts', isDirectory: () => false },
|
||||
{ name: 'components', isDirectory: () => true },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>;
|
||||
}
|
||||
if (dirPath.endsWith('/temp')) {
|
||||
return [{ name: 'temp.log', isDirectory: () => false }] as Array<{
|
||||
name: string;
|
||||
isDirectory: () => boolean;
|
||||
}>;
|
||||
}
|
||||
return [] as Array<{ name: string; isDirectory: () => boolean }>;
|
||||
},
|
||||
);
|
||||
|
||||
// Mock git ignore service
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockImplementation(
|
||||
(path: string) => path.includes('node_modules') || path.includes('temp'),
|
||||
);
|
||||
|
||||
const { result } = renderHook(() =>
|
||||
useCompletion('@t', testCwd, true, slashCommands, mockConfig),
|
||||
);
|
||||
|
||||
// Wait for async operations to complete
|
||||
await act(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 150));
|
||||
});
|
||||
|
||||
// Should not include anything from node_modules or dist
|
||||
const suggestionLabels = result.current.suggestions.map((s) => s.label);
|
||||
expect(suggestionLabels).not.toContain('temp/');
|
||||
expect(suggestionLabels.some((l) => l.includes('node_modules'))).toBe(
|
||||
false,
|
||||
);
|
||||
});
|
||||
|
||||
it('should work without config (fallback behavior)', async () => {
|
||||
vi.mocked(fs.readdir).mockResolvedValue([
|
||||
{ name: 'src', isDirectory: () => true },
|
||||
{ name: 'node_modules', isDirectory: () => true },
|
||||
{ name: 'README.md', isDirectory: () => false },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>);
|
||||
|
||||
const { result } = renderHook(() =>
|
||||
useCompletion('@', testCwd, true, slashCommands, undefined),
|
||||
);
|
||||
|
||||
await act(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 150));
|
||||
});
|
||||
|
||||
// Without config, should include all files
|
||||
expect(result.current.suggestions).toHaveLength(3);
|
||||
expect(result.current.suggestions).toEqual(
|
||||
expect.arrayContaining([
|
||||
{ label: 'src/', value: 'src/' },
|
||||
{ label: 'node_modules/', value: 'node_modules/' },
|
||||
{ label: 'README.md', value: 'README.md' },
|
||||
]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle git discovery service initialization failure gracefully', async () => {
|
||||
mockFileDiscoveryService.initialize.mockRejectedValue(
|
||||
new Error('Git not found'),
|
||||
);
|
||||
|
||||
vi.mocked(fs.readdir).mockResolvedValue([
|
||||
{ name: 'src', isDirectory: () => true },
|
||||
{ name: 'README.md', isDirectory: () => false },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>);
|
||||
|
||||
const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
|
||||
|
||||
const { result } = renderHook(() =>
|
||||
useCompletion('@', testCwd, true, slashCommands, mockConfig),
|
||||
);
|
||||
|
||||
await act(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 150));
|
||||
});
|
||||
|
||||
// Since we use centralized service, initialization errors are handled at config level
|
||||
// This test should verify graceful fallback behavior
|
||||
expect(result.current.suggestions.length).toBeGreaterThanOrEqual(0);
|
||||
// Should still show completions even if git discovery fails
|
||||
expect(result.current.suggestions.length).toBeGreaterThan(0);
|
||||
|
||||
consoleSpy.mockRestore();
|
||||
});
|
||||
|
||||
it('should handle directory-specific completions with git filtering', async () => {
|
||||
vi.mocked(fs.readdir).mockResolvedValue([
|
||||
{ name: 'component.tsx', isDirectory: () => false },
|
||||
{ name: 'temp.log', isDirectory: () => false },
|
||||
{ name: 'index.ts', isDirectory: () => false },
|
||||
] as Array<{ name: string; isDirectory: () => boolean }>);
|
||||
|
||||
mockFileDiscoveryService.shouldIgnoreFile.mockImplementation(
|
||||
(path: string) => path.includes('.log'),
|
||||
);
|
||||
|
||||
const { result } = renderHook(() =>
|
||||
useCompletion('@src/comp', testCwd, true, slashCommands, mockConfig),
|
||||
);
|
||||
|
||||
await act(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 150));
|
||||
});
|
||||
|
||||
// Should filter out .log files but include matching .tsx files
|
||||
expect(result.current.suggestions).toEqual([
|
||||
{ label: 'component.tsx', value: 'component.tsx' },
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
|
@ -12,6 +12,7 @@ import {
|
|||
escapePath,
|
||||
unescapePath,
|
||||
getErrorMessage,
|
||||
Config,
|
||||
} from '@gemini-code/core';
|
||||
import {
|
||||
MAX_SUGGESTIONS_TO_SHOW,
|
||||
|
|
@ -37,6 +38,7 @@ export function useCompletion(
|
|||
cwd: string,
|
||||
isActive: boolean,
|
||||
slashCommands: SlashCommand[],
|
||||
config?: Config,
|
||||
): UseCompletionReturn {
|
||||
const [suggestions, setSuggestions] = useState<Suggestion[]>([]);
|
||||
const [activeSuggestionIndex, setActiveSuggestionIndex] =
|
||||
|
|
@ -184,6 +186,7 @@ export function useCompletion(
|
|||
const findFilesRecursively = async (
|
||||
startDir: string,
|
||||
searchPrefix: string,
|
||||
fileDiscovery: { shouldIgnoreFile: (path: string) => boolean } | null,
|
||||
currentRelativePath = '',
|
||||
depth = 0,
|
||||
maxDepth = 10, // Limit recursion depth
|
||||
|
|
@ -201,6 +204,19 @@ export function useCompletion(
|
|||
if (foundSuggestions.length >= maxResults) break;
|
||||
|
||||
const entryPathRelative = path.join(currentRelativePath, entry.name);
|
||||
const entryPathFromRoot = path.relative(
|
||||
cwd,
|
||||
path.join(startDir, entry.name),
|
||||
);
|
||||
|
||||
// Check if this entry should be ignored by git-aware filtering
|
||||
if (
|
||||
fileDiscovery &&
|
||||
fileDiscovery.shouldIgnoreFile(entryPathFromRoot)
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (entry.name.toLowerCase().startsWith(lowerSearchPrefix)) {
|
||||
foundSuggestions.push({
|
||||
label: entryPathRelative + (entry.isDirectory() ? '/' : ''),
|
||||
|
|
@ -219,6 +235,7 @@ export function useCompletion(
|
|||
await findFilesRecursively(
|
||||
path.join(startDir, entry.name),
|
||||
searchPrefix, // Pass original searchPrefix for recursive calls
|
||||
fileDiscovery,
|
||||
entryPathRelative,
|
||||
depth + 1,
|
||||
maxDepth,
|
||||
|
|
@ -237,25 +254,48 @@ export function useCompletion(
|
|||
const fetchSuggestions = async () => {
|
||||
setIsLoadingSuggestions(true);
|
||||
let fetchedSuggestions: Suggestion[] = [];
|
||||
|
||||
// Get centralized file discovery service if config is available
|
||||
const fileDiscovery = config ? await config.getFileService() : null;
|
||||
|
||||
try {
|
||||
// If there's no slash, or it's the root, do a recursive search from cwd
|
||||
if (partialPath.indexOf('/') === -1 && prefix) {
|
||||
fetchedSuggestions = await findFilesRecursively(cwd, prefix);
|
||||
fetchedSuggestions = await findFilesRecursively(
|
||||
cwd,
|
||||
prefix,
|
||||
fileDiscovery,
|
||||
);
|
||||
} else {
|
||||
// Original behavior: list files in the specific directory
|
||||
const lowerPrefix = prefix.toLowerCase();
|
||||
const entries = await fs.readdir(baseDirAbsolute, {
|
||||
withFileTypes: true,
|
||||
});
|
||||
fetchedSuggestions = entries
|
||||
.filter((entry) => entry.name.toLowerCase().startsWith(lowerPrefix))
|
||||
.map((entry) => {
|
||||
const label = entry.isDirectory() ? entry.name + '/' : entry.name;
|
||||
return {
|
||||
label,
|
||||
value: escapePath(label), // Value for completion should be just the name part
|
||||
};
|
||||
});
|
||||
|
||||
// Filter entries using git-aware filtering
|
||||
const filteredEntries = [];
|
||||
for (const entry of entries) {
|
||||
if (!entry.name.toLowerCase().startsWith(lowerPrefix)) continue;
|
||||
|
||||
const relativePath = path.relative(
|
||||
cwd,
|
||||
path.join(baseDirAbsolute, entry.name),
|
||||
);
|
||||
if (fileDiscovery && fileDiscovery.shouldIgnoreFile(relativePath)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
filteredEntries.push(entry);
|
||||
}
|
||||
|
||||
fetchedSuggestions = filteredEntries.map((entry) => {
|
||||
const label = entry.isDirectory() ? entry.name + '/' : entry.name;
|
||||
return {
|
||||
label,
|
||||
value: escapePath(label), // Value for completion should be just the name part
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
// Sort by depth, then directories first, then alphabetically
|
||||
|
|
@ -307,7 +347,7 @@ export function useCompletion(
|
|||
isMounted = false;
|
||||
clearTimeout(debounceTimeout);
|
||||
};
|
||||
}, [query, cwd, isActive, resetCompletionState, slashCommands]);
|
||||
}, [query, cwd, isActive, resetCompletionState, slashCommands, config]);
|
||||
|
||||
return {
|
||||
suggestions,
|
||||
|
|
|
|||
|
|
@ -26,12 +26,14 @@
|
|||
"diff": "^7.0.0",
|
||||
"dotenv": "^16.4.7",
|
||||
"fast-glob": "^3.3.3",
|
||||
"minimatch": "^10.0.0",
|
||||
"shell-quote": "^1.8.2",
|
||||
"strip-ansi": "^7.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/diff": "^7.0.2",
|
||||
"@types/dotenv": "^6.1.1",
|
||||
"@types/minimatch": "^5.1.2",
|
||||
"typescript": "^5.3.3",
|
||||
"vitest": "^3.1.1"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -143,4 +143,27 @@ describe('Server Config (config.ts)', () => {
|
|||
new Config(baseParams); // baseParams does not have contextFileName
|
||||
expect(mockSetGeminiMdFilename).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should set default file filtering settings when not provided', () => {
|
||||
const config = new Config(baseParams);
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(true);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(false);
|
||||
});
|
||||
|
||||
it('should set custom file filtering settings when provided', () => {
|
||||
const paramsWithFileFiltering: ConfigParameters = {
|
||||
...baseParams,
|
||||
fileFilteringRespectGitIgnore: false,
|
||||
fileFilteringAllowBuildArtifacts: true,
|
||||
};
|
||||
const config = new Config(paramsWithFileFiltering);
|
||||
expect(config.getFileFilteringRespectGitIgnore()).toBe(false);
|
||||
expect(config.getFileFilteringAllowBuildArtifacts()).toBe(true);
|
||||
});
|
||||
|
||||
it('should have a getFileService method that returns FileDiscoveryService', async () => {
|
||||
const config = new Config(baseParams);
|
||||
const fileService = await config.getFileService();
|
||||
expect(fileService).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@ import { MemoryTool, setGeminiMdFilename } from '../tools/memoryTool.js';
|
|||
import { WebSearchTool } from '../tools/web-search.js';
|
||||
import { GeminiClient } from '../core/client.js';
|
||||
import { GEMINI_CONFIG_DIR as GEMINI_DIR } from '../tools/memoryTool.js';
|
||||
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
|
||||
|
||||
export enum ApprovalMode {
|
||||
DEFAULT = 'default',
|
||||
|
|
@ -65,6 +66,8 @@ export interface ConfigParameters {
|
|||
vertexai?: boolean;
|
||||
showMemoryUsage?: boolean;
|
||||
contextFileName?: string;
|
||||
fileFilteringRespectGitIgnore?: boolean;
|
||||
fileFilteringAllowBuildArtifacts?: boolean;
|
||||
}
|
||||
|
||||
export class Config {
|
||||
|
|
@ -88,6 +91,9 @@ export class Config {
|
|||
private readonly vertexai: boolean | undefined;
|
||||
private readonly showMemoryUsage: boolean;
|
||||
private readonly geminiClient: GeminiClient;
|
||||
private readonly fileFilteringRespectGitIgnore: boolean;
|
||||
private readonly fileFilteringAllowBuildArtifacts: boolean;
|
||||
private fileDiscoveryService: FileDiscoveryService | null = null;
|
||||
|
||||
constructor(params: ConfigParameters) {
|
||||
this.apiKey = params.apiKey;
|
||||
|
|
@ -108,6 +114,10 @@ export class Config {
|
|||
this.approvalMode = params.approvalMode ?? ApprovalMode.DEFAULT;
|
||||
this.vertexai = params.vertexai;
|
||||
this.showMemoryUsage = params.showMemoryUsage ?? false;
|
||||
this.fileFilteringRespectGitIgnore =
|
||||
params.fileFilteringRespectGitIgnore ?? true;
|
||||
this.fileFilteringAllowBuildArtifacts =
|
||||
params.fileFilteringAllowBuildArtifacts ?? false;
|
||||
|
||||
if (params.contextFileName) {
|
||||
setGeminiMdFilename(params.contextFileName);
|
||||
|
|
@ -207,6 +217,25 @@ export class Config {
|
|||
getGeminiClient(): GeminiClient {
|
||||
return this.geminiClient;
|
||||
}
|
||||
|
||||
getFileFilteringRespectGitIgnore(): boolean {
|
||||
return this.fileFilteringRespectGitIgnore;
|
||||
}
|
||||
|
||||
getFileFilteringAllowBuildArtifacts(): boolean {
|
||||
return this.fileFilteringAllowBuildArtifacts;
|
||||
}
|
||||
|
||||
async getFileService(): Promise<FileDiscoveryService> {
|
||||
if (!this.fileDiscoveryService) {
|
||||
this.fileDiscoveryService = new FileDiscoveryService(this.targetDir);
|
||||
await this.fileDiscoveryService.initialize({
|
||||
respectGitIgnore: this.fileFilteringRespectGitIgnore,
|
||||
includeBuildArtifacts: this.fileFilteringAllowBuildArtifacts,
|
||||
});
|
||||
}
|
||||
return this.fileDiscoveryService;
|
||||
}
|
||||
}
|
||||
|
||||
function findEnvFile(startDir: string): string | null {
|
||||
|
|
@ -270,14 +299,14 @@ export function createToolRegistry(config: Config): Promise<ToolRegistry> {
|
|||
}
|
||||
};
|
||||
|
||||
registerCoreTool(LSTool, targetDir);
|
||||
registerCoreTool(LSTool, targetDir, config);
|
||||
registerCoreTool(ReadFileTool, targetDir);
|
||||
registerCoreTool(GrepTool, targetDir);
|
||||
registerCoreTool(GlobTool, targetDir);
|
||||
registerCoreTool(GlobTool, targetDir, config);
|
||||
registerCoreTool(EditTool, config);
|
||||
registerCoreTool(WriteFileTool, config);
|
||||
registerCoreTool(WebFetchTool, config);
|
||||
registerCoreTool(ReadManyFilesTool, targetDir);
|
||||
registerCoreTool(ReadManyFilesTool, targetDir, config);
|
||||
registerCoreTool(ShellTool, config);
|
||||
registerCoreTool(MemoryTool);
|
||||
registerCoreTool(WebSearchTool, config);
|
||||
|
|
|
|||
|
|
@ -23,6 +23,10 @@ export * from './utils/schemaValidator.js';
|
|||
export * from './utils/errors.js';
|
||||
export * from './utils/getFolderStructure.js';
|
||||
export * from './utils/memoryDiscovery.js';
|
||||
export * from './utils/gitIgnoreParser.js';
|
||||
|
||||
// Export services
|
||||
export * from './services/fileDiscoveryService.js';
|
||||
|
||||
// Export base tool definitions
|
||||
export * from './tools/tools.js';
|
||||
|
|
|
|||
|
|
@ -0,0 +1,253 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
||||
import type { Mocked } from 'vitest';
|
||||
import { FileDiscoveryService } from './fileDiscoveryService.js';
|
||||
import { GitIgnoreParser } from '../utils/gitIgnoreParser.js';
|
||||
|
||||
// Mock the GitIgnoreParser
|
||||
vi.mock('../utils/gitIgnoreParser.js');
|
||||
|
||||
// Mock gitUtils module
|
||||
vi.mock('../utils/gitUtils.js', () => ({
|
||||
isGitRepository: vi.fn(() => true),
|
||||
findGitRoot: vi.fn(() => '/test/project'),
|
||||
}));
|
||||
|
||||
describe('FileDiscoveryService', () => {
|
||||
let service: FileDiscoveryService;
|
||||
let mockGitIgnoreParser: Mocked<GitIgnoreParser>;
|
||||
const mockProjectRoot = '/test/project';
|
||||
|
||||
beforeEach(() => {
|
||||
service = new FileDiscoveryService(mockProjectRoot);
|
||||
|
||||
mockGitIgnoreParser = {
|
||||
initialize: vi.fn(),
|
||||
isIgnored: vi.fn(),
|
||||
getIgnoredPatterns: vi.fn(() => ['.git/**', 'node_modules/**']),
|
||||
parseGitIgnoreContent: vi.fn(),
|
||||
} as unknown as Mocked<GitIgnoreParser>;
|
||||
|
||||
vi.mocked(GitIgnoreParser).mockImplementation(() => mockGitIgnoreParser);
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('initialization', () => {
|
||||
it('should initialize git ignore parser by default', async () => {
|
||||
await service.initialize();
|
||||
|
||||
expect(GitIgnoreParser).toHaveBeenCalledWith(mockProjectRoot);
|
||||
expect(mockGitIgnoreParser.initialize).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should not initialize git ignore parser when respectGitIgnore is false', async () => {
|
||||
await service.initialize({ respectGitIgnore: false });
|
||||
|
||||
expect(GitIgnoreParser).not.toHaveBeenCalled();
|
||||
expect(mockGitIgnoreParser.initialize).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should handle initialization errors gracefully', async () => {
|
||||
mockGitIgnoreParser.initialize.mockRejectedValue(
|
||||
new Error('Init failed'),
|
||||
);
|
||||
|
||||
await expect(service.initialize()).rejects.toThrow('Init failed');
|
||||
});
|
||||
});
|
||||
|
||||
describe('filterFiles', () => {
|
||||
beforeEach(async () => {
|
||||
mockGitIgnoreParser.isIgnored.mockImplementation(
|
||||
(path: string) =>
|
||||
path.includes('node_modules') || path.includes('.git'),
|
||||
);
|
||||
await service.initialize();
|
||||
});
|
||||
|
||||
it('should filter out git-ignored files by default', () => {
|
||||
const files = [
|
||||
'src/index.ts',
|
||||
'node_modules/package/index.js',
|
||||
'README.md',
|
||||
'.git/config',
|
||||
'dist/bundle.js',
|
||||
];
|
||||
|
||||
const filtered = service.filterFiles(files);
|
||||
|
||||
expect(filtered).toEqual(['src/index.ts', 'README.md', 'dist/bundle.js']);
|
||||
});
|
||||
|
||||
it('should not filter files when respectGitIgnore is false', () => {
|
||||
const files = [
|
||||
'src/index.ts',
|
||||
'node_modules/package/index.js',
|
||||
'.git/config',
|
||||
];
|
||||
|
||||
const filtered = service.filterFiles(files, { respectGitIgnore: false });
|
||||
|
||||
expect(filtered).toEqual(files);
|
||||
});
|
||||
|
||||
it('should handle empty file list', () => {
|
||||
const filtered = service.filterFiles([]);
|
||||
expect(filtered).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('shouldIgnoreFile', () => {
|
||||
beforeEach(async () => {
|
||||
mockGitIgnoreParser.isIgnored.mockImplementation((path: string) =>
|
||||
path.includes('node_modules'),
|
||||
);
|
||||
await service.initialize();
|
||||
});
|
||||
|
||||
it('should return true for git-ignored files', () => {
|
||||
expect(service.shouldIgnoreFile('node_modules/package/index.js')).toBe(
|
||||
true,
|
||||
);
|
||||
});
|
||||
|
||||
it('should return false for non-ignored files', () => {
|
||||
expect(service.shouldIgnoreFile('src/index.ts')).toBe(false);
|
||||
});
|
||||
|
||||
it('should return false when respectGitIgnore is false', () => {
|
||||
expect(
|
||||
service.shouldIgnoreFile('node_modules/package/index.js', {
|
||||
respectGitIgnore: false,
|
||||
}),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it('should return false when git ignore parser is not initialized', async () => {
|
||||
const uninitializedService = new FileDiscoveryService(mockProjectRoot);
|
||||
expect(
|
||||
uninitializedService.shouldIgnoreFile('node_modules/package/index.js'),
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getIgnoreInfo', () => {
|
||||
beforeEach(async () => {
|
||||
await service.initialize();
|
||||
});
|
||||
|
||||
it('should return git ignored patterns', () => {
|
||||
const info = service.getIgnoreInfo();
|
||||
|
||||
expect(info.gitIgnored).toEqual(['.git/**', 'node_modules/**']);
|
||||
});
|
||||
|
||||
it('should return empty arrays when git ignore parser is not initialized', async () => {
|
||||
const uninitializedService = new FileDiscoveryService(mockProjectRoot);
|
||||
const info = uninitializedService.getIgnoreInfo();
|
||||
|
||||
expect(info.gitIgnored).toEqual([]);
|
||||
});
|
||||
|
||||
it('should handle git ignore parser returning null patterns', async () => {
|
||||
mockGitIgnoreParser.getIgnoredPatterns.mockReturnValue([] as string[]);
|
||||
|
||||
const info = service.getIgnoreInfo();
|
||||
|
||||
expect(info.gitIgnored).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('isGitRepository', () => {
|
||||
it('should return true when isGitRepo is explicitly set to true in options', () => {
|
||||
const result = service.isGitRepository({ isGitRepo: true });
|
||||
expect(result).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false when isGitRepo is explicitly set to false in options', () => {
|
||||
const result = service.isGitRepository({ isGitRepo: false });
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
|
||||
it('should use git utility function when isGitRepo is not specified', () => {
|
||||
const result = service.isGitRepository();
|
||||
expect(result).toBe(true); // mocked to return true
|
||||
});
|
||||
|
||||
it('should use git utility function when options are undefined', () => {
|
||||
const result = service.isGitRepository(undefined);
|
||||
expect(result).toBe(true); // mocked to return true
|
||||
});
|
||||
});
|
||||
|
||||
describe('initialization with isGitRepo config', () => {
|
||||
it('should initialize git ignore parser when isGitRepo is true in options', async () => {
|
||||
await service.initialize({ isGitRepo: true });
|
||||
|
||||
expect(GitIgnoreParser).toHaveBeenCalledWith(mockProjectRoot);
|
||||
expect(mockGitIgnoreParser.initialize).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should not initialize git ignore parser when isGitRepo is false in options', async () => {
|
||||
await service.initialize({ isGitRepo: false });
|
||||
|
||||
expect(GitIgnoreParser).not.toHaveBeenCalled();
|
||||
expect(mockGitIgnoreParser.initialize).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should initialize git ignore parser when isGitRepo is not specified but respectGitIgnore is true', async () => {
|
||||
await service.initialize({ respectGitIgnore: true });
|
||||
|
||||
expect(GitIgnoreParser).toHaveBeenCalledWith(mockProjectRoot);
|
||||
expect(mockGitIgnoreParser.initialize).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('shouldIgnoreFile with isGitRepo config', () => {
|
||||
it('should respect isGitRepo option when checking if file should be ignored', async () => {
|
||||
mockGitIgnoreParser.isIgnored.mockImplementation((path: string) =>
|
||||
path.includes('node_modules'),
|
||||
);
|
||||
await service.initialize({ isGitRepo: true });
|
||||
|
||||
expect(
|
||||
service.shouldIgnoreFile('node_modules/package/index.js', {
|
||||
isGitRepo: true,
|
||||
}),
|
||||
).toBe(true);
|
||||
expect(
|
||||
service.shouldIgnoreFile('node_modules/package/index.js', {
|
||||
isGitRepo: false,
|
||||
}),
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle relative project root paths', () => {
|
||||
const relativeService = new FileDiscoveryService('./relative/path');
|
||||
expect(relativeService).toBeInstanceOf(FileDiscoveryService);
|
||||
});
|
||||
|
||||
it('should handle undefined options', async () => {
|
||||
await service.initialize(undefined);
|
||||
expect(GitIgnoreParser).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should handle filterFiles with undefined options', async () => {
|
||||
await service.initialize();
|
||||
const files = ['src/index.ts'];
|
||||
const filtered = service.filterFiles(files, undefined);
|
||||
expect(filtered).toEqual(files);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { GitIgnoreParser, GitIgnoreFilter } from '../utils/gitIgnoreParser.js';
|
||||
import { isGitRepository } from '../utils/gitUtils.js';
|
||||
import * as path from 'path';
|
||||
|
||||
export interface FileDiscoveryOptions {
|
||||
respectGitIgnore?: boolean;
|
||||
includeBuildArtifacts?: boolean;
|
||||
isGitRepo?: boolean;
|
||||
}
|
||||
|
||||
export class FileDiscoveryService {
|
||||
private gitIgnoreFilter: GitIgnoreFilter | null = null;
|
||||
private projectRoot: string;
|
||||
|
||||
constructor(projectRoot: string) {
|
||||
this.projectRoot = path.resolve(projectRoot);
|
||||
}
|
||||
|
||||
async initialize(options: FileDiscoveryOptions = {}): Promise<void> {
|
||||
const isGitRepo = options.isGitRepo ?? isGitRepository(this.projectRoot);
|
||||
|
||||
if (options.respectGitIgnore !== false && isGitRepo) {
|
||||
const parser = new GitIgnoreParser(this.projectRoot);
|
||||
await parser.initialize();
|
||||
this.gitIgnoreFilter = parser;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters a list of file paths based on git ignore rules
|
||||
*/
|
||||
filterFiles(
|
||||
filePaths: string[],
|
||||
options: FileDiscoveryOptions = {},
|
||||
): string[] {
|
||||
return filePaths.filter((filePath) => {
|
||||
// Always respect git ignore unless explicitly disabled
|
||||
if (options.respectGitIgnore !== false && this.gitIgnoreFilter) {
|
||||
if (this.gitIgnoreFilter.isIgnored(filePath)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets patterns that would be ignored for debugging/transparency
|
||||
*/
|
||||
getIgnoreInfo(): { gitIgnored: string[] } {
|
||||
return {
|
||||
gitIgnored: this.gitIgnoreFilter?.getIgnoredPatterns() || [],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a single file should be ignored
|
||||
*/
|
||||
shouldIgnoreFile(
|
||||
filePath: string,
|
||||
options: FileDiscoveryOptions = {},
|
||||
): boolean {
|
||||
const isGitRepo = options.isGitRepo ?? isGitRepository(this.projectRoot);
|
||||
if (
|
||||
options.respectGitIgnore !== false &&
|
||||
isGitRepo &&
|
||||
this.gitIgnoreFilter
|
||||
) {
|
||||
return this.gitIgnoreFilter.isIgnored(filePath);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the project is a git repository
|
||||
*/
|
||||
isGitRepository(options: FileDiscoveryOptions = {}): boolean {
|
||||
return options.isGitRepo ?? isGitRepository(this.projectRoot);
|
||||
}
|
||||
}
|
||||
|
|
@ -11,16 +11,30 @@ import path from 'path';
|
|||
import fs from 'fs/promises';
|
||||
import os from 'os';
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest'; // Removed vi
|
||||
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
|
||||
import { Config } from '../config/config.js';
|
||||
|
||||
describe('GlobTool', () => {
|
||||
let tempRootDir: string; // This will be the rootDirectory for the GlobTool instance
|
||||
let globTool: GlobTool;
|
||||
const abortSignal = new AbortController().signal;
|
||||
|
||||
// Mock config for testing
|
||||
const mockConfig = {
|
||||
getFileService: async () => {
|
||||
const service = new FileDiscoveryService(tempRootDir);
|
||||
await service.initialize({ respectGitIgnore: true });
|
||||
return service;
|
||||
},
|
||||
getFileFilteringRespectGitIgnore: () => true,
|
||||
getFileFilteringCustomIgnorePatterns: () => [],
|
||||
getFileFilteringAllowBuildArtifacts: () => false,
|
||||
} as Partial<Config> as Config;
|
||||
|
||||
beforeEach(async () => {
|
||||
// Create a unique root directory for each test run
|
||||
tempRootDir = await fs.mkdtemp(path.join(os.tmpdir(), 'glob-tool-root-'));
|
||||
globTool = new GlobTool(tempRootDir);
|
||||
globTool = new GlobTool(tempRootDir, mockConfig);
|
||||
|
||||
// Create some test files and directories within this root
|
||||
// Top-level files
|
||||
|
|
@ -214,7 +228,7 @@ describe('GlobTool', () => {
|
|||
it("should return error if search path resolves outside the tool's root directory", () => {
|
||||
// Create a globTool instance specifically for this test, with a deeper root
|
||||
const deeperRootDir = path.join(tempRootDir, 'sub');
|
||||
const specificGlobTool = new GlobTool(deeperRootDir);
|
||||
const specificGlobTool = new GlobTool(deeperRootDir, mockConfig);
|
||||
// const params: GlobToolParams = { pattern: '*.txt', path: '..' }; // This line is unused and will be removed.
|
||||
// This should be fine as tempRootDir is still within the original tempRootDir (the parent of deeperRootDir)
|
||||
// Let's try to go further up.
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ import fg from 'fast-glob';
|
|||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { BaseTool, ToolResult } from './tools.js';
|
||||
import { shortenPath, makeRelative } from '../utils/paths.js';
|
||||
import { Config } from '../config/config.js';
|
||||
|
||||
/**
|
||||
* Parameters for the GlobTool
|
||||
|
|
@ -29,6 +30,11 @@ export interface GlobToolParams {
|
|||
* Whether the search should be case-sensitive (optional, defaults to false)
|
||||
*/
|
||||
case_sensitive?: boolean;
|
||||
|
||||
/**
|
||||
* Whether to respect .gitignore patterns (optional, defaults to true)
|
||||
*/
|
||||
respect_git_ignore?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -40,7 +46,10 @@ export class GlobTool extends BaseTool<GlobToolParams, ToolResult> {
|
|||
* Creates a new instance of the GlobLogic
|
||||
* @param rootDirectory Root directory to ground this tool in.
|
||||
*/
|
||||
constructor(private rootDirectory: string) {
|
||||
constructor(
|
||||
private rootDirectory: string,
|
||||
private config: Config,
|
||||
) {
|
||||
super(
|
||||
GlobTool.Name,
|
||||
'FindFiles',
|
||||
|
|
@ -62,6 +71,11 @@ export class GlobTool extends BaseTool<GlobToolParams, ToolResult> {
|
|||
'Optional: Whether the search should be case-sensitive. Defaults to false.',
|
||||
type: 'boolean',
|
||||
},
|
||||
respect_git_ignore: {
|
||||
description:
|
||||
'Optional: Whether to respect .gitignore patterns when finding files. Only available in git repositories. Defaults to true.',
|
||||
type: 'boolean',
|
||||
},
|
||||
},
|
||||
required: ['pattern'],
|
||||
type: 'object',
|
||||
|
|
@ -167,6 +181,12 @@ export class GlobTool extends BaseTool<GlobToolParams, ToolResult> {
|
|||
params.path || '.',
|
||||
);
|
||||
|
||||
// Get centralized file discovery service
|
||||
const respectGitIgnore =
|
||||
params.respect_git_ignore ??
|
||||
this.config.getFileFilteringRespectGitIgnore();
|
||||
const fileDiscovery = await this.config.getFileService();
|
||||
|
||||
const entries = await fg(params.pattern, {
|
||||
cwd: searchDirAbsolute,
|
||||
absolute: true,
|
||||
|
|
@ -179,25 +199,57 @@ export class GlobTool extends BaseTool<GlobToolParams, ToolResult> {
|
|||
suppressErrors: true,
|
||||
});
|
||||
|
||||
if (!entries || entries.length === 0) {
|
||||
// Apply git-aware filtering if enabled and in git repository
|
||||
let filteredEntries = entries;
|
||||
let gitIgnoredCount = 0;
|
||||
|
||||
if (respectGitIgnore && fileDiscovery.isGitRepository()) {
|
||||
const allPaths = entries.map((entry) => entry.path);
|
||||
const relativePaths = allPaths.map((p) =>
|
||||
path.relative(this.rootDirectory, p),
|
||||
);
|
||||
const filteredRelativePaths = fileDiscovery.filterFiles(relativePaths, {
|
||||
respectGitIgnore,
|
||||
});
|
||||
const filteredAbsolutePaths = new Set(
|
||||
filteredRelativePaths.map((p) => path.resolve(this.rootDirectory, p)),
|
||||
);
|
||||
|
||||
filteredEntries = entries.filter((entry) =>
|
||||
filteredAbsolutePaths.has(entry.path),
|
||||
);
|
||||
gitIgnoredCount = entries.length - filteredEntries.length;
|
||||
}
|
||||
|
||||
if (!filteredEntries || filteredEntries.length === 0) {
|
||||
let message = `No files found matching pattern "${params.pattern}" within ${searchDirAbsolute}.`;
|
||||
if (gitIgnoredCount > 0) {
|
||||
message += ` (${gitIgnoredCount} files were git-ignored)`;
|
||||
}
|
||||
return {
|
||||
llmContent: `No files found matching pattern "${params.pattern}" within ${searchDirAbsolute}.`,
|
||||
llmContent: message,
|
||||
returnDisplay: `No files found`,
|
||||
};
|
||||
}
|
||||
|
||||
entries.sort((a, b) => {
|
||||
filteredEntries.sort((a, b) => {
|
||||
const mtimeA = a.stats?.mtime?.getTime() ?? 0;
|
||||
const mtimeB = b.stats?.mtime?.getTime() ?? 0;
|
||||
return mtimeB - mtimeA;
|
||||
});
|
||||
|
||||
const sortedAbsolutePaths = entries.map((entry) => entry.path);
|
||||
const sortedAbsolutePaths = filteredEntries.map((entry) => entry.path);
|
||||
const fileListDescription = sortedAbsolutePaths.join('\n');
|
||||
const fileCount = sortedAbsolutePaths.length;
|
||||
|
||||
let resultMessage = `Found ${fileCount} file(s) matching "${params.pattern}" within ${searchDirAbsolute}`;
|
||||
if (gitIgnoredCount > 0) {
|
||||
resultMessage += ` (${gitIgnoredCount} additional files were git-ignored)`;
|
||||
}
|
||||
resultMessage += `, sorted by modification time (newest first):\n${fileListDescription}`;
|
||||
|
||||
return {
|
||||
llmContent: `Found ${fileCount} file(s) matching "${params.pattern}" within ${searchDirAbsolute}, sorted by modification time (newest first):\n${fileListDescription}`,
|
||||
llmContent: resultMessage,
|
||||
returnDisplay: `Found ${fileCount} matching file(s)`,
|
||||
};
|
||||
} catch (error) {
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ import path from 'path';
|
|||
import { BaseTool, ToolResult } from './tools.js';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
import { Config } from '../config/config.js';
|
||||
|
||||
/**
|
||||
* Parameters for the LS tool
|
||||
|
|
@ -20,9 +21,14 @@ export interface LSToolParams {
|
|||
path: string;
|
||||
|
||||
/**
|
||||
* List of glob patterns to ignore
|
||||
* Array of glob patterns to ignore (optional)
|
||||
*/
|
||||
ignore?: string[];
|
||||
|
||||
/**
|
||||
* Whether to respect .gitignore patterns (optional, defaults to true)
|
||||
*/
|
||||
respect_git_ignore?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -65,7 +71,10 @@ export class LSTool extends BaseTool<LSToolParams, ToolResult> {
|
|||
* Creates a new instance of the LSLogic
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(private rootDirectory: string) {
|
||||
constructor(
|
||||
private rootDirectory: string,
|
||||
private config: Config,
|
||||
) {
|
||||
super(
|
||||
LSTool.Name,
|
||||
'ReadFolder',
|
||||
|
|
@ -84,6 +93,11 @@ export class LSTool extends BaseTool<LSToolParams, ToolResult> {
|
|||
},
|
||||
type: 'array',
|
||||
},
|
||||
respect_git_ignore: {
|
||||
description:
|
||||
'Optional: Whether to respect .gitignore patterns when listing files. Only available in git repositories. Defaults to true.',
|
||||
type: 'boolean',
|
||||
},
|
||||
},
|
||||
required: ['path'],
|
||||
type: 'object',
|
||||
|
|
@ -214,7 +228,16 @@ export class LSTool extends BaseTool<LSToolParams, ToolResult> {
|
|||
}
|
||||
|
||||
const files = fs.readdirSync(params.path);
|
||||
|
||||
// Get centralized file discovery service
|
||||
const respectGitIgnore =
|
||||
params.respect_git_ignore ??
|
||||
this.config.getFileFilteringRespectGitIgnore();
|
||||
const fileDiscovery = await this.config.getFileService();
|
||||
|
||||
const entries: FileEntry[] = [];
|
||||
let gitIgnoredCount = 0;
|
||||
|
||||
if (files.length === 0) {
|
||||
// Changed error message to be more neutral for LLM
|
||||
return {
|
||||
|
|
@ -229,6 +252,18 @@ export class LSTool extends BaseTool<LSToolParams, ToolResult> {
|
|||
}
|
||||
|
||||
const fullPath = path.join(params.path, file);
|
||||
const relativePath = path.relative(this.rootDirectory, fullPath);
|
||||
|
||||
// Check if this file should be git-ignored (only in git repositories)
|
||||
if (
|
||||
respectGitIgnore &&
|
||||
fileDiscovery.isGitRepository() &&
|
||||
fileDiscovery.shouldIgnoreFile(relativePath)
|
||||
) {
|
||||
gitIgnoredCount++;
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
const stats = fs.statSync(fullPath);
|
||||
const isDir = stats.isDirectory();
|
||||
|
|
@ -257,10 +292,19 @@ export class LSTool extends BaseTool<LSToolParams, ToolResult> {
|
|||
.map((entry) => `${entry.isDirectory ? '[DIR] ' : ''}${entry.name}`)
|
||||
.join('\n');
|
||||
|
||||
let resultMessage = `Directory listing for ${params.path}:\n${directoryContent}`;
|
||||
if (gitIgnoredCount > 0) {
|
||||
resultMessage += `\n\n(${gitIgnoredCount} items were git-ignored)`;
|
||||
}
|
||||
|
||||
let displayMessage = `Listed ${entries.length} item(s).`;
|
||||
if (gitIgnoredCount > 0) {
|
||||
displayMessage += ` (${gitIgnoredCount} git-ignored)`;
|
||||
}
|
||||
|
||||
return {
|
||||
llmContent: `Directory listing for ${params.path}:\n${directoryContent}`,
|
||||
// Simplified display, CLI wrapper can enhance
|
||||
returnDisplay: `Listed ${entries.length} item(s).`,
|
||||
llmContent: resultMessage,
|
||||
returnDisplay: displayMessage,
|
||||
};
|
||||
} catch (error) {
|
||||
const errorMsg = `Error listing directory: ${error instanceof Error ? error.message : String(error)}`;
|
||||
|
|
|
|||
|
|
@ -9,6 +9,8 @@ import type { Mock } from 'vitest';
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { mockControl } from '../__mocks__/fs/promises.js';
|
||||
import { ReadManyFilesTool } from './read-many-files.js';
|
||||
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
|
||||
import { Config } from '../config/config.js';
|
||||
import path from 'path';
|
||||
import fs from 'fs'; // Actual fs for setup
|
||||
import os from 'os';
|
||||
|
|
@ -19,6 +21,18 @@ describe('ReadManyFilesTool', () => {
|
|||
let tempDirOutsideRoot: string;
|
||||
let mockReadFileFn: Mock;
|
||||
|
||||
// Mock config for testing
|
||||
const mockConfig = {
|
||||
getFileService: async () => {
|
||||
const service = new FileDiscoveryService(tempRootDir);
|
||||
await service.initialize({ respectGitIgnore: true });
|
||||
return service;
|
||||
},
|
||||
getFileFilteringRespectGitIgnore: () => true,
|
||||
getFileFilteringCustomIgnorePatterns: () => [],
|
||||
getFileFilteringAllowBuildArtifacts: () => false,
|
||||
} as Partial<Config> as Config;
|
||||
|
||||
beforeEach(async () => {
|
||||
tempRootDir = fs.mkdtempSync(
|
||||
path.join(os.tmpdir(), 'read-many-files-root-'),
|
||||
|
|
@ -26,7 +40,7 @@ describe('ReadManyFilesTool', () => {
|
|||
tempDirOutsideRoot = fs.mkdtempSync(
|
||||
path.join(os.tmpdir(), 'read-many-files-external-'),
|
||||
);
|
||||
tool = new ReadManyFilesTool(tempRootDir);
|
||||
tool = new ReadManyFilesTool(tempRootDir, mockConfig);
|
||||
|
||||
mockReadFileFn = mockControl.mockReadFile;
|
||||
mockReadFileFn.mockReset();
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ import {
|
|||
DEFAULT_ENCODING,
|
||||
} from '../utils/fileUtils.js';
|
||||
import { PartListUnion } from '@google/genai';
|
||||
import { Config } from '../config/config.js';
|
||||
|
||||
/**
|
||||
* Parameters for the ReadManyFilesTool.
|
||||
|
|
@ -54,6 +55,11 @@ export interface ReadManyFilesParams {
|
|||
* Optional. Apply default exclusion patterns. Defaults to true.
|
||||
*/
|
||||
useDefaultExcludes?: boolean;
|
||||
|
||||
/**
|
||||
* Optional. Whether to respect .gitignore patterns. Defaults to true.
|
||||
*/
|
||||
respect_git_ignore?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -119,7 +125,10 @@ export class ReadManyFilesTool extends BaseTool<
|
|||
* @param targetDir The absolute root directory within which this tool is allowed to operate.
|
||||
* All paths provided in `params` will be resolved relative to this directory.
|
||||
*/
|
||||
constructor(readonly targetDir: string) {
|
||||
constructor(
|
||||
readonly targetDir: string,
|
||||
private config: Config,
|
||||
) {
|
||||
const parameterSchema: Record<string, unknown> = {
|
||||
type: 'object',
|
||||
properties: {
|
||||
|
|
@ -155,6 +164,12 @@ export class ReadManyFilesTool extends BaseTool<
|
|||
'Optional. Whether to apply a list of default exclusion patterns (e.g., node_modules, .git, binary files). Defaults to true.',
|
||||
default: true,
|
||||
},
|
||||
respect_git_ignore: {
|
||||
type: 'boolean',
|
||||
description:
|
||||
'Optional. Whether to respect .gitignore patterns when discovering files. Only available in git repositories. Defaults to true.',
|
||||
default: true,
|
||||
},
|
||||
},
|
||||
required: ['paths'],
|
||||
};
|
||||
|
|
@ -254,8 +269,15 @@ Use this tool when the user's query implies needing the content of several files
|
|||
include = [],
|
||||
exclude = [],
|
||||
useDefaultExcludes = true,
|
||||
respect_git_ignore = true,
|
||||
} = params;
|
||||
|
||||
const respectGitIgnore =
|
||||
respect_git_ignore ?? this.config.getFileFilteringRespectGitIgnore();
|
||||
|
||||
// Get centralized file discovery service
|
||||
const fileDiscovery = await this.config.getFileService();
|
||||
|
||||
const toolBaseDir = this.targetDir;
|
||||
const filesToConsider = new Set<string>();
|
||||
const skippedFiles: Array<{ path: string; reason: string }> = [];
|
||||
|
|
@ -290,9 +312,22 @@ Use this tool when the user's query implies needing the content of several files
|
|||
caseSensitiveMatch: false,
|
||||
});
|
||||
|
||||
// Apply git-aware filtering if enabled and in git repository
|
||||
const filteredEntries =
|
||||
respectGitIgnore && fileDiscovery.isGitRepository()
|
||||
? fileDiscovery
|
||||
.filterFiles(
|
||||
entries.map((p) => path.relative(toolBaseDir, p)),
|
||||
{
|
||||
respectGitIgnore,
|
||||
},
|
||||
)
|
||||
.map((p) => path.resolve(toolBaseDir, p))
|
||||
: entries;
|
||||
|
||||
let gitIgnoredCount = 0;
|
||||
for (const absoluteFilePath of entries) {
|
||||
// Security check: ensure the glob library didn't return something outside targetDir.
|
||||
// This should be guaranteed by `cwd` and the library's sandboxing, but an extra check is good practice.
|
||||
if (!absoluteFilePath.startsWith(toolBaseDir)) {
|
||||
skippedFiles.push({
|
||||
path: absoluteFilePath,
|
||||
|
|
@ -300,8 +335,30 @@ Use this tool when the user's query implies needing the content of several files
|
|||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
// Check if this file was filtered out by git ignore
|
||||
if (
|
||||
respectGitIgnore &&
|
||||
fileDiscovery.isGitRepository() &&
|
||||
!filteredEntries.includes(absoluteFilePath)
|
||||
) {
|
||||
gitIgnoredCount++;
|
||||
continue;
|
||||
}
|
||||
|
||||
filesToConsider.add(absoluteFilePath);
|
||||
}
|
||||
|
||||
// Add info about git-ignored files if any were filtered
|
||||
if (gitIgnoredCount > 0) {
|
||||
const reason = respectGitIgnore
|
||||
? 'git-ignored'
|
||||
: 'filtered by custom ignore patterns';
|
||||
skippedFiles.push({
|
||||
path: `${gitIgnoredCount} file(s)`,
|
||||
reason,
|
||||
});
|
||||
}
|
||||
} catch (error) {
|
||||
return {
|
||||
llmContent: `Error during file search: ${getErrorMessage(error)}`,
|
||||
|
|
|
|||
|
|
@ -35,10 +35,29 @@ export class ShellTool extends BaseTool<ShellToolParams, ToolResult> {
|
|||
|
||||
constructor(private readonly config: Config) {
|
||||
const toolDisplayName = 'Shell';
|
||||
const descriptionUrl = new URL('shell.md', import.meta.url);
|
||||
const toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
||||
const schemaUrl = new URL('shell.json', import.meta.url);
|
||||
const toolParameterSchema = JSON.parse(fs.readFileSync(schemaUrl, 'utf-8'));
|
||||
|
||||
let toolDescription: string;
|
||||
let toolParameterSchema: Record<string, unknown>;
|
||||
|
||||
try {
|
||||
const descriptionUrl = new URL('shell.md', import.meta.url);
|
||||
toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
||||
const schemaUrl = new URL('shell.json', import.meta.url);
|
||||
toolParameterSchema = JSON.parse(fs.readFileSync(schemaUrl, 'utf-8'));
|
||||
} catch {
|
||||
// Fallback with minimal descriptions for tests when file reading fails
|
||||
toolDescription = 'Execute shell commands';
|
||||
toolParameterSchema = {
|
||||
type: 'object',
|
||||
properties: {
|
||||
command: { type: 'string', description: 'Command to execute' },
|
||||
description: { type: 'string', description: 'Command description' },
|
||||
directory: { type: 'string', description: 'Working directory' },
|
||||
},
|
||||
required: ['command'],
|
||||
};
|
||||
}
|
||||
|
||||
super(
|
||||
ShellTool.Name,
|
||||
toolDisplayName,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,237 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
||||
import { GitIgnoreParser } from './gitIgnoreParser.js';
|
||||
import * as fs from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
|
||||
// Mock fs module
|
||||
vi.mock('fs/promises');
|
||||
|
||||
// Mock gitUtils module
|
||||
vi.mock('./gitUtils.js', () => ({
|
||||
isGitRepository: vi.fn(() => true),
|
||||
findGitRoot: vi.fn(() => '/test/project'),
|
||||
}));
|
||||
|
||||
describe('GitIgnoreParser', () => {
|
||||
let parser: GitIgnoreParser;
|
||||
const mockProjectRoot = '/test/project';
|
||||
|
||||
beforeEach(() => {
|
||||
parser = new GitIgnoreParser(mockProjectRoot);
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('initialization', () => {
|
||||
it('should initialize without errors when no .gitignore exists', async () => {
|
||||
vi.mocked(fs.readFile).mockRejectedValue(new Error('ENOENT'));
|
||||
|
||||
await expect(parser.initialize()).resolves.not.toThrow();
|
||||
});
|
||||
|
||||
it('should load .gitignore patterns when file exists', async () => {
|
||||
const gitignoreContent = `
|
||||
# Comment
|
||||
node_modules/
|
||||
*.log
|
||||
dist
|
||||
.env
|
||||
`;
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('.git/**');
|
||||
expect(patterns).toContain('.git');
|
||||
expect(patterns).toContain('node_modules/**');
|
||||
expect(patterns).toContain('**/*.log');
|
||||
expect(patterns).toContain('**/dist');
|
||||
expect(patterns).toContain('**/.env');
|
||||
});
|
||||
|
||||
it('should handle git exclude file', async () => {
|
||||
vi.mocked(fs.readFile).mockImplementation(async (filePath) => {
|
||||
if (filePath === path.join(mockProjectRoot, '.gitignore')) {
|
||||
throw new Error('ENOENT');
|
||||
}
|
||||
if (
|
||||
filePath === path.join(mockProjectRoot, '.git', 'info', 'exclude')
|
||||
) {
|
||||
return 'temp/\n*.tmp';
|
||||
}
|
||||
throw new Error('Unexpected file');
|
||||
});
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('temp/**');
|
||||
expect(patterns).toContain('**/*.tmp');
|
||||
});
|
||||
});
|
||||
|
||||
describe('pattern parsing', () => {
|
||||
it('should handle directory patterns correctly', async () => {
|
||||
const gitignoreContent = 'node_modules/\nbuild/\n';
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('node_modules/**');
|
||||
expect(patterns).toContain('build/**');
|
||||
});
|
||||
|
||||
it('should handle file patterns correctly', async () => {
|
||||
const gitignoreContent = '*.log\n.env\nconfig.json\n';
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('**/*.log');
|
||||
expect(patterns).toContain('**/.env');
|
||||
expect(patterns).toContain('**/config.json');
|
||||
});
|
||||
|
||||
it('should skip comments and empty lines', async () => {
|
||||
const gitignoreContent = `
|
||||
# This is a comment
|
||||
*.log
|
||||
|
||||
# Another comment
|
||||
.env
|
||||
`;
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).not.toContain('# This is a comment');
|
||||
expect(patterns).not.toContain('# Another comment');
|
||||
expect(patterns).toContain('**/*.log');
|
||||
expect(patterns).toContain('**/.env');
|
||||
});
|
||||
|
||||
it('should skip negation patterns for now', async () => {
|
||||
const gitignoreContent = '*.log\n!important.log\n';
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('**/*.log');
|
||||
expect(patterns).not.toContain('!important.log');
|
||||
});
|
||||
|
||||
it('should handle paths with slashes correctly', async () => {
|
||||
const gitignoreContent = 'src/*.log\ndocs/temp/\n';
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('src/*.log');
|
||||
expect(patterns).toContain('docs/temp/**');
|
||||
});
|
||||
});
|
||||
|
||||
describe('isIgnored', () => {
|
||||
beforeEach(async () => {
|
||||
const gitignoreContent = `
|
||||
node_modules/
|
||||
*.log
|
||||
dist
|
||||
.env
|
||||
src/*.tmp
|
||||
`;
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
await parser.initialize();
|
||||
});
|
||||
|
||||
it('should always ignore .git directory', () => {
|
||||
expect(parser.isIgnored('.git')).toBe(true);
|
||||
expect(parser.isIgnored('.git/config')).toBe(true);
|
||||
expect(parser.isIgnored('.git/objects/abc123')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore files matching patterns', () => {
|
||||
expect(parser.isIgnored('node_modules')).toBe(true);
|
||||
expect(parser.isIgnored('node_modules/package')).toBe(true);
|
||||
expect(parser.isIgnored('app.log')).toBe(true);
|
||||
expect(parser.isIgnored('logs/app.log')).toBe(true);
|
||||
expect(parser.isIgnored('dist')).toBe(true);
|
||||
expect(parser.isIgnored('.env')).toBe(true);
|
||||
expect(parser.isIgnored('config/.env')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore files with path-specific patterns', () => {
|
||||
expect(parser.isIgnored('src/temp.tmp')).toBe(true);
|
||||
expect(parser.isIgnored('other/temp.tmp')).toBe(false);
|
||||
});
|
||||
|
||||
it('should not ignore files that do not match patterns', () => {
|
||||
expect(parser.isIgnored('src/index.ts')).toBe(false);
|
||||
expect(parser.isIgnored('README.md')).toBe(false);
|
||||
expect(parser.isIgnored('package.json')).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle absolute paths correctly', () => {
|
||||
const absolutePath = path.join(
|
||||
mockProjectRoot,
|
||||
'node_modules',
|
||||
'package',
|
||||
);
|
||||
expect(parser.isIgnored(absolutePath)).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle paths outside project root', () => {
|
||||
const outsidePath = '/other/project/file.txt';
|
||||
expect(parser.isIgnored(outsidePath)).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle relative paths correctly', () => {
|
||||
expect(parser.isIgnored('./node_modules')).toBe(true);
|
||||
expect(parser.isIgnored('../file.txt')).toBe(false);
|
||||
});
|
||||
|
||||
it('should normalize path separators on Windows', () => {
|
||||
expect(parser.isIgnored('node_modules\\package')).toBe(true);
|
||||
expect(parser.isIgnored('src\\temp.tmp')).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getIgnoredPatterns', () => {
|
||||
it('should return a copy of patterns array', async () => {
|
||||
const gitignoreContent = '*.log\n';
|
||||
vi.mocked(fs.readFile).mockResolvedValue(gitignoreContent);
|
||||
|
||||
await parser.initialize();
|
||||
const patterns1 = parser.getIgnoredPatterns();
|
||||
const patterns2 = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns1).not.toBe(patterns2); // Different array instances
|
||||
expect(patterns1).toEqual(patterns2); // Same content
|
||||
});
|
||||
|
||||
it('should always include .git patterns', async () => {
|
||||
vi.mocked(fs.readFile).mockRejectedValue(new Error('ENOENT'));
|
||||
|
||||
await parser.initialize();
|
||||
const patterns = parser.getIgnoredPatterns();
|
||||
|
||||
expect(patterns).toContain('.git/**');
|
||||
expect(patterns).toContain('.git');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import * as fs from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
import { minimatch } from 'minimatch';
|
||||
import { isGitRepository } from './gitUtils.js';
|
||||
|
||||
export interface GitIgnoreFilter {
|
||||
isIgnored(filePath: string): boolean;
|
||||
getIgnoredPatterns(): string[];
|
||||
}
|
||||
|
||||
export class GitIgnoreParser implements GitIgnoreFilter {
|
||||
private ignorePatterns: string[] = [];
|
||||
private projectRoot: string;
|
||||
private isGitRepo: boolean = false;
|
||||
|
||||
constructor(projectRoot: string) {
|
||||
this.projectRoot = path.resolve(projectRoot);
|
||||
}
|
||||
|
||||
async initialize(): Promise<void> {
|
||||
this.isGitRepo = isGitRepository(this.projectRoot);
|
||||
if (this.isGitRepo) {
|
||||
const gitIgnoreFiles = [
|
||||
path.join(this.projectRoot, '.gitignore'),
|
||||
path.join(this.projectRoot, '.git', 'info', 'exclude'),
|
||||
];
|
||||
|
||||
// Always ignore .git directory regardless of .gitignore content
|
||||
this.ignorePatterns = ['.git/**', '.git'];
|
||||
|
||||
for (const gitIgnoreFile of gitIgnoreFiles) {
|
||||
try {
|
||||
const content = await fs.readFile(gitIgnoreFile, 'utf-8');
|
||||
const patterns = this.parseGitIgnoreContent(content);
|
||||
this.ignorePatterns.push(...patterns);
|
||||
} catch (_error) {
|
||||
// File doesn't exist or can't be read, continue silently
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private parseGitIgnoreContent(content: string): string[] {
|
||||
return content
|
||||
.split('\n')
|
||||
.map((line) => line.trim())
|
||||
.filter((line) => line && !line.startsWith('#'))
|
||||
.map((pattern) => {
|
||||
// Handle negation patterns (!) - for now we'll skip them
|
||||
if (pattern.startsWith('!')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Convert gitignore patterns to minimatch-compatible patterns
|
||||
if (pattern.endsWith('/')) {
|
||||
// Directory pattern - match directory and all contents
|
||||
const dirPattern = pattern.slice(0, -1); // Remove trailing slash
|
||||
return [dirPattern, dirPattern + '/**'];
|
||||
}
|
||||
|
||||
// If pattern doesn't contain /, it should match at any level
|
||||
if (!pattern.includes('/') && !pattern.startsWith('**/')) {
|
||||
return '**/' + pattern;
|
||||
}
|
||||
|
||||
return pattern;
|
||||
})
|
||||
.filter((pattern) => pattern !== null)
|
||||
.flat() as string[];
|
||||
}
|
||||
|
||||
isIgnored(filePath: string): boolean {
|
||||
// If not a git repository, nothing is ignored
|
||||
if (!this.isGitRepo) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Normalize the input path (handle ./ prefixes)
|
||||
let cleanPath = filePath;
|
||||
if (cleanPath.startsWith('./')) {
|
||||
cleanPath = cleanPath.slice(2);
|
||||
}
|
||||
|
||||
// Convert to relative path from project root
|
||||
const relativePath = path.relative(
|
||||
this.projectRoot,
|
||||
path.resolve(this.projectRoot, cleanPath),
|
||||
);
|
||||
|
||||
// Handle paths that go outside project root
|
||||
if (relativePath.startsWith('..')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Normalize path separators for cross-platform compatibility
|
||||
const normalizedPath = relativePath.replace(/\\/g, '/');
|
||||
|
||||
return this.ignorePatterns.some((pattern) =>
|
||||
minimatch(normalizedPath, pattern, {
|
||||
dot: true,
|
||||
matchBase: false,
|
||||
flipNegate: false,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
getIgnoredPatterns(): string[] {
|
||||
return [...this.ignorePatterns];
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
/**
|
||||
* Checks if a directory is within a git repository
|
||||
* @param directory The directory to check
|
||||
* @returns true if the directory is in a git repository, false otherwise
|
||||
*/
|
||||
export function isGitRepository(directory: string): boolean {
|
||||
try {
|
||||
let currentDir = path.resolve(directory);
|
||||
|
||||
while (true) {
|
||||
const gitDir = path.join(currentDir, '.git');
|
||||
|
||||
// Check if .git exists (either as directory or file for worktrees)
|
||||
if (fs.existsSync(gitDir)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
const parentDir = path.dirname(currentDir);
|
||||
|
||||
// If we've reached the root directory, stop searching
|
||||
if (parentDir === currentDir) {
|
||||
break;
|
||||
}
|
||||
|
||||
currentDir = parentDir;
|
||||
}
|
||||
|
||||
return false;
|
||||
} catch (_error) {
|
||||
// If any filesystem error occurs, assume not a git repo
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the root directory of a git repository
|
||||
* @param directory Starting directory to search from
|
||||
* @returns The git repository root path, or null if not in a git repository
|
||||
*/
|
||||
export function findGitRoot(directory: string): string | null {
|
||||
try {
|
||||
let currentDir = path.resolve(directory);
|
||||
|
||||
while (true) {
|
||||
const gitDir = path.join(currentDir, '.git');
|
||||
|
||||
if (fs.existsSync(gitDir)) {
|
||||
return currentDir;
|
||||
}
|
||||
|
||||
const parentDir = path.dirname(currentDir);
|
||||
|
||||
if (parentDir === currentDir) {
|
||||
break;
|
||||
}
|
||||
|
||||
currentDir = parentDir;
|
||||
}
|
||||
|
||||
return null;
|
||||
} catch (_error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue