@theia/file-search 1.45.0 → 1.46.0-next.72

package/src/node/file-search-service-impl.ts

@@ -1,187 +1,187 @@
-// *****************************************************************************
-// Copyright (C) 2017 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as cp from 'child_process';
-import * as fuzzy from '@theia/core/shared/fuzzy';
-import * as readline from 'readline';
-import { rgPath } from '@vscode/ripgrep';
-import { injectable, inject } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { FileUri } from '@theia/core/lib/node/file-uri';
-import { CancellationTokenSource, CancellationToken, ILogger, isWindows } from '@theia/core';
-import { RawProcessFactory } from '@theia/process/lib/node';
-import { FileSearchService, WHITESPACE_QUERY_SEPARATOR } from '../common/file-search-service';
-import * as path from 'path';
-
-@injectable()
-export class FileSearchServiceImpl implements FileSearchService {
-
-    constructor(
-        @inject(ILogger) protected readonly logger: ILogger,
-        /** @deprecated since 1.7.0 */
-        @inject(RawProcessFactory) protected readonly rawProcessFactory: RawProcessFactory,
-    ) { }
-
-    async find(searchPattern: string, options: FileSearchService.Options, clientToken?: CancellationToken): Promise<string[]> {
-        const cancellationSource = new CancellationTokenSource();
-        if (clientToken) {
-            clientToken.onCancellationRequested(() => cancellationSource.cancel());
-        }
-        const token = cancellationSource.token;
-        const opts = {
-            fuzzyMatch: true,
-            limit: Number.MAX_SAFE_INTEGER,
-            useGitIgnore: true,
-            ...options
-        };
-
-        const roots: FileSearchService.RootOptions = options.rootOptions || {};
-        if (options.rootUris) {
-            for (const rootUri of options.rootUris) {
-                if (!roots[rootUri]) {
-                    roots[rootUri] = {};
-                }
-            }
-        }
-        // eslint-disable-next-line guard-for-in
-        for (const rootUri in roots) {
-            const rootOptions = roots[rootUri];
-            if (opts.includePatterns) {
-                const includePatterns = rootOptions.includePatterns || [];
-                rootOptions.includePatterns = [...includePatterns, ...opts.includePatterns];
-            }
-            if (opts.excludePatterns) {
-                const excludePatterns = rootOptions.excludePatterns || [];
-                rootOptions.excludePatterns = [...excludePatterns, ...opts.excludePatterns];
-            }
-            if (rootOptions.useGitIgnore === undefined) {
-                rootOptions.useGitIgnore = opts.useGitIgnore;
-            }
-        }
-
-        const exactMatches = new Set<string>();
-        const fuzzyMatches = new Set<string>();
-
-        if (isWindows) {
-            // Allow users on Windows to search for paths using either forwards or backwards slash
-            searchPattern = searchPattern.replace(/\//g, '\\');
-        }
-
-        const patterns = searchPattern.toLocaleLowerCase().trim().split(WHITESPACE_QUERY_SEPARATOR);
-
-        await Promise.all(Object.keys(roots).map(async root => {
-            try {
-                const rootUri = new URI(root);
-                const rootPath = FileUri.fsPath(rootUri);
-                const rootOptions = roots[root];
-
-                await this.doFind(rootUri, rootOptions, candidate => {
-
-                    // Convert OS-native candidate path to a file URI string
-                    const fileUri = FileUri.create(path.resolve(rootPath, candidate)).toString();
-
-                    // Skip results that have already been matched.
-                    if (exactMatches.has(fileUri) || fuzzyMatches.has(fileUri)) {
-                        return;
-                    }
-
-                    // Determine if the candidate matches any of the patterns exactly or fuzzy
-                    const candidatePattern = candidate.toLocaleLowerCase();
-                    const patternExists = patterns.every(pattern => candidatePattern.indexOf(pattern) !== -1);
-                    if (patternExists) {
-                        exactMatches.add(fileUri);
-                    } else if (!searchPattern || searchPattern === '*') {
-                        exactMatches.add(fileUri);
-                    } else {
-                        const fuzzyPatternExists = patterns.every(pattern => fuzzy.test(pattern, candidate));
-                        if (opts.fuzzyMatch && fuzzyPatternExists) {
-                            fuzzyMatches.add(fileUri);
-                        }
-                    }
-
-                    // Preemptively terminate the search when the list of exact matches reaches the limit.
-                    if (exactMatches.size === opts.limit) {
-                        cancellationSource.cancel();
-                    }
-                }, token);
-            } catch (e) {
-                console.error('Failed to search:', root, e);
-            }
-        }));
-
-        if (clientToken && clientToken.isCancellationRequested) {
-            return [];
-        }
-        // Return the list of results limited by the search limit.
-        return [...exactMatches, ...fuzzyMatches].slice(0, opts.limit);
-    }
-
-    protected doFind(rootUri: URI, options: FileSearchService.BaseOptions, accept: (fileUri: string) => void, token: CancellationToken): Promise<void> {
-        return new Promise((resolve, reject) => {
-            const cwd = FileUri.fsPath(rootUri);
-            const args = this.getSearchArgs(options);
-            const ripgrep = cp.spawn(rgPath, args, { cwd });
-            ripgrep.on('error', reject);
-            ripgrep.on('exit', (code, signal) => {
-                if (typeof code === 'number' && code !== 0) {
-                    reject(new Error(`"${rgPath}" exited with code: ${code}`));
-                } else if (typeof signal === 'string') {
-                    reject(new Error(`"${rgPath}" was terminated by signal: ${signal}`));
-                }
-            });
-            token.onCancellationRequested(() => {
-                ripgrep.kill(); // most likely sends a signal.
-                resolve(); // avoid rejecting for no good reason.
-            });
-            const lineReader = readline.createInterface({
-                input: ripgrep.stdout,
-                crlfDelay: Infinity,
-            });
-            lineReader.on('line', line => {
-                if (!token.isCancellationRequested) {
-                    accept(line);
-                }
-            });
-            lineReader.on('close', () => resolve());
-        });
-    }
-
-    protected getSearchArgs(options: FileSearchService.BaseOptions): string[] {
-        const args = ['--files', '--hidden', '--case-sensitive', '--no-require-git', '--no-config'];
-        if (options.includePatterns) {
-            for (const includePattern of options.includePatterns) {
-                if (includePattern) {
-                    args.push('--glob', includePattern);
-                }
-            }
-        }
-        if (options.excludePatterns) {
-            for (const excludePattern of options.excludePatterns) {
-                if (excludePattern) {
-                    args.push('--glob', `!${excludePattern}`);
-                }
-            }
-        }
-        if (options.useGitIgnore) {
-            // ripgrep follows `.gitignore` by default, but it doesn't exclude `.git`:
-            args.push('--glob', '!.git');
-        } else {
-            args.push('--no-ignore');
-        }
-        return args;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as cp from 'child_process';
+import * as fuzzy from '@theia/core/shared/fuzzy';
+import * as readline from 'readline';
+import { rgPath } from '@vscode/ripgrep';
+import { injectable, inject } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { FileUri } from '@theia/core/lib/common/file-uri';
+import { CancellationTokenSource, CancellationToken, ILogger, isWindows } from '@theia/core';
+import { RawProcessFactory } from '@theia/process/lib/node';
+import { FileSearchService, WHITESPACE_QUERY_SEPARATOR } from '../common/file-search-service';
+import * as path from 'path';
+
+@injectable()
+export class FileSearchServiceImpl implements FileSearchService {
+
+    constructor(
+        @inject(ILogger) protected readonly logger: ILogger,
+        /** @deprecated since 1.7.0 */
+        @inject(RawProcessFactory) protected readonly rawProcessFactory: RawProcessFactory,
+    ) { }
+
+    async find(searchPattern: string, options: FileSearchService.Options, clientToken?: CancellationToken): Promise<string[]> {
+        const cancellationSource = new CancellationTokenSource();
+        if (clientToken) {
+            clientToken.onCancellationRequested(() => cancellationSource.cancel());
+        }
+        const token = cancellationSource.token;
+        const opts = {
+            fuzzyMatch: true,
+            limit: Number.MAX_SAFE_INTEGER,
+            useGitIgnore: true,
+            ...options
+        };
+
+        const roots: FileSearchService.RootOptions = options.rootOptions || {};
+        if (options.rootUris) {
+            for (const rootUri of options.rootUris) {
+                if (!roots[rootUri]) {
+                    roots[rootUri] = {};
+                }
+            }
+        }
+        // eslint-disable-next-line guard-for-in
+        for (const rootUri in roots) {
+            const rootOptions = roots[rootUri];
+            if (opts.includePatterns) {
+                const includePatterns = rootOptions.includePatterns || [];
+                rootOptions.includePatterns = [...includePatterns, ...opts.includePatterns];
+            }
+            if (opts.excludePatterns) {
+                const excludePatterns = rootOptions.excludePatterns || [];
+                rootOptions.excludePatterns = [...excludePatterns, ...opts.excludePatterns];
+            }
+            if (rootOptions.useGitIgnore === undefined) {
+                rootOptions.useGitIgnore = opts.useGitIgnore;
+            }
+        }
+
+        const exactMatches = new Set<string>();
+        const fuzzyMatches = new Set<string>();
+
+        if (isWindows) {
+            // Allow users on Windows to search for paths using either forwards or backwards slash
+            searchPattern = searchPattern.replace(/\//g, '\\');
+        }
+
+        const patterns = searchPattern.toLocaleLowerCase().trim().split(WHITESPACE_QUERY_SEPARATOR);
+
+        await Promise.all(Object.keys(roots).map(async root => {
+            try {
+                const rootUri = new URI(root);
+                const rootPath = FileUri.fsPath(rootUri);
+                const rootOptions = roots[root];
+
+                await this.doFind(rootUri, rootOptions, candidate => {
+
+                    // Convert OS-native candidate path to a file URI string
+                    const fileUri = FileUri.create(path.resolve(rootPath, candidate)).toString();
+
+                    // Skip results that have already been matched.
+                    if (exactMatches.has(fileUri) || fuzzyMatches.has(fileUri)) {
+                        return;
+                    }
+
+                    // Determine if the candidate matches any of the patterns exactly or fuzzy
+                    const candidatePattern = candidate.toLocaleLowerCase();
+                    const patternExists = patterns.every(pattern => candidatePattern.indexOf(pattern) !== -1);
+                    if (patternExists) {
+                        exactMatches.add(fileUri);
+                    } else if (!searchPattern || searchPattern === '*') {
+                        exactMatches.add(fileUri);
+                    } else {
+                        const fuzzyPatternExists = patterns.every(pattern => fuzzy.test(pattern, candidate));
+                        if (opts.fuzzyMatch && fuzzyPatternExists) {
+                            fuzzyMatches.add(fileUri);
+                        }
+                    }
+
+                    // Preemptively terminate the search when the list of exact matches reaches the limit.
+                    if (exactMatches.size === opts.limit) {
+                        cancellationSource.cancel();
+                    }
+                }, token);
+            } catch (e) {
+                console.error('Failed to search:', root, e);
+            }
+        }));
+
+        if (clientToken && clientToken.isCancellationRequested) {
+            return [];
+        }
+        // Return the list of results limited by the search limit.
+        return [...exactMatches, ...fuzzyMatches].slice(0, opts.limit);
+    }
+
+    protected doFind(rootUri: URI, options: FileSearchService.BaseOptions, accept: (fileUri: string) => void, token: CancellationToken): Promise<void> {
+        return new Promise((resolve, reject) => {
+            const cwd = FileUri.fsPath(rootUri);
+            const args = this.getSearchArgs(options);
+            const ripgrep = cp.spawn(rgPath, args, { cwd });
+            ripgrep.on('error', reject);
+            ripgrep.on('exit', (code, signal) => {
+                if (typeof code === 'number' && code !== 0) {
+                    reject(new Error(`"${rgPath}" exited with code: ${code}`));
+                } else if (typeof signal === 'string') {
+                    reject(new Error(`"${rgPath}" was terminated by signal: ${signal}`));
+                }
+            });
+            token.onCancellationRequested(() => {
+                ripgrep.kill(); // most likely sends a signal.
+                resolve(); // avoid rejecting for no good reason.
+            });
+            const lineReader = readline.createInterface({
+                input: ripgrep.stdout,
+                crlfDelay: Infinity,
+            });
+            lineReader.on('line', line => {
+                if (!token.isCancellationRequested) {
+                    accept(line);
+                }
+            });
+            lineReader.on('close', () => resolve());
+        });
+    }
+
+    protected getSearchArgs(options: FileSearchService.BaseOptions): string[] {
+        const args = ['--files', '--hidden', '--case-sensitive', '--no-require-git', '--no-config'];
+        if (options.includePatterns) {
+            for (const includePattern of options.includePatterns) {
+                if (includePattern) {
+                    args.push('--glob', includePattern);
+                }
+            }
+        }
+        if (options.excludePatterns) {
+            for (const excludePattern of options.excludePatterns) {
+                if (excludePattern) {
+                    args.push('--glob', `!${excludePattern}`);
+                }
+            }
+        }
+        if (options.useGitIgnore) {
+            // ripgrep follows `.gitignore` by default, but it doesn't exclude `.git`:
+            args.push('--glob', '!.git');
+        } else {
+            args.push('--no-ignore');
+        }
+        return args;
+    }
+
+}