Search additional roots

examples/api-tests/src/file-search.spec.js

@@ -64,8 +64,8 @@ describe('file-search', function () {
                 assert.equal(filterAndRange, quickFileOpenService['filterAndRangeDefault']);
             });
 
-            it('should update when searching', () => {
-                quickFileOpenService['getPicks']('a:2:1', new CancellationTokenSource().token); // perform a mock search.
+            it('should update when searching', async () => {
+                await quickFileOpenService['getPicks']('a:2:1', new CancellationTokenSource().token); // perform a mock search.
                 const filterAndRange = quickFileOpenService['filterAndRange'];
                 assert.equal(filterAndRange.filter, 'a');
                 assert.deepEqual(filterAndRange.range, { start: { line: 1, character: 0 }, end: { line: 1, character: 0 } });

packages/file-search/package.json

@@ -8,6 +8,7 @@
     "@theia/filesystem": "1.20.0",
     "@theia/monaco": "1.20.0",
     "@theia/process": "1.20.0",
+    "@theia/variable-resolver": "1.20.0",
     "@theia/workspace": "1.20.0",
     "vscode-ripgrep": "^1.2.4"
   },

packages/file-search/src/browser/quick-file-open.ts

@@ -15,7 +15,7 @@
  ********************************************************************************/
 
 import { inject, injectable, optional, postConstruct } from '@theia/core/shared/inversify';
-import { OpenerService, KeybindingRegistry, QuickAccessRegistry, QuickAccessProvider, CommonCommands } from '@theia/core/lib/browser';
+import { OpenerService, KeybindingRegistry, QuickAccessRegistry, QuickAccessProvider, CommonCommands, PreferenceService } from '@theia/core/lib/browser';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
 import URI from '@theia/core/lib/common/uri';
 import { FileSearchService, WHITESPACE_QUERY_SEPARATOR } from '../common/file-search-service';
@@ -27,6 +27,7 @@ import { MessageService } from '@theia/core/lib/common/message-service';
 import { FileSystemPreferences } from '@theia/filesystem/lib/browser';
 import { EditorOpenerOptions, EditorWidget, Position, Range } from '@theia/editor/lib/browser';
 import { findMatches, QuickInputService, QuickPickItem, QuickPicks } from '@theia/core/lib/browser/quick-input/quick-input-service';
+import { VariableResolverService } from '@theia/variable-resolver/lib/browser';
 
 export const quickFileOpen = Command.toDefaultLocalizedCommand({
     id: 'file-search.openFile',
@@ -66,6 +67,10 @@ export class QuickFileOpenService implements QuickAccessProvider {
     protected readonly messageService: MessageService;
     @inject(FileSystemPreferences)
     protected readonly fsPreferences: FileSystemPreferences;
+    @inject(PreferenceService)
+    protected readonly preferenceService: PreferenceService;
+    @inject(VariableResolverService)
+    protected readonly variableResolverService: VariableResolverService;
 
     registerQuickAccessProvider(): void {
         this.quickAccessRegistry.registerQuickAccessProvider({
@@ -153,9 +158,14 @@ export class QuickFileOpenService implements QuickAccessProvider {
         return undefined;
     }
 
-    async getPicks(filter: string, token: CancellationToken): Promise<QuickPicks> {
-        const roots = this.workspaceService.tryGetRoots();
+    async getRoots(): Promise<string[]> {
+        const workspaceRoots = this.workspaceService.tryGetRoots().map(r => r.resource.toString());
+        const additionalSearchRoots: string[] = this.preferenceService.get('search.additionalRoots') ?? [];
+        const resolvedAdditionalSearchRoots = await this.variableResolverService.resolveArray(additionalSearchRoots);
+        return [...workspaceRoots, ...resolvedAdditionalSearchRoots];
+    }
 
+    async getPicks(filter: string, token: CancellationToken): Promise<QuickPicks> {
         this.filterAndRange = this.splitFilterAndRange(filter);
         const fileFilter = this.filterAndRange.filter;
 
@@ -176,6 +186,7 @@ export class QuickFileOpenService implements QuickAccessProvider {
             }
         }
 
+        const roots = await this.getRoots();
         if (fileFilter.length > 0) {
             const handler = async (results: string[]) => {
                 if (token.isCancellationRequested || results.length <= 0) {
@@ -207,7 +218,7 @@ export class QuickFileOpenService implements QuickAccessProvider {
             };
 
             return this.fileSearchService.find(fileFilter, {
-                rootUris: roots.map(r => r.resource.toString()),
+                rootUris: roots,
                 fuzzyMatch: true,
                 limit: 200,
                 useGitIgnore: this.hideIgnoredFiles,

packages/file-search/tsconfig.json

@@ -24,6 +24,9 @@
     {
       "path": "../process"
     },
+    {
+      "path": "../variable-resolver"
+    },
     {
       "path": "../workspace"
     }

packages/search-in-workspace/package.json

@@ -8,6 +8,7 @@
     "@theia/filesystem": "1.20.0",
     "@theia/navigator": "1.20.0",
     "@theia/process": "1.20.0",
+    "@theia/variable-resolver": "1.20.0",
     "@theia/workspace": "1.20.0",
     "minimatch": "^3.0.4",
     "vscode-ripgrep": "^1.2.4"

packages/search-in-workspace/src/browser/search-in-workspace-preferences.ts

@@ -58,6 +58,11 @@ export const searchInWorkspacePreferencesSchema: PreferenceSchema = {
             description: nls.localizeByDefault('Controls whether to follow symlinks while searching.'),
             default: true,
             type: 'boolean',
+        },
+        'search.additionalRoots': {
+            description: nls.localize('theia/search-in-workspace/additionalRoots', 'Directories outside the current workspace that should be included in searches.'),
+            default: [],
+            type: 'array',
         }
     }
 };
@@ -70,6 +75,7 @@ export class SearchInWorkspaceConfiguration {
     'search.searchOnEditorModification': boolean;
     'search.smartCase': boolean;
     'search.followSymlinks': boolean;
+    'search.additionalRoots': string[];
 }
 
 export const SearchInWorkspacePreferenceContribution = Symbol('SearchInWorkspacePreferenceContribution');

packages/search-in-workspace/src/browser/search-in-workspace-service.ts

@@ -23,6 +23,8 @@ import {
 } from '../common/search-in-workspace-interface';
 import { WorkspaceService } from '@theia/workspace/lib/browser';
 import { ILogger } from '@theia/core';
+import { SearchInWorkspacePreferences } from './search-in-workspace-preferences';
+import { VariableResolverService } from '@theia/variable-resolver/lib/browser';
 
 /**
  * Class that will receive the search results from the server.  This is separate
@@ -72,6 +74,8 @@ export class SearchInWorkspaceService implements SearchInWorkspaceClient {
     @inject(SearchInWorkspaceClientImpl) protected readonly client: SearchInWorkspaceClientImpl;
     @inject(WorkspaceService) protected readonly workspaceService: WorkspaceService;
     @inject(ILogger) protected readonly logger: ILogger;
+    @inject(SearchInWorkspacePreferences) protected readonly searchInWorkspacePreferences: SearchInWorkspacePreferences;
+    @inject(VariableResolverService) protected readonly variableResolverService: VariableResolverService;
 
     @postConstruct()
     protected init(): void {
@@ -113,8 +117,15 @@ export class SearchInWorkspaceService implements SearchInWorkspaceClient {
             throw new Error('Search failed: no workspace root.');
         }
 
-        const roots = await this.workspaceService.roots;
-        return this.doSearch(what, roots.map(r => r.resource.toString()), callbacks, opts);
+        const roots = await this.getRoots();
+        return this.doSearch(what, roots, callbacks, opts);
+    }
+
+    async getRoots(): Promise<string[]> {
+        const workspaceRoots = (await this.workspaceService.roots).map(r => r.resource.toString());
+        const additionalSearchRoots = this.searchInWorkspacePreferences.get('search.additionalRoots');
+        const resolvedAdditionalSearchRoots = await this.variableResolverService.resolveArray(additionalSearchRoots);
+        return [...workspaceRoots, ...resolvedAdditionalSearchRoots];
     }
 
     protected async doSearch(what: string, rootsUris: string[], callbacks: SearchInWorkspaceCallbacks, opts?: SearchInWorkspaceOptions): Promise<number> {

packages/search-in-workspace/tsconfig.json

@@ -24,6 +24,9 @@
     {
       "path": "../process"
     },
+    {
+      "path": "../variable-resolver"
+    },
     {
       "path": "../workspace"
     }