@theia/scm 1.45.0 → 1.46.0-next.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +31 -31
  2. package/lib/browser/decorations/scm-decorations-service.d.ts +14 -14
  3. package/lib/browser/decorations/scm-decorations-service.js +101 -101
  4. package/lib/browser/decorations/scm-navigator-decorator.d.ts +25 -25
  5. package/lib/browser/decorations/scm-navigator-decorator.js +132 -132
  6. package/lib/browser/decorations/scm-tab-bar-decorator.d.ts +17 -17
  7. package/lib/browser/decorations/scm-tab-bar-decorator.js +93 -93
  8. package/lib/browser/dirty-diff/content-lines.d.ts +12 -12
  9. package/lib/browser/dirty-diff/content-lines.js +106 -106
  10. package/lib/browser/dirty-diff/content-lines.spec.d.ts +1 -1
  11. package/lib/browser/dirty-diff/content-lines.spec.js +39 -39
  12. package/lib/browser/dirty-diff/diff-computer.d.ts +29 -29
  13. package/lib/browser/dirty-diff/diff-computer.js +102 -102
  14. package/lib/browser/dirty-diff/diff-computer.spec.d.ts +1 -1
  15. package/lib/browser/dirty-diff/diff-computer.spec.js +315 -315
  16. package/lib/browser/dirty-diff/dirty-diff-decorator.d.ts +14 -14
  17. package/lib/browser/dirty-diff/dirty-diff-decorator.js +98 -98
  18. package/lib/browser/dirty-diff/dirty-diff-module.d.ts +3 -3
  19. package/lib/browser/dirty-diff/dirty-diff-module.js +24 -24
  20. package/lib/browser/scm-amend-component.d.ts +123 -123
  21. package/lib/browser/scm-amend-component.js +463 -463
  22. package/lib/browser/scm-amend-widget.d.ts +20 -20
  23. package/lib/browser/scm-amend-widget.js +101 -101
  24. package/lib/browser/scm-avatar-service.d.ts +3 -3
  25. package/lib/browser/scm-avatar-service.js +36 -36
  26. package/lib/browser/scm-commit-widget.d.ts +52 -52
  27. package/lib/browser/scm-commit-widget.js +199 -199
  28. package/lib/browser/scm-context-key-service.d.ts +10 -10
  29. package/lib/browser/scm-context-key-service.js +58 -58
  30. package/lib/browser/scm-contribution.d.ts +83 -83
  31. package/lib/browser/scm-contribution.js +356 -356
  32. package/lib/browser/scm-frontend-module.d.ts +6 -6
  33. package/lib/browser/scm-frontend-module.js +130 -130
  34. package/lib/browser/scm-groups-tree-model.d.ts +14 -14
  35. package/lib/browser/scm-groups-tree-model.js +97 -97
  36. package/lib/browser/scm-input.d.ts +53 -53
  37. package/lib/browser/scm-input.js +127 -127
  38. package/lib/browser/scm-layout-migrations.d.ts +9 -9
  39. package/lib/browser/scm-layout-migrations.js +79 -79
  40. package/lib/browser/scm-no-repository-widget.d.ts +8 -8
  41. package/lib/browser/scm-no-repository-widget.js +49 -49
  42. package/lib/browser/scm-preferences.d.ts +11 -11
  43. package/lib/browser/scm-preferences.js +51 -51
  44. package/lib/browser/scm-provider.d.ts +58 -58
  45. package/lib/browser/scm-provider.js +19 -19
  46. package/lib/browser/scm-quick-open-service.d.ts +11 -11
  47. package/lib/browser/scm-quick-open-service.js +73 -73
  48. package/lib/browser/scm-repository.d.ts +17 -17
  49. package/lib/browser/scm-repository.js +41 -41
  50. package/lib/browser/scm-service.d.ts +26 -26
  51. package/lib/browser/scm-service.js +108 -108
  52. package/lib/browser/scm-tree-label-provider.d.ts +7 -7
  53. package/lib/browser/scm-tree-label-provider.js +57 -57
  54. package/lib/browser/scm-tree-model.d.ts +74 -74
  55. package/lib/browser/scm-tree-model.js +351 -351
  56. package/lib/browser/scm-tree-widget.d.ts +208 -208
  57. package/lib/browser/scm-tree-widget.js +703 -703
  58. package/lib/browser/scm-widget.d.ts +40 -40
  59. package/lib/browser/scm-widget.js +218 -218
  60. package/package.json +6 -6
  61. package/src/browser/decorations/scm-decorations-service.ts +78 -78
  62. package/src/browser/decorations/scm-navigator-decorator.ts +121 -121
  63. package/src/browser/decorations/scm-tab-bar-decorator.ts +83 -83
  64. package/src/browser/dirty-diff/content-lines.spec.ts +42 -42
  65. package/src/browser/dirty-diff/content-lines.ts +112 -112
  66. package/src/browser/dirty-diff/diff-computer.spec.ts +387 -387
  67. package/src/browser/dirty-diff/diff-computer.ts +129 -129
  68. package/src/browser/dirty-diff/dirty-diff-decorator.ts +107 -107
  69. package/src/browser/dirty-diff/dirty-diff-module.ts +24 -24
  70. package/src/browser/scm-amend-component.tsx +600 -600
  71. package/src/browser/scm-amend-widget.tsx +77 -77
  72. package/src/browser/scm-avatar-service.ts +27 -27
  73. package/src/browser/scm-commit-widget.tsx +215 -215
  74. package/src/browser/scm-context-key-service.ts +46 -46
  75. package/src/browser/scm-contribution.ts +361 -361
  76. package/src/browser/scm-frontend-module.ts +149 -149
  77. package/src/browser/scm-groups-tree-model.ts +78 -78
  78. package/src/browser/scm-input.ts +164 -164
  79. package/src/browser/scm-layout-migrations.ts +64 -64
  80. package/src/browser/scm-no-repository-widget.tsx +41 -41
  81. package/src/browser/scm-preferences.ts +63 -63
  82. package/src/browser/scm-provider.ts +91 -91
  83. package/src/browser/scm-quick-open-service.ts +48 -48
  84. package/src/browser/scm-repository.ts +52 -52
  85. package/src/browser/scm-service.ts +108 -108
  86. package/src/browser/scm-tree-label-provider.ts +44 -44
  87. package/src/browser/scm-tree-model.ts +405 -405
  88. package/src/browser/scm-tree-widget.tsx +838 -838
  89. package/src/browser/scm-widget.tsx +204 -204
  90. package/src/browser/style/dirty-diff-decorator.css +52 -52
  91. package/src/browser/style/dirty-diff.css +50 -50
  92. package/src/browser/style/index.css +271 -271
  93. package/src/browser/style/scm-amend-component.css +94 -94
  94. package/src/browser/style/scm.svg +4 -4
