# 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>
364 lines
12 KiB
TypeScript
364 lines
12 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import { useState, useEffect, useCallback } from 'react';
|
|
import * as fs from 'fs/promises';
|
|
import * as path from 'path';
|
|
import {
|
|
isNodeError,
|
|
escapePath,
|
|
unescapePath,
|
|
getErrorMessage,
|
|
Config,
|
|
} from '@gemini-code/core';
|
|
import {
|
|
MAX_SUGGESTIONS_TO_SHOW,
|
|
Suggestion,
|
|
} from '../components/SuggestionsDisplay.js';
|
|
import { SlashCommand } from './slashCommandProcessor.js';
|
|
|
|
export interface UseCompletionReturn {
|
|
suggestions: Suggestion[];
|
|
activeSuggestionIndex: number;
|
|
visibleStartIndex: number;
|
|
showSuggestions: boolean;
|
|
isLoadingSuggestions: boolean;
|
|
setActiveSuggestionIndex: React.Dispatch<React.SetStateAction<number>>;
|
|
setShowSuggestions: React.Dispatch<React.SetStateAction<boolean>>;
|
|
resetCompletionState: () => void;
|
|
navigateUp: () => void;
|
|
navigateDown: () => void;
|
|
}
|
|
|
|
export function useCompletion(
|
|
query: string,
|
|
cwd: string,
|
|
isActive: boolean,
|
|
slashCommands: SlashCommand[],
|
|
config?: Config,
|
|
): UseCompletionReturn {
|
|
const [suggestions, setSuggestions] = useState<Suggestion[]>([]);
|
|
const [activeSuggestionIndex, setActiveSuggestionIndex] =
|
|
useState<number>(-1);
|
|
const [visibleStartIndex, setVisibleStartIndex] = useState<number>(0);
|
|
const [showSuggestions, setShowSuggestions] = useState<boolean>(false);
|
|
const [isLoadingSuggestions, setIsLoadingSuggestions] =
|
|
useState<boolean>(false);
|
|
|
|
const resetCompletionState = useCallback(() => {
|
|
setSuggestions([]);
|
|
setActiveSuggestionIndex(-1);
|
|
setVisibleStartIndex(0);
|
|
setShowSuggestions(false);
|
|
setIsLoadingSuggestions(false);
|
|
}, []);
|
|
|
|
const navigateUp = useCallback(() => {
|
|
if (suggestions.length === 0) return;
|
|
|
|
setActiveSuggestionIndex((prevActiveIndex) => {
|
|
// Calculate new active index, handling wrap-around
|
|
const newActiveIndex =
|
|
prevActiveIndex <= 0 ? suggestions.length - 1 : prevActiveIndex - 1;
|
|
|
|
// Adjust scroll position based on the new active index
|
|
setVisibleStartIndex((prevVisibleStart) => {
|
|
// Case 1: Wrapped around to the last item
|
|
if (
|
|
newActiveIndex === suggestions.length - 1 &&
|
|
suggestions.length > MAX_SUGGESTIONS_TO_SHOW
|
|
) {
|
|
return Math.max(0, suggestions.length - MAX_SUGGESTIONS_TO_SHOW);
|
|
}
|
|
// Case 2: Scrolled above the current visible window
|
|
if (newActiveIndex < prevVisibleStart) {
|
|
return newActiveIndex;
|
|
}
|
|
// Otherwise, keep the current scroll position
|
|
return prevVisibleStart;
|
|
});
|
|
|
|
return newActiveIndex;
|
|
});
|
|
}, [suggestions.length]);
|
|
|
|
const navigateDown = useCallback(() => {
|
|
if (suggestions.length === 0) return;
|
|
|
|
setActiveSuggestionIndex((prevActiveIndex) => {
|
|
// Calculate new active index, handling wrap-around
|
|
const newActiveIndex =
|
|
prevActiveIndex >= suggestions.length - 1 ? 0 : prevActiveIndex + 1;
|
|
|
|
// Adjust scroll position based on the new active index
|
|
setVisibleStartIndex((prevVisibleStart) => {
|
|
// Case 1: Wrapped around to the first item
|
|
if (
|
|
newActiveIndex === 0 &&
|
|
suggestions.length > MAX_SUGGESTIONS_TO_SHOW
|
|
) {
|
|
return 0;
|
|
}
|
|
// Case 2: Scrolled below the current visible window
|
|
const visibleEndIndex = prevVisibleStart + MAX_SUGGESTIONS_TO_SHOW;
|
|
if (newActiveIndex >= visibleEndIndex) {
|
|
return newActiveIndex - MAX_SUGGESTIONS_TO_SHOW + 1;
|
|
}
|
|
// Otherwise, keep the current scroll position
|
|
return prevVisibleStart;
|
|
});
|
|
|
|
return newActiveIndex;
|
|
});
|
|
}, [suggestions.length]);
|
|
|
|
useEffect(() => {
|
|
if (!isActive) {
|
|
resetCompletionState();
|
|
return;
|
|
}
|
|
|
|
const trimmedQuery = query.trimStart(); // Trim leading whitespace
|
|
|
|
// --- Handle Slash Command Completion ---
|
|
if (trimmedQuery.startsWith('/')) {
|
|
const partialCommand = trimmedQuery.substring(1);
|
|
const filteredSuggestions = slashCommands
|
|
.filter(
|
|
(cmd) =>
|
|
cmd.name.startsWith(partialCommand) ||
|
|
cmd.altName?.startsWith(partialCommand),
|
|
)
|
|
// Filter out ? and any other single character commands unless it's the only char
|
|
.filter((cmd) => {
|
|
const nameMatch = cmd.name.startsWith(partialCommand);
|
|
const altNameMatch = cmd.altName?.startsWith(partialCommand);
|
|
if (partialCommand.length === 1) {
|
|
return nameMatch || altNameMatch; // Allow single char match if query is single char
|
|
}
|
|
return (
|
|
(nameMatch && cmd.name.length > 1) ||
|
|
(altNameMatch && cmd.altName && cmd.altName.length > 1)
|
|
);
|
|
})
|
|
.filter((cmd) => cmd.description)
|
|
.map((cmd) => ({
|
|
label: cmd.name, // Always show the main name as label
|
|
value: cmd.name, // Value should be the main command name for execution
|
|
description: cmd.description,
|
|
}))
|
|
.sort((a, b) => a.label.localeCompare(b.label));
|
|
|
|
setSuggestions(filteredSuggestions);
|
|
setShowSuggestions(filteredSuggestions.length > 0);
|
|
setActiveSuggestionIndex(filteredSuggestions.length > 0 ? 0 : -1);
|
|
setVisibleStartIndex(0);
|
|
setIsLoadingSuggestions(false);
|
|
return;
|
|
}
|
|
|
|
// --- Handle At Command Completion ---
|
|
const atIndex = query.lastIndexOf('@');
|
|
if (atIndex === -1) {
|
|
resetCompletionState();
|
|
return;
|
|
}
|
|
|
|
const partialPath = query.substring(atIndex + 1);
|
|
const lastSlashIndex = partialPath.lastIndexOf('/');
|
|
const baseDirRelative =
|
|
lastSlashIndex === -1
|
|
? '.'
|
|
: partialPath.substring(0, lastSlashIndex + 1);
|
|
const prefix = unescapePath(
|
|
lastSlashIndex === -1
|
|
? partialPath
|
|
: partialPath.substring(lastSlashIndex + 1),
|
|
);
|
|
|
|
const baseDirAbsolute = path.resolve(cwd, baseDirRelative);
|
|
|
|
let isMounted = true;
|
|
|
|
const findFilesRecursively = async (
|
|
startDir: string,
|
|
searchPrefix: string,
|
|
fileDiscovery: { shouldIgnoreFile: (path: string) => boolean } | null,
|
|
currentRelativePath = '',
|
|
depth = 0,
|
|
maxDepth = 10, // Limit recursion depth
|
|
maxResults = 50, // Limit number of results
|
|
): Promise<Suggestion[]> => {
|
|
if (depth > maxDepth) {
|
|
return [];
|
|
}
|
|
|
|
const lowerSearchPrefix = searchPrefix.toLowerCase();
|
|
let foundSuggestions: Suggestion[] = [];
|
|
try {
|
|
const entries = await fs.readdir(startDir, { withFileTypes: true });
|
|
for (const entry of entries) {
|
|
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() ? '/' : ''),
|
|
value: escapePath(
|
|
entryPathRelative + (entry.isDirectory() ? '/' : ''),
|
|
),
|
|
});
|
|
}
|
|
if (
|
|
entry.isDirectory() &&
|
|
entry.name !== 'node_modules' &&
|
|
!entry.name.startsWith('.')
|
|
) {
|
|
if (foundSuggestions.length < maxResults) {
|
|
foundSuggestions = foundSuggestions.concat(
|
|
await findFilesRecursively(
|
|
path.join(startDir, entry.name),
|
|
searchPrefix, // Pass original searchPrefix for recursive calls
|
|
fileDiscovery,
|
|
entryPathRelative,
|
|
depth + 1,
|
|
maxDepth,
|
|
maxResults - foundSuggestions.length,
|
|
),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
} catch (_err) {
|
|
// Ignore errors like permission denied or ENOENT during recursive search
|
|
}
|
|
return foundSuggestions.slice(0, maxResults);
|
|
};
|
|
|
|
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,
|
|
fileDiscovery,
|
|
);
|
|
} else {
|
|
// Original behavior: list files in the specific directory
|
|
const lowerPrefix = prefix.toLowerCase();
|
|
const entries = await fs.readdir(baseDirAbsolute, {
|
|
withFileTypes: true,
|
|
});
|
|
|
|
// 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
|
|
fetchedSuggestions.sort((a, b) => {
|
|
const depthA = (a.label.match(/\//g) || []).length;
|
|
const depthB = (b.label.match(/\//g) || []).length;
|
|
|
|
if (depthA !== depthB) {
|
|
return depthA - depthB;
|
|
}
|
|
|
|
const aIsDir = a.label.endsWith('/');
|
|
const bIsDir = b.label.endsWith('/');
|
|
if (aIsDir && !bIsDir) return -1;
|
|
if (!aIsDir && bIsDir) return 1;
|
|
|
|
return a.label.localeCompare(b.label);
|
|
});
|
|
|
|
if (isMounted) {
|
|
setSuggestions(fetchedSuggestions);
|
|
setShowSuggestions(fetchedSuggestions.length > 0);
|
|
setActiveSuggestionIndex(fetchedSuggestions.length > 0 ? 0 : -1);
|
|
setVisibleStartIndex(0);
|
|
}
|
|
} catch (error: unknown) {
|
|
if (isNodeError(error) && error.code === 'ENOENT') {
|
|
if (isMounted) {
|
|
setSuggestions([]);
|
|
setShowSuggestions(false);
|
|
}
|
|
} else {
|
|
console.error(
|
|
`Error fetching completion suggestions for ${partialPath}: ${getErrorMessage(error)}`,
|
|
);
|
|
if (isMounted) {
|
|
resetCompletionState();
|
|
}
|
|
}
|
|
}
|
|
if (isMounted) {
|
|
setIsLoadingSuggestions(false);
|
|
}
|
|
};
|
|
|
|
const debounceTimeout = setTimeout(fetchSuggestions, 100);
|
|
|
|
return () => {
|
|
isMounted = false;
|
|
clearTimeout(debounceTimeout);
|
|
};
|
|
}, [query, cwd, isActive, resetCompletionState, slashCommands, config]);
|
|
|
|
return {
|
|
suggestions,
|
|
activeSuggestionIndex,
|
|
visibleStartIndex,
|
|
showSuggestions,
|
|
isLoadingSuggestions,
|
|
setActiveSuggestionIndex,
|
|
setShowSuggestions,
|
|
resetCompletionState,
|
|
navigateUp,
|
|
navigateDown,
|
|
};
|
|
}
|