src/vs/workbench/services/search/node/ripgrepFileSearch.ts
184 LOC · 44 covered · 140 uncovered · 11 ranges · 62 concepts · 2 introducers · 33 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
ripgrepFileSearch.ts ×8
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import * as cp from 'child_process';
7
>
import * as path from '../../../../base/common/path.js';
8
>
import * as glob from '../../../../base/common/glob.js';
9
>
import { normalizeNFD } from '../../../../base/common/normalization.js';
10
>
import * as extpath from '../../../../base/common/extpath.js';
11
>
import { isMacintosh as isMac } from '../../../../base/common/platform.js';
12
>
import * as strings from '../../../../base/common/strings.js';
13
>
import { IFileQuery, IFolderQuery } from '../common/search.js';
14
>
import { anchorGlob } from './ripgrepSearchUtils.js';
15
>
import { rgDiskPath } from '../../../../base/node/ripgrep.js';
16
>
17
export async function spawnRipgrepCmd(config: IFileQuery, folderQuery: IFolderQuery, includePattern?: glob.IExpression, excludePattern?: glob.IExpression, numThreads?: number) {
18
const rgArgs = getRgArgs(config, folderQuery, includePattern, excludePattern, numThreads);
19
const cwd = folderQuery.folder.fsPath;
20
const resolvedRgDiskPath = await rgDiskPath();
21
return {
22
cmd: cp.spawn(resolvedRgDiskPath, rgArgs.args, { cwd }),
23
rgDiskPath: resolvedRgDiskPath,
24
siblingClauses: rgArgs.siblingClauses,
25
rgArgs,
26
cwd
27
};
28
}
30
function getRgArgs(config: IFileQuery, folderQuery: IFolderQuery, includePattern?: glob.IExpression, excludePattern?: glob.IExpression, numThreads?: number) {
31
const args = ['--files', '--hidden', '--case-sensitive', '--no-require-git'];
32
33
if (config.ignoreGlobCase || folderQuery.ignoreGlobCase) {
34
args.push('--glob-case-insensitive');
35
args.push('--ignore-file-case-insensitive');
36
}
37
38
// includePattern can't have siblingClauses
39
foldersToIncludeGlobs([folderQuery], includePattern, false).forEach(globArg => {
40
const inclusion = anchorGlob(globArg);
41
args.push('-g', inclusion);
42
if (isMac) {
43
const normalized = normalizeNFD(inclusion);
44
if (normalized !== inclusion) {
45
args.push('-g', normalized);
46
}
47
}
48
});
49
50
const rgGlobs = foldersToRgExcludeGlobs([folderQuery], excludePattern, undefined, false);
51
rgGlobs.globArgs.forEach(globArg => {
52
const exclusion = `!${anchorGlob(globArg)}`;
53
args.push('-g', exclusion);
54
if (isMac) {
55
const normalized = normalizeNFD(exclusion);
56
if (normalized !== exclusion) {
57
args.push('-g', normalized);
58
}
59
}
60
});
61
if (folderQuery.disregardIgnoreFiles !== false) {
62
// Don't use .gitignore or .ignore
63
args.push('--no-ignore');
64
} else if (folderQuery.disregardParentIgnoreFiles !== false) {
65
args.push('--no-ignore-parent');
66
}
67
68
// Follow symlinks
69
if (!folderQuery.ignoreSymlinks) {
70
args.push('--follow');
71
}
72
73
if (config.exists) {
74
args.push('--quiet');
75
}
76
77
if (numThreads) {
78
args.push('--threads', `${numThreads}`);
79
}
80
81
args.push('--no-config');
82
if (folderQuery.disregardGlobalIgnoreFiles) {
83
args.push('--no-ignore-global');
84
}
85
86
return {
87
args,
88
siblingClauses: rgGlobs.siblingClauses
89
};
90
}
92
>
interface IRgGlobResult {
93
>
globArgs: string[];
94
>
siblingClauses: glob.IExpression;
95
>
}
96
>
97
function foldersToRgExcludeGlobs(folderQueries: IFolderQuery[], globalExclude?: glob.IExpression, excludesToSkip?: Set<string>, absoluteGlobs = true): IRgGlobResult {
98
const globArgs: string[] = [];
99
let siblingClauses: glob.IExpression = {};
100
folderQueries.forEach(folderQuery => {
101
const totalExcludePattern = Object.assign({}, folderQuery.excludePattern || {}, globalExclude || {});
102
const result = globExprsToRgGlobs(totalExcludePattern, absoluteGlobs ? folderQuery.folder.fsPath : undefined, excludesToSkip);
103
globArgs.push(...result.globArgs);
104
if (result.siblingClauses) {
105
siblingClauses = Object.assign(siblingClauses, result.siblingClauses);
106
}
107
});
108
109
return { globArgs, siblingClauses };
110
}
112
function foldersToIncludeGlobs(folderQueries: IFolderQuery[], globalInclude?: glob.IExpression, absoluteGlobs = true): string[] {
113
const globArgs: string[] = [];
114
folderQueries.forEach(folderQuery => {
115
const totalIncludePattern = Object.assign({}, globalInclude || {}, folderQuery.includePattern || {});
116
const result = globExprsToRgGlobs(totalIncludePattern, absoluteGlobs ? folderQuery.folder.fsPath : undefined);
117
globArgs.push(...result.globArgs);
118
});
119
120
return globArgs;
121
}
123
function globExprsToRgGlobs(patterns: glob.IExpression, folder?: string, excludesToSkip?: Set<string>): IRgGlobResult {
124
const globArgs: string[] = [];
125
const siblingClauses: glob.IExpression = {};
126
Object.keys(patterns)
127
.forEach(key => {
128
if (excludesToSkip && excludesToSkip.has(key)) {
129
return;
130
}
131
132
if (!key) {
133
return;
134
}
135
136
const value = patterns[key];
137
key = trimTrailingSlash(folder ? getAbsoluteGlob(folder, key) : key);
138
139
// glob.ts requires forward slashes, but a UNC path still must start with \\
140
// #38165 and #38151
141
if (key.startsWith('\\\\')) {
142
key = '\\\\' + key.substr(2).replace(/\\/g, '/');
143
} else {
144
key = key.replace(/\\/g, '/');
145
}
146
147
if (typeof value === 'boolean' && value) {
148
if (key.startsWith('\\\\')) {
149
// Absolute globs UNC paths don't work properly, see #58758
150
key += '**';
151
}
152
153
globArgs.push(fixDriveC(key));
154
} else if (value && value.when) {
155
siblingClauses[key] = value;
156
}
157
});
158
159
return { globArgs, siblingClauses };
160
}
162
>
/**
163
>
* Resolves a glob like "node_modules/**" in "/foo/bar" to "/foo/bar/node_modules/**".
164
>
* Special cases C:/foo paths to write the glob like /foo instead - see https://github.com/BurntSushi/ripgrep/issues/530.
165
>
*
166
>
* Exported for testing
167
>
*/
168
>
export function getAbsoluteGlob(folder: string, key: string): string {
170
>
key :
171
>
path.join(folder, key);
172
>
}
174
function trimTrailingSlash(str: string): string {
175
str = strings.rtrim(str, '\\');
176
return strings.rtrim(str, '/');
177
}
179
>
export function fixDriveC(path: string): string {
181
>
return root.toLowerCase() === 'c:/' ?
182
path.replace(/^c:[/\\]/i, '/') :
184
>
}