Skip to content

Support includeIgnoredFiles option in search results #1868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support includeIgnoredFiles option in search results #1868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,10 @@
"maxResults": {
"type": "number",
"description": "The maximum number of results to return. Do not use this unless necessary, it can slow things down. By default, only some matches are returned. If you use this and don't see what you're looking for, you can try again with a more specific query or a larger maxResults."
},
"includeIgnoredFiles": {
"type": "boolean",
"description": "Whether to include files that would normally be ignored according to .gitignore, other ignore files and `files.exclude` and `search.exclude` settings."
}
},
"required": [
Expand Down
22 changes: 14 additions & 8 deletions src/extension/tools/node/findTextInFilesTool.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { count } from '../../../util/vs/base/common/strings';
import { URI } from '../../../util/vs/base/common/uri';
import { Position as EditorPosition } from '../../../util/vs/editor/common/core/position';
import { IInstantiationService } from '../../../util/vs/platform/instantiation/common/instantiation';
import { ExtendedLanguageModelToolResult, LanguageModelPromptTsxPart, Location, MarkdownString, Range } from '../../../vscodeTypes';
import { ExcludeSettingOptions, ExtendedLanguageModelToolResult, LanguageModelPromptTsxPart, Location, MarkdownString, Range } from '../../../vscodeTypes';
import { IBuildPromptContext } from '../../prompt/common/intents';
import { renderPromptElementJSON } from '../../prompts/node/base/promptRenderer';
import { Tag } from '../../prompts/node/base/tag';
Expand All @@ -31,6 +31,8 @@ interface IFindTextInFilesToolParams {
isRegexp?: boolean;
includePattern?: string;
maxResults?: number;
/** Whether to include files that would normally be ignored according to .gitignore, other ignore files and `files.exclude` and `search.exclude` settings. */
includeIgnoredFiles?: boolean;
}

const MaxResultsCap = 200;
Expand Down Expand Up @@ -62,7 +64,7 @@ export class FindTextInFilesTool implements ICopilotTool<IFindTextInFilesToolPar
const timeoutInMs = 20_000;

let results = await raceTimeoutAndCancellationError(
(searchToken) => this.searchAndCollectResults(options.input.query, isRegExp, patterns, maxResults, searchToken),
(searchToken) => this.searchAndCollectResults(options.input.query, isRegExp, patterns, maxResults, options.input.includeIgnoredFiles, searchToken),
token,
timeoutInMs,
// embed message to give LLM hint about what to do next
Expand All @@ -72,7 +74,7 @@ export class FindTextInFilesTool implements ICopilotTool<IFindTextInFilesToolPar
// If we still have no results, we need to try the opposite regex mode
if (!results.length && queryIsValidRegex) {
results = await raceTimeoutAndCancellationError(
(searchToken) => this.searchAndCollectResults(options.input.query, !isRegExp, patterns, maxResults, searchToken),
(searchToken) => this.searchAndCollectResults(options.input.query, !isRegExp, patterns, maxResults, options.input.includeIgnoredFiles, searchToken),
token,
timeoutInMs,
// embed message to give LLM hint about what to do next
Expand Down Expand Up @@ -126,16 +128,20 @@ export class FindTextInFilesTool implements ICopilotTool<IFindTextInFilesToolPar
}
}

private async searchAndCollectResults(query: string, isRegExp: boolean, patterns: vscode.GlobPattern[] | undefined, maxResults: number, token: CancellationToken): Promise<vscode.TextSearchResult2[]> {
private async searchAndCollectResults(query: string, isRegExp: boolean, patterns: vscode.GlobPattern[] | undefined, maxResults: number, includeIgnoredFiles: boolean | undefined, token: CancellationToken): Promise<vscode.TextSearchResult2[]> {
const findOptions = {
include: patterns ? patterns : undefined,
maxResults: maxResults + 1,
useExcludeSettings: includeIgnoredFiles ? ExcludeSettingOptions.None : ExcludeSettingOptions.SearchAndFilesExclude,
useIgnoreFiles: includeIgnoredFiles ? { local: false, parent: false, global: false } : undefined,
} as vscode.FindTextInFilesOptions2;

const searchResult = this.searchService.findTextInFiles2(
{
pattern: query,
isRegExp,
},
{
include: patterns ? patterns : undefined,
maxResults: maxResults + 1
},
findOptions,
token);
const results: vscode.TextSearchResult2[] = [];
for await (const item of searchResult.results) {
Expand Down
Loading