@@ -1,405 +1,405 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 Arm and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { injectable, inject } from '@theia/core/shared/inversify';
18
- import { TreeModelImpl, TreeNode, TreeProps, CompositeTreeNode, SelectableTreeNode, ExpandableTreeNode } from '@theia/core/lib/browser/tree';
19
- import URI from '@theia/core/lib/common/uri';
20
- import { ScmProvider, ScmResourceGroup, ScmResource, ScmResourceDecorations } from './scm-provider';
21
- import { ScmContextKeyService } from './scm-context-key-service';
22
-
23
- export const ScmTreeModelProps = Symbol('ScmTreeModelProps');
24
- export interface ScmTreeModelProps {
25
- defaultExpansion?: 'collapsed' | 'expanded';
26
- nestingThreshold?: number;
27
- }
28
-
29
- export interface ScmFileChangeRootNode extends CompositeTreeNode {
30
- rootUri: string;
31
- children: ScmFileChangeGroupNode[];
32
- }
33
-
34
- export interface ScmFileChangeGroupNode extends ExpandableTreeNode {
35
- groupId: string;
36
- groupLabel: string;
37
- children: (ScmFileChangeFolderNode | ScmFileChangeNode)[];
38
- }
39
-
40
- export namespace ScmFileChangeGroupNode {
41
- export function is(node: TreeNode): node is ScmFileChangeGroupNode {
42
- return 'groupId' in node && 'children' in node
43
- && !ScmFileChangeFolderNode.is(node);
44
- }
45
- }
46
-
47
- export interface ScmFileChangeFolderNode extends ExpandableTreeNode, SelectableTreeNode {
48
- groupId: string;
49
- path: string;
50
- sourceUri: string;
51
- children: (ScmFileChangeFolderNode | ScmFileChangeNode)[];
52
- }
53
-
54
- export namespace ScmFileChangeFolderNode {
55
- export function is(node: TreeNode): node is ScmFileChangeFolderNode {
56
- return 'groupId' in node && 'sourceUri' in node && 'path' in node && 'children' in node;
57
- }
58
- }
59
-
60
- export interface ScmFileChangeNode extends SelectableTreeNode {
61
- sourceUri: string;
62
- decorations?: ScmResourceDecorations;
63
- }
64
-
65
- export namespace ScmFileChangeNode {
66
- export function is(node: TreeNode): node is ScmFileChangeNode {
67
- return 'sourceUri' in node
68
- && !ScmFileChangeFolderNode.is(node);
69
- }
70
- export function getGroupId(node: ScmFileChangeNode): string {
71
- const parentNode = node.parent;
72
- if (!(parentNode && (ScmFileChangeFolderNode.is(parentNode) || ScmFileChangeGroupNode.is(parentNode)))) {
73
- throw new Error('bad node');
74
- }
75
- return parentNode.groupId;
76
- }
77
-
78
- }
79
-
80
- @injectable()
81
- export abstract class ScmTreeModel extends TreeModelImpl {
82
-
83
- private _languageId: string | undefined;
84
-
85
- protected provider: ScmProvider | undefined;
86
-
87
- @inject(TreeProps) protected readonly props: ScmTreeModelProps;
88
-
89
- @inject(ScmContextKeyService) protected readonly contextKeys: ScmContextKeyService;
90
-
91
- get languageId(): string | undefined {
92
- return this._languageId;
93
- }
94
-
95
- abstract canTabToWidget(): boolean;
96
-
97
- protected _viewMode: 'tree' | 'list' = 'list';
98
- set viewMode(id: 'tree' | 'list') {
99
- const oldSelection = this.selectedNodes;
100
- this._viewMode = id;
101
- if (this.root) {
102
- this.root = this.createTree();
103
-
104
- for (const oldSelectedNode of oldSelection) {
105
- const newNode = this.getNode(oldSelectedNode.id);
106
- if (SelectableTreeNode.is(newNode)) {
107
- this.revealNode(newNode); // this call can run asynchronously
108
- }
109
- }
110
- }
111
- }
112
- get viewMode(): 'tree' | 'list' {
113
- return this._viewMode;
114
- }
115
-
116
- abstract get rootUri(): string | undefined;
117
- abstract get groups(): ScmResourceGroup[];
118
-
119
- protected createTree(): ScmFileChangeRootNode {
120
- const root = {
121
- id: 'file-change-tree-root',
122
- parent: undefined,
123
- visible: false,
124
- rootUri: this.rootUri,
125
- children: []
126
- } as ScmFileChangeRootNode;
127
-
128
- const groupNodes = this.groups
129
- .filter(group => !!group.resources.length || !group.hideWhenEmpty)
130
- .map(group => this.toGroupNode(group, root));
131
- root.children = groupNodes;
132
-
133
- return root;
134
- }
135
-
136
- protected toGroupNode(group: ScmResourceGroup, parent: CompositeTreeNode): ScmFileChangeGroupNode {
137
- const groupNode: ScmFileChangeGroupNode = {
138
- id: `${group.id}`,
139
- groupId: group.id,
140
- groupLabel: group.label,
141
- parent,
142
- children: [],
143
- expanded: true,
144
- };
145
-
146
- const sortedResources = group.resources.sort((r1, r2) =>
147
- r1.sourceUri.toString().localeCompare(r2.sourceUri.toString())
148
- );
149
-
150
- switch (this._viewMode) {
151
- case 'list':
152
- groupNode.children = sortedResources.map(resource => this.toFileChangeNode(resource, groupNode));
153
- break;
154
- case 'tree':
155
- const rootUri = group.provider.rootUri;
156
- if (rootUri) {
157
- const resourcePaths = sortedResources.map(resource => {
158
- const relativePath = new URI(rootUri).relative(resource.sourceUri);
159
- const pathParts = relativePath ? relativePath.toString().split('/') : [];
160
- return { resource, pathParts };
161
- });
162
- groupNode.children = this.buildFileChangeTree(resourcePaths, 0, sortedResources.length, 0, groupNode);
163
- }
164
- break;
165
- }
166
-
167
- return groupNode;
168
- }
169
-
170
- protected buildFileChangeTree(
171
- sortedResources: { resource: ScmResource, pathParts: string[] }[],
172
- start: number,
173
- end: number,
174
- level: number,
175
- parent: (ScmFileChangeGroupNode | ScmFileChangeFolderNode)
176
- ): (ScmFileChangeFolderNode | ScmFileChangeNode)[] {
177
- const result: (ScmFileChangeFolderNode | ScmFileChangeNode)[] = [];
178
-
179
- let folderStart = start;
180
- while (folderStart < end) {
181
- const firstFileChange = sortedResources[folderStart];
182
- if (level === firstFileChange.pathParts.length - 1) {
183
- result.push(this.toFileChangeNode(firstFileChange.resource, parent));
184
- folderStart++;
185
- } else {
186
- let index = folderStart + 1;
187
- while (index < end) {
188
- if (sortedResources[index].pathParts[level] !== firstFileChange.pathParts[level]) {
189
- break;
190
- }
191
- index++;
192
- }
193
- const folderEnd = index;
194
-
195
- const nestingThreshold = this.props.nestingThreshold || 1;
196
- if (folderEnd - folderStart < nestingThreshold) {
197
- // Inline these (i.e. do not create another level in the tree)
198
- for (let i = folderStart; i < folderEnd; i++) {
199
- result.push(this.toFileChangeNode(sortedResources[i].resource, parent));
200
- }
201
- } else {
202
- const firstFileParts = firstFileChange.pathParts;
203
- const lastFileParts = sortedResources[folderEnd - 1].pathParts;
204
- // Multiple files with first folder.
205
- // See if more folder levels match and include those if so.
206
- let thisLevel = level + 1;
207
- while (thisLevel < firstFileParts.length - 1 && thisLevel < lastFileParts.length - 1 && firstFileParts[thisLevel] === lastFileParts[thisLevel]) {
208
- thisLevel++;
209
- }
210
- const nodeRelativePath = firstFileParts.slice(level, thisLevel).join('/');
211
- result.push(this.toFileChangeFolderNode(sortedResources, folderStart, folderEnd, thisLevel, nodeRelativePath, parent));
212
- }
213
- folderStart = folderEnd;
214
- }
215
- };
216
- return result.sort(this.compareNodes);
217
- }
218
-
219
- protected compareNodes = (a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode) => this.doCompareNodes(a, b);
220
- protected doCompareNodes(a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode): number {
221
- const isFolderA = ScmFileChangeFolderNode.is(a);
222
- const isFolderB = ScmFileChangeFolderNode.is(b);
223
- if (isFolderA && !isFolderB) {
224
- return -1;
225
- }
226
- if (isFolderB && !isFolderA) {
227
- return 1;
228
- }
229
- return a.sourceUri.localeCompare(b.sourceUri);
230
- }
231
-
232
- protected toFileChangeFolderNode(
233
- resources: { resource: ScmResource, pathParts: string[] }[],
234
- start: number,
235
- end: number,
236
- level: number,
237
- nodeRelativePath: string,
238
- parent: (ScmFileChangeGroupNode | ScmFileChangeFolderNode)
239
- ): ScmFileChangeFolderNode {
240
- const rootUri = this.getRoot(parent).rootUri;
241
- let parentPath: string = rootUri;
242
- if (ScmFileChangeFolderNode.is(parent)) {
243
- parentPath = parent.sourceUri;
244
- }
245
- const sourceUri = new URI(parentPath).resolve(nodeRelativePath);
246
-
247
- const defaultExpansion = this.props.defaultExpansion ? (this.props.defaultExpansion === 'expanded') : true;
248
- const id = `${parent.groupId}:${String(sourceUri)}`;
249
- const oldNode = this.getNode(id);
250
- const folderNode: ScmFileChangeFolderNode = {
251
- id,
252
- groupId: parent.groupId,
253
- path: nodeRelativePath,
254
- sourceUri: String(sourceUri),
255
- children: [],
256
- parent,
257
- expanded: ExpandableTreeNode.is(oldNode) ? oldNode.expanded : defaultExpansion,
258
- selected: SelectableTreeNode.is(oldNode) && oldNode.selected,
259
- };
260
- folderNode.children = this.buildFileChangeTree(resources, start, end, level, folderNode);
261
- return folderNode;
262
- }
263
-
264
- protected getRoot(node: ScmFileChangeGroupNode | ScmFileChangeFolderNode): ScmFileChangeRootNode {
265
- let parent = node.parent!;
266
- while (ScmFileChangeGroupNode.is(parent) && ScmFileChangeFolderNode.is(parent)) {
267
- parent = parent.parent!;
268
- }
269
- return parent as ScmFileChangeRootNode;
270
- }
271
-
272
- protected toFileChangeNode(resource: ScmResource, parent: CompositeTreeNode): ScmFileChangeNode {
273
- const id = `${resource.group.id}:${String(resource.sourceUri)}`;
274
- const oldNode = this.getNode(id);
275
- const node = {
276
- id,
277
- sourceUri: String(resource.sourceUri),
278
- decorations: resource.decorations,
279
- parent,
280
- selected: SelectableTreeNode.is(oldNode) && oldNode.selected,
281
- };
282
- if (node.selected) {
283
- this.selectionService.addSelection(node);
284
- }
285
- return node;
286
- }
287
-
288
- protected async revealNode(node: TreeNode): Promise<void> {
289
- if (ScmFileChangeFolderNode.is(node) || ScmFileChangeNode.is(node)) {
290
- const parentNode = node.parent;
291
- if (ExpandableTreeNode.is(parentNode)) {
292
- await this.revealNode(parentNode);
293
- if (!parentNode.expanded) {
294
- await this.expandNode(parentNode);
295
- }
296
- }
297
- }
298
- }
299
-
300
- getResourceFromNode(node: ScmFileChangeNode): ScmResource | undefined {
301
- const groupId = ScmFileChangeNode.getGroupId(node);
302
- const group = this.findGroup(groupId);
303
- if (group) {
304
- return group.resources.find(r => String(r.sourceUri) === node.sourceUri)!;
305
- }
306
- }
307
-
308
- getResourceGroupFromNode(node: ScmFileChangeGroupNode): ScmResourceGroup | undefined {
309
- return this.findGroup(node.groupId);
310
- }
311
-
312
- getResourcesFromFolderNode(node: ScmFileChangeFolderNode): ScmResource[] {
313
- const resources: ScmResource[] = [];
314
- const group = this.findGroup(node.groupId);
315
- if (group) {
316
- this.collectResources(resources, node, group);
317
- }
318
- return resources;
319
-
320
- }
321
- getSelectionArgs(selectedNodes: Readonly<SelectableTreeNode[]>): ScmResource[] {
322
- const resources: ScmResource[] = [];
323
- for (const node of selectedNodes) {
324
- if (ScmFileChangeNode.is(node)) {
325
- const groupId = ScmFileChangeNode.getGroupId(node);
326
- const group = this.findGroup(groupId);
327
- if (group) {
328
- const selectedResource = group.resources.find(r => String(r.sourceUri) === node.sourceUri);
329
- if (selectedResource) {
330
- resources.push(selectedResource);
331
- }
332
- }
333
- }
334
- if (ScmFileChangeFolderNode.is(node)) {
335
- const group = this.findGroup(node.groupId);
336
- if (group) {
337
- this.collectResources(resources, node, group);
338
- }
339
- }
340
- }
341
- // Remove duplicates which may occur if user selected folder and nested folder
342
- return resources.filter((item1, index) => resources.findIndex(item2 => item1.sourceUri === item2.sourceUri) === index);
343
- }
344
-
345
- protected collectResources(resources: ScmResource[], node: TreeNode, group: ScmResourceGroup): void {
346
- if (ScmFileChangeFolderNode.is(node)) {
347
- for (const child of node.children) {
348
- this.collectResources(resources, child, group);
349
- }
350
- } else if (ScmFileChangeNode.is(node)) {
351
- const resource = group.resources.find(r => String(r.sourceUri) === node.sourceUri)!;
352
- resources.push(resource);
353
- }
354
- }
355
-
356
- execInNodeContext(node: TreeNode, callback: () => void): void {
357
- if (!this.provider) {
358
- return;
359
- }
360
-
361
- let groupId: string;
362
- if (ScmFileChangeGroupNode.is(node) || ScmFileChangeFolderNode.is(node)) {
363
- groupId = node.groupId;
364
- } else if (ScmFileChangeNode.is(node)) {
365
- groupId = ScmFileChangeNode.getGroupId(node);
366
- } else {
367
- return;
368
- }
369
-
370
- this.contextKeys.scmProvider.set(this.provider.id);
371
- this.contextKeys.scmResourceGroup.set(groupId);
372
- try {
373
- callback();
374
- } finally {
375
- }
376
- }
377
-
378
- /*
379
- * Normally the group would always be expected to be found. However if the tree is restored
380
- * in restoreState then the tree may be rendered before the groups have been created
381
- * in the provider. The provider's groups property will be empty in such a situation.
382
- * We want to render the tree (as that is the point of restoreState, we can render
383
- * the tree in the saved state before the provider has provided status). We therefore must
384
- * be prepared to render the tree without having the ScmResourceGroup or ScmResource
385
- * objects.
386
- */
387
- findGroup(groupId: string): ScmResourceGroup | undefined {
388
- return this.groups.find(g => g.id === groupId);
389
- }
390
-
391
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
392
- override storeState(): any {
393
- return {
394
- ...super.storeState(),
395
- mode: this.viewMode,
396
- };
397
- }
398
-
399
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
400
- override restoreState(oldState: any): void {
401
- super.restoreState(oldState);
402
- this.viewMode = oldState.mode === 'tree' ? 'tree' : 'list';
403
- }
404
-
405
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 Arm and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { injectable, inject } from '@theia/core/shared/inversify';
18
+ import { TreeModelImpl, TreeNode, TreeProps, CompositeTreeNode, SelectableTreeNode, ExpandableTreeNode } from '@theia/core/lib/browser/tree';
19
+ import URI from '@theia/core/lib/common/uri';
20
+ import { ScmProvider, ScmResourceGroup, ScmResource, ScmResourceDecorations } from './scm-provider';
21
+ import { ScmContextKeyService } from './scm-context-key-service';
22
+
23
+ export const ScmTreeModelProps = Symbol('ScmTreeModelProps');
24
+ export interface ScmTreeModelProps {
25
+ defaultExpansion?: 'collapsed' | 'expanded';
26
+ nestingThreshold?: number;
27
+ }
28
+
29
+ export interface ScmFileChangeRootNode extends CompositeTreeNode {
30
+ rootUri: string;
31
+ children: ScmFileChangeGroupNode[];
32
+ }
33
+
34
+ export interface ScmFileChangeGroupNode extends ExpandableTreeNode {
35
+ groupId: string;
36
+ groupLabel: string;
37
+ children: (ScmFileChangeFolderNode | ScmFileChangeNode)[];
38
+ }
39
+
40
+ export namespace ScmFileChangeGroupNode {
41
+ export function is(node: TreeNode): node is ScmFileChangeGroupNode {
42
+ return 'groupId' in node && 'children' in node
43
+ && !ScmFileChangeFolderNode.is(node);
44
+ }
45
+ }
46
+
47
+ export interface ScmFileChangeFolderNode extends ExpandableTreeNode, SelectableTreeNode {
48
+ groupId: string;
49
+ path: string;
50
+ sourceUri: string;
51
+ children: (ScmFileChangeFolderNode | ScmFileChangeNode)[];
52
+ }
53
+
54
+ export namespace ScmFileChangeFolderNode {
55
+ export function is(node: TreeNode): node is ScmFileChangeFolderNode {
56
+ return 'groupId' in node && 'sourceUri' in node && 'path' in node && 'children' in node;
57
+ }
58
+ }
59
+
60
+ export interface ScmFileChangeNode extends SelectableTreeNode {
61
+ sourceUri: string;
62
+ decorations?: ScmResourceDecorations;
63
+ }
64
+
65
+ export namespace ScmFileChangeNode {
66
+ export function is(node: TreeNode): node is ScmFileChangeNode {
67
+ return 'sourceUri' in node
68
+ && !ScmFileChangeFolderNode.is(node);
69
+ }
70
+ export function getGroupId(node: ScmFileChangeNode): string {
71
+ const parentNode = node.parent;
72
+ if (!(parentNode && (ScmFileChangeFolderNode.is(parentNode) || ScmFileChangeGroupNode.is(parentNode)))) {
73
+ throw new Error('bad node');
74
+ }
75
+ return parentNode.groupId;
76
+ }
77
+
78
+ }
79
+
80
+ @injectable()
81
+ export abstract class ScmTreeModel extends TreeModelImpl {
82
+
83
+ private _languageId: string | undefined;
84
+
85
+ protected provider: ScmProvider | undefined;
86
+
87
+ @inject(TreeProps) protected readonly props: ScmTreeModelProps;
88
+
89
+ @inject(ScmContextKeyService) protected readonly contextKeys: ScmContextKeyService;
90
+
91
+ get languageId(): string | undefined {
92
+ return this._languageId;
93
+ }
94
+
95
+ abstract canTabToWidget(): boolean;
96
+
97
+ protected _viewMode: 'tree' | 'list' = 'list';
98
+ set viewMode(id: 'tree' | 'list') {
99
+ const oldSelection = this.selectedNodes;
100
+ this._viewMode = id;
101
+ if (this.root) {
102
+ this.root = this.createTree();
103
+
104
+ for (const oldSelectedNode of oldSelection) {
105
+ const newNode = this.getNode(oldSelectedNode.id);
106
+ if (SelectableTreeNode.is(newNode)) {
107
+ this.revealNode(newNode); // this call can run asynchronously
108
+ }
109
+ }
110
+ }
111
+ }
112
+ get viewMode(): 'tree' | 'list' {
113
+ return this._viewMode;
114
+ }
115
+
116
+ abstract get rootUri(): string | undefined;
117
+ abstract get groups(): ScmResourceGroup[];
118
+
119
+ protected createTree(): ScmFileChangeRootNode {
120
+ const root = {
121
+ id: 'file-change-tree-root',
122
+ parent: undefined,
123
+ visible: false,
124
+ rootUri: this.rootUri,
125
+ children: []
126
+ } as ScmFileChangeRootNode;
127
+
128
+ const groupNodes = this.groups
129
+ .filter(group => !!group.resources.length || !group.hideWhenEmpty)
130
+ .map(group => this.toGroupNode(group, root));
131
+ root.children = groupNodes;
132
+
133
+ return root;
134
+ }
135
+
136
+ protected toGroupNode(group: ScmResourceGroup, parent: CompositeTreeNode): ScmFileChangeGroupNode {
137
+ const groupNode: ScmFileChangeGroupNode = {
138
+ id: `${group.id}`,
139
+ groupId: group.id,
140
+ groupLabel: group.label,
141
+ parent,
142
+ children: [],
143
+ expanded: true,
144
+ };
145
+
146
+ const sortedResources = group.resources.sort((r1, r2) =>
147
+ r1.sourceUri.toString().localeCompare(r2.sourceUri.toString())
148
+ );
149
+
150
+ switch (this._viewMode) {
151
+ case 'list':
152
+ groupNode.children = sortedResources.map(resource => this.toFileChangeNode(resource, groupNode));
153
+ break;
154
+ case 'tree':
155
+ const rootUri = group.provider.rootUri;
156
+ if (rootUri) {
157
+ const resourcePaths = sortedResources.map(resource => {
158
+ const relativePath = new URI(rootUri).relative(resource.sourceUri);
159
+ const pathParts = relativePath ? relativePath.toString().split('/') : [];
160
+ return { resource, pathParts };
161
+ });
162
+ groupNode.children = this.buildFileChangeTree(resourcePaths, 0, sortedResources.length, 0, groupNode);
163
+ }
164
+ break;
165
+ }
166
+
167
+ return groupNode;
168
+ }
169
+
170
+ protected buildFileChangeTree(
171
+ sortedResources: { resource: ScmResource, pathParts: string[] }[],
172
+ start: number,
173
+ end: number,
174
+ level: number,
175
+ parent: (ScmFileChangeGroupNode | ScmFileChangeFolderNode)
176
+ ): (ScmFileChangeFolderNode | ScmFileChangeNode)[] {
177
+ const result: (ScmFileChangeFolderNode | ScmFileChangeNode)[] = [];
178
+
179
+ let folderStart = start;
180
+ while (folderStart < end) {
181
+ const firstFileChange = sortedResources[folderStart];
182
+ if (level === firstFileChange.pathParts.length - 1) {
183
+ result.push(this.toFileChangeNode(firstFileChange.resource, parent));
184
+ folderStart++;
185
+ } else {
186
+ let index = folderStart + 1;
187
+ while (index < end) {
188
+ if (sortedResources[index].pathParts[level] !== firstFileChange.pathParts[level]) {
189
+ break;
190
+ }
191
+ index++;
192
+ }
193
+ const folderEnd = index;
194
+
195
+ const nestingThreshold = this.props.nestingThreshold || 1;
196
+ if (folderEnd - folderStart < nestingThreshold) {
197
+ // Inline these (i.e. do not create another level in the tree)
198
+ for (let i = folderStart; i < folderEnd; i++) {
199
+ result.push(this.toFileChangeNode(sortedResources[i].resource, parent));
200
+ }
201
+ } else {
202
+ const firstFileParts = firstFileChange.pathParts;
203
+ const lastFileParts = sortedResources[folderEnd - 1].pathParts;
204
+ // Multiple files with first folder.
205
+ // See if more folder levels match and include those if so.
206
+ let thisLevel = level + 1;
207
+ while (thisLevel < firstFileParts.length - 1 && thisLevel < lastFileParts.length - 1 && firstFileParts[thisLevel] === lastFileParts[thisLevel]) {
208
+ thisLevel++;
209
+ }
210
+ const nodeRelativePath = firstFileParts.slice(level, thisLevel).join('/');
211
+ result.push(this.toFileChangeFolderNode(sortedResources, folderStart, folderEnd, thisLevel, nodeRelativePath, parent));
212
+ }
213
+ folderStart = folderEnd;
214
+ }
215
+ };
216
+ return result.sort(this.compareNodes);
217
+ }
218
+
219
+ protected compareNodes = (a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode) => this.doCompareNodes(a, b);
220
+ protected doCompareNodes(a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode): number {
221
+ const isFolderA = ScmFileChangeFolderNode.is(a);
222
+ const isFolderB = ScmFileChangeFolderNode.is(b);
223
+ if (isFolderA && !isFolderB) {
224
+ return -1;
225
+ }
226
+ if (isFolderB && !isFolderA) {
227
+ return 1;
228
+ }
229
+ return a.sourceUri.localeCompare(b.sourceUri);
230
+ }
231
+
232
+ protected toFileChangeFolderNode(
233
+ resources: { resource: ScmResource, pathParts: string[] }[],
234
+ start: number,
235
+ end: number,
236
+ level: number,
237
+ nodeRelativePath: string,
238
+ parent: (ScmFileChangeGroupNode | ScmFileChangeFolderNode)
239
+ ): ScmFileChangeFolderNode {
240
+ const rootUri = this.getRoot(parent).rootUri;
241
+ let parentPath: string = rootUri;
242
+ if (ScmFileChangeFolderNode.is(parent)) {
243
+ parentPath = parent.sourceUri;
244
+ }
245
+ const sourceUri = new URI(parentPath).resolve(nodeRelativePath);
246
+
247
+ const defaultExpansion = this.props.defaultExpansion ? (this.props.defaultExpansion === 'expanded') : true;
248
+ const id = `${parent.groupId}:${String(sourceUri)}`;
249
+ const oldNode = this.getNode(id);
250
+ const folderNode: ScmFileChangeFolderNode = {
251
+ id,
252
+ groupId: parent.groupId,
253
+ path: nodeRelativePath,
254
+ sourceUri: String(sourceUri),
255
+ children: [],
256
+ parent,
257
+ expanded: ExpandableTreeNode.is(oldNode) ? oldNode.expanded : defaultExpansion,
258
+ selected: SelectableTreeNode.is(oldNode) && oldNode.selected,
259
+ };
260
+ folderNode.children = this.buildFileChangeTree(resources, start, end, level, folderNode);
261
+ return folderNode;
262
+ }
263
+
264
+ protected getRoot(node: ScmFileChangeGroupNode | ScmFileChangeFolderNode): ScmFileChangeRootNode {
265
+ let parent = node.parent!;
266
+ while (ScmFileChangeGroupNode.is(parent) && ScmFileChangeFolderNode.is(parent)) {
267
+ parent = parent.parent!;
268
+ }
269
+ return parent as ScmFileChangeRootNode;
270
+ }
271
+
272
+ protected toFileChangeNode(resource: ScmResource, parent: CompositeTreeNode): ScmFileChangeNode {
273
+ const id = `${resource.group.id}:${String(resource.sourceUri)}`;
274
+ const oldNode = this.getNode(id);
275
+ const node = {
276
+ id,
277
+ sourceUri: String(resource.sourceUri),
278
+ decorations: resource.decorations,
279
+ parent,
280
+ selected: SelectableTreeNode.is(oldNode) && oldNode.selected,
281
+ };
282
+ if (node.selected) {
283
+ this.selectionService.addSelection(node);
284
+ }
285
+ return node;
286
+ }
287
+
288
+ protected async revealNode(node: TreeNode): Promise<void> {
289
+ if (ScmFileChangeFolderNode.is(node) || ScmFileChangeNode.is(node)) {
290
+ const parentNode = node.parent;
291
+ if (ExpandableTreeNode.is(parentNode)) {
292
+ await this.revealNode(parentNode);
293
+ if (!parentNode.expanded) {
294
+ await this.expandNode(parentNode);
295
+ }
296
+ }
297
+ }
298
+ }
299
+
300
+ getResourceFromNode(node: ScmFileChangeNode): ScmResource | undefined {
301
+ const groupId = ScmFileChangeNode.getGroupId(node);
302
+ const group = this.findGroup(groupId);
303
+ if (group) {
304
+ return group.resources.find(r => String(r.sourceUri) === node.sourceUri)!;
305
+ }
306
+ }
307
+
308
+ getResourceGroupFromNode(node: ScmFileChangeGroupNode): ScmResourceGroup | undefined {
309
+ return this.findGroup(node.groupId);
310
+ }
311
+
312
+ getResourcesFromFolderNode(node: ScmFileChangeFolderNode): ScmResource[] {
313
+ const resources: ScmResource[] = [];
314
+ const group = this.findGroup(node.groupId);
315
+ if (group) {
316
+ this.collectResources(resources, node, group);
317
+ }
318
+ return resources;
319
+
320
+ }
321
+ getSelectionArgs(selectedNodes: Readonly<SelectableTreeNode[]>): ScmResource[] {
322
+ const resources: ScmResource[] = [];
323
+ for (const node of selectedNodes) {
324
+ if (ScmFileChangeNode.is(node)) {
325
+ const groupId = ScmFileChangeNode.getGroupId(node);
326
+ const group = this.findGroup(groupId);
327
+ if (group) {
328
+ const selectedResource = group.resources.find(r => String(r.sourceUri) === node.sourceUri);
329
+ if (selectedResource) {
330
+ resources.push(selectedResource);
331
+ }
332
+ }
333
+ }
334
+ if (ScmFileChangeFolderNode.is(node)) {
335
+ const group = this.findGroup(node.groupId);
336
+ if (group) {
337
+ this.collectResources(resources, node, group);
338
+ }
339
+ }
340
+ }
341
+ // Remove duplicates which may occur if user selected folder and nested folder
342
+ return resources.filter((item1, index) => resources.findIndex(item2 => item1.sourceUri === item2.sourceUri) === index);
343
+ }
344
+
345
+ protected collectResources(resources: ScmResource[], node: TreeNode, group: ScmResourceGroup): void {
346
+ if (ScmFileChangeFolderNode.is(node)) {
347
+ for (const child of node.children) {
348
+ this.collectResources(resources, child, group);
349
+ }
350
+ } else if (ScmFileChangeNode.is(node)) {
351
+ const resource = group.resources.find(r => String(r.sourceUri) === node.sourceUri)!;
352
+ resources.push(resource);
353
+ }
354
+ }
355
+
356
+ execInNodeContext(node: TreeNode, callback: () => void): void {
357
+ if (!this.provider) {
358
+ return;
359
+ }
360
+
361
+ let groupId: string;
362
+ if (ScmFileChangeGroupNode.is(node) || ScmFileChangeFolderNode.is(node)) {
363
+ groupId = node.groupId;
364
+ } else if (ScmFileChangeNode.is(node)) {
365
+ groupId = ScmFileChangeNode.getGroupId(node);
366
+ } else {
367
+ return;
368
+ }
369
+
370
+ this.contextKeys.scmProvider.set(this.provider.id);
371
+ this.contextKeys.scmResourceGroup.set(groupId);
372
+ try {
373
+ callback();
374
+ } finally {
375
+ }
376
+ }
377
+
378
+ /*
379
+ * Normally the group would always be expected to be found. However if the tree is restored
380
+ * in restoreState then the tree may be rendered before the groups have been created
381
+ * in the provider. The provider's groups property will be empty in such a situation.
382
+ * We want to render the tree (as that is the point of restoreState, we can render
383
+ * the tree in the saved state before the provider has provided status). We therefore must
384
+ * be prepared to render the tree without having the ScmResourceGroup or ScmResource
385
+ * objects.
386
+ */
387
+ findGroup(groupId: string): ScmResourceGroup | undefined {
388
+ return this.groups.find(g => g.id === groupId);
389
+ }
390
+
391
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
392
+ override storeState(): any {
393
+ return {
394
+ ...super.storeState(),
395
+ mode: this.viewMode,
396
+ };
397
+ }
398
+
399
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
400
+ override restoreState(oldState: any): void {
401
+ super.restoreState(oldState);
402
+ this.viewMode = oldState.mode === 'tree' ? 'tree' : 'list';
403
+ }
404
+
405
+ }