update FindFiles2 to make options clearer

extensions/vscode-api-tests/src/singlefolder-tests/workspace.test.ts

@@ -604,13 +604,13 @@ suite('vscode API - workspace', () => {
 	});
 
 	test('findFiles2 - null exclude', async () => {
-		await vscode.workspace.findFiles2('**/file.txt', { useDefaultExcludes: true, useDefaultSearchExcludes: false }).then((res) => {
+		await vscode.workspace.findFiles2('**/file.txt', { excludeSettings: vscode.ExcludeSettingOptions.filesExclude }).then((res) => {
 			// file.exclude folder is still searched, search.exclude folder is not
 			assert.strictEqual(res.length, 1);
 			assert.strictEqual(basename(vscode.workspace.asRelativePath(res[0])), 'file.txt');
 		});
 
-		await vscode.workspace.findFiles2('**/file.txt', { useDefaultExcludes: false, useDefaultSearchExcludes: false }).then((res) => {
+		await vscode.workspace.findFiles2('**/file.txt', { excludeSettings: vscode.ExcludeSettingOptions.none }).then((res) => {
 			// search.exclude and files.exclude folders are both searched
 			assert.strictEqual(res.length, 2);
 			assert.strictEqual(basename(vscode.workspace.asRelativePath(res[0])), 'file.txt');

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -105,7 +105,7 @@ import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/c
 import { UIKind } from 'vs/workbench/services/extensions/common/extensionHostProtocol';
 import { checkProposedApiEnabled, isProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions';
 import { ProxyIdentifier } from 'vs/workbench/services/extensions/common/proxyIdentifier';
-import { TextSearchCompleteMessageType } from 'vs/workbench/services/search/common/searchExtTypes';
+import { ExcludeSettingOptions, SearchIgnoreOptions, TextSearchCompleteMessageType } from 'vs/workbench/services/search/common/searchExtTypes';
 import type * as vscode from 'vscode';
 
 export interface IExtensionRegistries {
@@ -1725,6 +1725,8 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 			NewSymbolNameTriggerKind: extHostTypes.NewSymbolNameTriggerKind,
 			InlineEdit: extHostTypes.InlineEdit,
 			InlineEditTriggerKind: extHostTypes.InlineEditTriggerKind,
+			SearchIgnoreOptions: SearchIgnoreOptions,
+			ExcludeSettingOptions: ExcludeSettingOptions,
 		};
 	};
 }

src/vs/workbench/api/common/extHostWorkspace.ts

@@ -460,9 +460,8 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspac
 		return this._findFilesImpl(include, undefined, {
 			exclude: excludeString,
 			maxResults,
-			useDefaultExcludes: useFileExcludes,
-			useDefaultSearchExcludes: false,
-			useIgnoreFiles: false
+			excludeSettings: useFileExcludes ? vscode.ExcludeSettingOptions.filesExclude : vscode.ExcludeSettingOptions.none,
+			ignoreFilesToUse: vscode.SearchIgnoreOptions.none
 		}, token);
 	}
 
@@ -474,6 +473,85 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspac
 		return this._findFilesImpl(undefined, filePattern, options, token);
 	}
 
+	private _parseIgnoreFileSettings(options: vscode.FindFiles2Options): {
+		disregardLocalIgnoreFiles: boolean | undefined;
+		disregardParentIgnoreFiles: boolean | undefined;
+		disregardGlobalIgnoreFiles: boolean | undefined;
+	} {
+
+		let disregardLocalIgnoreFiles: boolean | undefined = undefined;
+		let disregardParentIgnoreFiles: boolean | undefined = undefined;
+		let disregardGlobalIgnoreFiles: boolean | undefined = undefined;
+
+		if (options.excludeSettings) {
+			switch (options.ignoreFilesToUse) {
+				case vscode.SearchIgnoreOptions.none:
+					disregardLocalIgnoreFiles = true;
+					disregardParentIgnoreFiles = true;
+					disregardGlobalIgnoreFiles = true;
+					break;
+				case vscode.SearchIgnoreOptions.localOnly:
+					disregardLocalIgnoreFiles = false;
+					disregardParentIgnoreFiles = true;
+					disregardGlobalIgnoreFiles = true;
+					break;
+				case vscode.SearchIgnoreOptions.localAndFollowSettings:
+					disregardLocalIgnoreFiles = false;
+					break;
+				case vscode.SearchIgnoreOptions.localAndParent:
+					disregardLocalIgnoreFiles = false;
+					disregardParentIgnoreFiles = false;
+					disregardGlobalIgnoreFiles = true;
+					break;
+				case vscode.SearchIgnoreOptions.localAndGlobal:
+					disregardLocalIgnoreFiles = false;
+					disregardParentIgnoreFiles = true;
+					disregardGlobalIgnoreFiles = false;
+					break;
+				case vscode.SearchIgnoreOptions.all:
+					disregardLocalIgnoreFiles = false;
+					disregardParentIgnoreFiles = false;
+					disregardGlobalIgnoreFiles = false;
+					break;
+				default:
+					// vscode.SearchIgnoreOptions.followSettings also follows this
+					break;
+			}
+		}
+
+		return {
+			disregardLocalIgnoreFiles,
+			disregardParentIgnoreFiles,
+			disregardGlobalIgnoreFiles
+		};
+	}
+
+	private _parseShouldUseExcludeSetting(options: vscode.FindFiles2Options): {
+		disregardExcludeSettings: boolean;
+		disregardSearchExcludeSettings: boolean;
+	} {
+
+		let disregardExcludeSettings: boolean = false;
+		let disregardSearchExcludeSettings: boolean = false;
+
+		if (options.excludeSettings) {
+			switch (options.excludeSettings) {
+				case vscode.ExcludeSettingOptions.none:
+					disregardExcludeSettings = true;
+					disregardSearchExcludeSettings = true;
+					break;
+				case vscode.ExcludeSettingOptions.filesExclude:
+					disregardSearchExcludeSettings = true;
+					break;
+				default:
+					// includes the case for vscode.ExcludeSettingOptions.searchAndFilesExclude
+					break;
+			}
+		}
+
+		return { disregardExcludeSettings, disregardSearchExcludeSettings };
+	}
+
 	private async _findFilesImpl(
 		// the old `findFiles` used `include` to query, but the new `findFiles2` uses `filePattern` to query.
 		// `filePattern` is the proper way to handle this, since it takes less precedence than the ignore files.
@@ -488,13 +566,16 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspac
 		const excludePattern = (typeof options.exclude === 'string') ? options.exclude :
 			options.exclude ? options.exclude.pattern : undefined;
 
+		const shouldUseExcludeSetting = this._parseShouldUseExcludeSetting(options);
+		const ignoreFileSettings = this._parseIgnoreFileSettings(options);
+
 		const fileQueries = <IFileQueryBuilderOptions>{
 			ignoreSymlinks: typeof options.followSymlinks === 'boolean' ? !options.followSymlinks : undefined,
-			disregardIgnoreFiles: typeof options.useIgnoreFiles === 'boolean' ? !options.useIgnoreFiles : undefined,
-			disregardGlobalIgnoreFiles: typeof options.useGlobalIgnoreFiles === 'boolean' ? !options.useGlobalIgnoreFiles : undefined,
-			disregardParentIgnoreFiles: typeof options.useParentIgnoreFiles === 'boolean' ? !options.useParentIgnoreFiles : undefined,
-			disregardExcludeSettings: typeof options.useDefaultExcludes === 'boolean' ? !options.useDefaultExcludes : false,
-			disregardSearchExcludeSettings: typeof options.useDefaultSearchExcludes === 'boolean' ? !options.useDefaultSearchExcludes : false,
+			disregardIgnoreFiles: ignoreFileSettings.disregardLocalIgnoreFiles,
+			disregardGlobalIgnoreFiles: ignoreFileSettings.disregardGlobalIgnoreFiles,
+			disregardParentIgnoreFiles: ignoreFileSettings.disregardParentIgnoreFiles,
+			disregardExcludeSettings: shouldUseExcludeSetting.disregardExcludeSettings,
+			disregardSearchExcludeSettings: shouldUseExcludeSetting.disregardSearchExcludeSettings,
 			maxResults: options.maxResults,
 			excludePattern: excludePattern,
 			shouldGlobSearch: typeof options.fuzzy === 'boolean' ? !options.fuzzy : true,

src/vs/workbench/api/test/browser/extHostWorkspace.test.ts

@@ -26,6 +26,7 @@ import { FileSystemProviderCapabilities } from 'vs/platform/files/common/files';
 import { nullExtensionDescription as extensionDescriptor } from 'vs/workbench/services/extensions/common/extensions';
 import { IURITransformerService } from 'vs/workbench/api/common/extHostUriTransformerService';
 import { ensureNoDisposablesAreLeakedInTestSuite } from 'vs/base/test/common/utils';
+import { ExcludeSettingOptions, SearchIgnoreOptions } from 'vscode';
 
 function createExtHostWorkspace(mainContext: IMainContext, data: IWorkspaceData, logService: ILogService): ExtHostWorkspace {
 	const result = new ExtHostWorkspace(
@@ -710,7 +711,7 @@ suite('ExtHostWorkspace', function () {
 		});
 
 		const ws = createExtHostWorkspace(rpcProtocol, { id: 'foo', folders: [aWorkspaceFolderData(URI.file(root), 0)], name: 'Test' }, new NullLogService());
-		return ws.findFiles2('foo', { maxResults: 10, useDefaultExcludes: true }, new ExtensionIdentifier('test')).then(() => {
+		return ws.findFiles2('foo', { maxResults: 10, excludeSettings: ExcludeSettingOptions.searchAndFilesExclude }, new ExtensionIdentifier('test')).then(() => {
 			assert(mainThreadCalled, 'mainThreadCalled');
 		});
 	});
@@ -825,7 +826,7 @@ suite('ExtHostWorkspace', function () {
 		});
 
 		const ws = createExtHostWorkspace(rpcProtocol, { id: 'foo', folders: [aWorkspaceFolderData(URI.file(root), 0)], name: 'Test' }, new NullLogService());
-		return ws.findFiles2('', { useIgnoreFiles: true, useParentIgnoreFiles: true, useGlobalIgnoreFiles: true }, new ExtensionIdentifier('test')).then(() => {
+		return ws.findFiles2('', { ignoreFilesToUse: SearchIgnoreOptions.all }, new ExtensionIdentifier('test')).then(() => {
 			assert(mainThreadCalled, 'mainThreadCalled');
 		});
 	});

src/vs/workbench/services/search/common/searchExtTypes.ts

@@ -277,6 +277,28 @@ export interface TextSearchCompleteMessage {
 	type: TextSearchCompleteMessageType;
 }
 
+/*
+ * Options for following search.exclude and files.exclude settings.
+ */
+export enum ExcludeSettingOptions {
+	none = 1,
+	filesExclude = 2,
+	searchAndFilesExclude = 3,
+}
+
+/*
+ * Which locations of .gitignore and .ignore files to follow when searching.
+*/
+export enum SearchIgnoreOptions {
+	none = 1,
+	localOnly = 2,
+	localAndFollowSettings = 3,
+	localAndParent = 4,
+	localAndGlobal = 5,
+	all = 6,
+	followSettings = 7,
+}
+
 /**
  * Information collected when text search is complete.
  */

src/vscode-dts/vscode.proposed.findFiles2.d.ts

@@ -15,42 +15,20 @@ declare module 'vscode' {
 		exclude?: GlobPattern;
 
 		/**
-		 * Whether to use the values for files.exclude. Defaults to true.
+		 * Which settings to follow when searching for files. Defaults to {@link ExcludeSettingOptions.searchAndFilesExclude}.
 		 */
-		useDefaultExcludes?: boolean;
-
-		/**
-		 * Whether to use the values for search.exclude. Defaults to true. Will not be followed if `useDefaultExcludes` is set to `false`.
-		 */
-		useDefaultSearchExcludes?: boolean;
+		excludeSettings?: ExcludeSettingOptions;
 
 		/**
 		 * The maximum number of results to search for
 		 */
 		maxResults?: number;
 
 		/**
-		 * Whether external files that exclude files, like .gitignore, should be respected.
-		 * Defaults to the value for `search.useIgnoreFiles` in settings.
-		 * For more info, see the setting listed above.
-		 */
-		useIgnoreFiles?: boolean;
-
-		/**
-		 * Whether global files that exclude files, like .gitignore, should be respected.
-		 * Must set `useIgnoreFiles` to `true` to use this.
-		 * Defaults to the value for `search.useGlobalIgnoreFiles` in settings.
-		 * For more info, see the setting listed above.
+		 * Which file locations we should look for ignore (.gitignore or .ignore) files to follow.
+		 * Defaults to {@link SearchIgnoreOptions.followSettings}.
 		 */
-		useGlobalIgnoreFiles?: boolean;
-
-		/**
-		 * Whether files in parent directories that exclude files, like .gitignore, should be respected.
-		 * Must set `useIgnoreFiles` to `true` to use this.
-		 * Defaults to the value for `search.useParentIgnoreFiles` in settings.
-		 * For more info, see the setting listed above.
-		 */
-		useParentIgnoreFiles?: boolean;
+		ignoreFilesToUse?: SearchIgnoreOptions;
 
 		/**
 		 * Whether symlinks should be followed while searching.
@@ -66,6 +44,73 @@ declare module 'vscode' {
 		fuzzy?: boolean;
 	}
 
+	/*
+	 * Options for following search.exclude and files.exclude settings.
+	 */
+	export enum ExcludeSettingOptions {
+		/*
+		 * Don't use any exclude settings.
+		 */
+		none = 1,
+		/*
+		 * Use:
+		 * - files.exclude setting
+		 */
+		filesExclude = 2,
+		/*
+		 * Use:
+		 * - files.exclude setting
+		 * - search.exclude setting
+		 */
+		searchAndFilesExclude = 3
+	}
+
+	/*
+	 * Which locations of .gitignore and .ignore files to follow when searching.
+	*/
+	export enum SearchIgnoreOptions {
+		/*
+		 * Don't use ignore files.
+		 */
+		none = 1,
+		/*
+		 * Use:
+		 * - ignore files at the workspace root.
+		 */
+		localOnly = 2,
+		/*
+		 * Use:
+		 * - ignore files at the workspace root.
+		 *
+		 * Follow `search.useParentIgnoreFiles`and `search.useGlobalIgnoreFiles` in settings
+		 * to dictate whether to use parent and global ignore files.
+		 */
+		localAndFollowSettings = 3,
+		/*
+		 * Use:
+		 * - ignore files at the workspace root.
+		 * - ignore files directly under parent folder(s) of the workspace root.
+		 */
+		localAndParent = 4,
+		/*
+		 * Use:
+		 * - ignore files at the workspace root.
+		 * - global ignore files (e.g. $HOME/.config/git/ignore).
+		 */
+		localAndGlobal = 5,
+		/*
+		 * Use:
+		 * - ignore files at the workspace root.
+		 * - ignore files directly under parent folder(s) of the workspace root.
+		 * - global ignore files (e.g. $HOME/.config/git/ignore).
+		 */
+		all = 6,
+		/*
+		* Follow `search.useIgnoreFiles`, `search.useParentIgnoreFiles`, and `search.useGlobalIgnoreFiles` in settings.
+		*/
+		followSettings = 7,
+	}
+
 	/**
 	 * Represents a session of a currently logged in user.
 	 */