-
-
Notifications
You must be signed in to change notification settings - Fork 213
/
project-root.ts
300 lines (265 loc) · 8.35 KB
/
project-root.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
import * as config from './config';
import * as vscode from 'vscode';
import * as path from 'path';
import * as _ from 'lodash';
export type ProjectRoot = {
uri: vscode.Uri;
label: string;
reason: string;
workspace_root?: boolean;
valid_project?: boolean;
};
export const getPathRelativeToWorkspace = (uri: vscode.Uri) => {
const root = vscode.workspace.getWorkspaceFolder(uri);
if (!root) {
return uri.path;
}
return path.relative(path.dirname(root.uri.path), uri.path);
};
type FindRootParams = {
/**
* If set to `false` then root workspace folders won't be included in the list by default. They will only
* be included if they match the same project heuristics as any other folder in the workspace.
*
* @default true
*/
include_workspace_folders?: boolean;
/**
* Whether or not to include clojure-lsp directories in the heuristic for deciding a directory is a project root.
*
* This makes sense for systems trying to find a directory to start an lsp server in, but not for systems
* showing repl start commands.
*/
include_lsp_directories?: boolean;
};
/**
* Returns a list of discovered project roots. A directory is considered a project root if it contains certain
* clojure related files that identify it as a Clojure project. For example, a `deps.edn` file.
*
* The response contains a `reason` as to why a folder is considered a project root which can be used in
* selection menus to help the user.
*/
export async function findProjectRootsWithReasons(params?: FindRootParams) {
const lspDirectories = ['.lsp/config.edn', '.clj-kondo/config.edn'];
const projectFileNames: string[] = ['project.clj', 'shadow-cljs.edn', 'deps.edn', 'bb.edn'];
if (params?.include_lsp_directories) {
projectFileNames.push(...lspDirectories);
}
const projectFilesGlob = `**/{${projectFileNames.join(',')}}`;
const excludeDirsGlob = excludePattern();
const rootPaths: ProjectRoot[] = [];
if (params?.include_workspace_folders ?? true) {
const wsRootPaths = vscode.workspace.workspaceFolders?.map((f) => {
return {
uri: f.uri,
label: path.basename(f.uri.path),
reason: 'Workspace Root',
workspace_root: true,
};
});
rootPaths.push(...(wsRootPaths || []));
}
const candidateUris = await vscode.workspace.findFiles(projectFilesGlob, excludeDirsGlob, 10000);
const projectFilePaths = candidateUris.map((uri) => {
let dir = vscode.Uri.file(path.dirname(uri.path));
if (lspDirectories.find((file) => uri.path.endsWith(file))) {
dir = vscode.Uri.file(path.join(uri.path, '../..'));
}
return {
uri: dir,
label: getPathRelativeToWorkspace(dir),
reason: path.basename(uri.path),
valid_project: true,
};
});
rootPaths.push(...projectFilePaths);
return rootPaths.reduce((roots: ProjectRoot[], root) => {
const existing = roots.find(({ uri }) => root.uri.path === uri.path);
if (existing) {
existing.reason = `${existing.reason}, ${root.reason}`;
existing.workspace_root = root.workspace_root ? true : existing.workspace_root;
existing.valid_project = root.valid_project ? true : existing.valid_project;
return roots;
}
roots.push(root);
return roots;
}, []);
}
export async function findProjectRoots(params?: FindRootParams) {
return findProjectRootsWithReasons(params).then((res) => {
return res.map((root) => root.uri);
});
}
export function excludePattern(moreExcludes: string[] = []) {
return `**/{${[...moreExcludes, ...config.getConfig().projectRootsSearchExclude].join(',')}}/**`;
}
export async function isValidClojureProject(uri: vscode.Uri) {
return findProjectRootsWithReasons({ include_lsp_directories: true }).then((roots) => {
return !!roots.find((root) => {
return uri.path === root.uri.path && root.valid_project;
});
});
}
function findMatchingParent(
from: vscode.Uri,
uris: vscode.Uri[],
comp: (a: vscode.Uri, b: vscode.Uri) => vscode.Uri
) {
return uris.reduce((root: vscode.Uri | undefined, uri) => {
const relative = path.relative(uri.fsPath, from.fsPath);
if (relative && !relative.includes('../')) {
if (!root) {
return uri;
}
return comp(uri, root);
}
return root;
}, undefined);
}
export function findClosestParent(from: vscode.Uri, uris: vscode.Uri[]) {
return findMatchingParent(from, uris, (a, b) => {
if (a.path > b.path) {
return a;
} else {
return b;
}
});
}
export function findFurthestParent(from: vscode.Uri, uris: vscode.Uri[]) {
return findMatchingParent(from, uris, (a, b) => {
if (a.path < b.path) {
return a;
} else {
return b;
}
});
}
/**
* Filter a given set of URI's down to the set of shortest distinct paths.
*
* For example, given the input:
*
* ["/root-1/b", "/root-1/b/c", "/root-2/b", "/root-2/b/c"]
*
* Produce the output:
*
* ["/root-1/b", "/root-2/b"]
*
* Removing the longer trailing paths.
*/
export function filterShortestDistinctPaths(uris: vscode.Uri[]) {
return Array.from(
uris
.reduce((uris, uri) => {
let distinct = true;
Array.from(uris.values()).forEach((previous) => {
if (previous.path.startsWith(uri.path)) {
distinct = false;
uris.delete(previous.path);
uris.set(uri.path, uri);
}
if (uri.path.startsWith(previous.path)) {
distinct = false;
}
});
if (distinct) {
uris.set(uri.path, uri);
}
return uris;
}, new Map<string, vscode.Uri>())
.values()
);
}
const groupByProject = (uris: vscode.Uri[]) => {
return Object.values(
_.groupBy(uris, (uri) => {
return vscode.workspace.getWorkspaceFolder(uri)?.uri.path;
})
);
};
const groupsToChoices = (groups: vscode.Uri[][]) => {
return groups.reduce((choices: (vscode.QuickPickItem & { value?: vscode.Uri })[], uris) => {
choices.push({
kind: vscode.QuickPickItemKind.Separator,
label: 'Workspace Root',
});
const items = uris.map((uri) => {
return {
label: getPathRelativeToWorkspace(uri),
value: uri,
};
});
choices.push(...items);
return choices;
}, []);
};
function groupContainsUri(uris: vscode.Uri[], uri: vscode.Uri) {
return !!uris.find((next) => next.path === uri.path);
}
function sortPreSelectedFirst(groups: vscode.Uri[][], selected: vscode.Uri) {
// First sort the groups, bringing the group containing the preselected item to the top.
const sorted_groups = groups.sort((a, b) => {
if (!selected) {
return 0;
}
if (groupContainsUri(a, selected)) {
return -1;
}
if (groupContainsUri(b, selected)) {
return 1;
}
return 0;
});
// Next sort the items within each group, first attempting to bring the preselected item to the top and then
// falling back to sorting by path length
return sorted_groups.map((group) => {
const [root, ...remaining] = group;
const sorted = remaining.sort((a, b) => {
// Try bring the pre-selected entry to the top
if (selected) {
if (a.path === selected.path) {
return -1;
}
if (b.path === selected.path) {
return 1;
}
}
const length_a = a.path.split('/').length;
const length_b = b.path.split('/').length;
// Fall back to sorting by length
if (length_a < length_b) {
return -1;
}
if (length_a > length_b) {
return 1;
}
return 0;
});
return [root, ...sorted];
});
}
export async function pickProjectRoot(uris: vscode.Uri[], selected?: vscode.Uri) {
if (uris.length === 0) {
return;
}
if (uris.length === 1) {
return uris[0];
}
const grouped = groupByProject(uris);
const sorted = sortPreSelectedFirst(grouped, selected);
const choices = groupsToChoices(sorted);
const picker = vscode.window.createQuickPick();
picker.items = choices;
picker.title = 'Project Selection';
picker.placeholder = 'Pick the Clojure project you want to use as the root';
picker.activeItems = choices.filter((root) => root.value?.path === selected?.path);
picker.show();
const selected_root = await new Promise<any>((resolve) => {
picker.onDidAccept(() => {
resolve(picker.selectedItems[0]);
});
picker.onDidHide(() => resolve(undefined));
});
picker.dispose();
return selected_root?.value;
}