@theia/markers 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 (81) hide show
  1. package/README.md +33 -33
  2. package/lib/browser/index.d.ts +2 -2
  3. package/lib/browser/index.js +29 -29
  4. package/lib/browser/marker-manager.d.ts +47 -47
  5. package/lib/browser/marker-manager.js +187 -187
  6. package/lib/browser/marker-tree-label-provider.d.ts +15 -15
  7. package/lib/browser/marker-tree-label-provider.js +84 -84
  8. package/lib/browser/marker-tree-label-provider.spec.d.ts +1 -1
  9. package/lib/browser/marker-tree-label-provider.spec.js +201 -201
  10. package/lib/browser/marker-tree-model.d.ts +12 -12
  11. package/lib/browser/marker-tree-model.js +60 -60
  12. package/lib/browser/marker-tree.d.ts +42 -42
  13. package/lib/browser/marker-tree.js +143 -143
  14. package/lib/browser/problem/problem-composite-tree-node.d.ts +11 -11
  15. package/lib/browser/problem/problem-composite-tree-node.js +76 -76
  16. package/lib/browser/problem/problem-composite-tree-node.spec.d.ts +1 -1
  17. package/lib/browser/problem/problem-composite-tree-node.spec.js +238 -238
  18. package/lib/browser/problem/problem-container.d.ts +8 -8
  19. package/lib/browser/problem/problem-container.js +46 -46
  20. package/lib/browser/problem/problem-contribution.d.ts +51 -51
  21. package/lib/browser/problem/problem-contribution.js +247 -247
  22. package/lib/browser/problem/problem-decorations-provider.d.ts +21 -21
  23. package/lib/browser/problem/problem-decorations-provider.js +95 -95
  24. package/lib/browser/problem/problem-decorator.d.ts +57 -57
  25. package/lib/browser/problem/problem-decorator.js +233 -233
  26. package/lib/browser/problem/problem-frontend-module.d.ts +4 -4
  27. package/lib/browser/problem/problem-frontend-module.js +55 -55
  28. package/lib/browser/problem/problem-layout-migrations.d.ts +5 -5
  29. package/lib/browser/problem/problem-layout-migrations.js +43 -43
  30. package/lib/browser/problem/problem-manager.d.ts +11 -11
  31. package/lib/browser/problem/problem-manager.js +53 -53
  32. package/lib/browser/problem/problem-manager.spec.d.ts +1 -1
  33. package/lib/browser/problem/problem-manager.spec.js +167 -167
  34. package/lib/browser/problem/problem-preferences.d.ts +13 -13
  35. package/lib/browser/problem/problem-preferences.js +56 -56
  36. package/lib/browser/problem/problem-selection.d.ts +12 -12
  37. package/lib/browser/problem/problem-selection.js +34 -34
  38. package/lib/browser/problem/problem-tabbar-decorator.d.ts +42 -42
  39. package/lib/browser/problem/problem-tabbar-decorator.js +160 -160
  40. package/lib/browser/problem/problem-tree-model.d.ts +32 -32
  41. package/lib/browser/problem/problem-tree-model.js +131 -131
  42. package/lib/browser/problem/problem-tree-model.spec.d.ts +1 -1
  43. package/lib/browser/problem/problem-tree-model.spec.js +172 -172
  44. package/lib/browser/problem/problem-utils.d.ts +44 -44
  45. package/lib/browser/problem/problem-utils.js +84 -84
  46. package/lib/browser/problem/problem-widget-tab-bar-decorator.d.ts +14 -14
  47. package/lib/browser/problem/problem-widget-tab-bar-decorator.js +69 -69
  48. package/lib/browser/problem/problem-widget.d.ts +46 -46
  49. package/lib/browser/problem/problem-widget.js +235 -235
  50. package/lib/common/marker.d.ts +16 -16
  51. package/lib/common/marker.js +31 -31
  52. package/lib/common/problem-marker.d.ts +9 -9
  53. package/lib/common/problem-marker.js +27 -27
  54. package/package.json +6 -6
  55. package/src/browser/index.ts +18 -18
  56. package/src/browser/marker-manager.ts +205 -205
  57. package/src/browser/marker-tree-label-provider.spec.ts +245 -245
  58. package/src/browser/marker-tree-label-provider.ts +75 -75
  59. package/src/browser/marker-tree-model.ts +47 -47
  60. package/src/browser/marker-tree.ts +154 -154
  61. package/src/browser/problem/problem-composite-tree-node.spec.ts +277 -277
  62. package/src/browser/problem/problem-composite-tree-node.ts +81 -81
  63. package/src/browser/problem/problem-container.ts +47 -47
  64. package/src/browser/problem/problem-contribution.ts +247 -247
  65. package/src/browser/problem/problem-decorations-provider.ts +72 -72
  66. package/src/browser/problem/problem-decorator.ts +222 -222
  67. package/src/browser/problem/problem-frontend-module.ts +64 -64
  68. package/src/browser/problem/problem-layout-migrations.ts +32 -32
  69. package/src/browser/problem/problem-manager.spec.ts +216 -216
  70. package/src/browser/problem/problem-manager.ts +51 -51
  71. package/src/browser/problem/problem-preferences.ts +64 -64
  72. package/src/browser/problem/problem-selection.ts +45 -45
  73. package/src/browser/problem/problem-tabbar-decorator.ts +151 -151
  74. package/src/browser/problem/problem-tree-model.spec.ts +189 -189
  75. package/src/browser/problem/problem-tree-model.ts +124 -124
  76. package/src/browser/problem/problem-utils.ts +90 -90
  77. package/src/browser/problem/problem-widget-tab-bar-decorator.ts +55 -55
  78. package/src/browser/problem/problem-widget.tsx +246 -246
  79. package/src/browser/style/index.css +92 -92
  80. package/src/common/marker.ts +53 -53
  81. package/src/common/problem-marker.ts +30 -30
@@ -1,189 +1,189 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 Ericsson 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 { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
18
- let disableJSDOM = enableJSDOM();
19
-
20
- import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
21
- FrontendApplicationConfigProvider.set({});
22
-
23
- import URI from '@theia/core/lib/common/uri';
24
- import { expect } from 'chai';
25
- import { Container } from '@theia/core/shared/inversify';
26
- import { Diagnostic, Range, DiagnosticSeverity } from '@theia/core/shared/vscode-languageserver-protocol';
27
- import { Event } from '@theia/core/lib/common/event';
28
- import { Marker } from '../../common/marker';
29
- import { MarkerManager } from '../marker-manager';
30
- import { MarkerNode, MarkerOptions } from '../marker-tree';
31
- import { PROBLEM_OPTIONS } from './problem-container';
32
- import { ProblemManager } from './problem-manager';
33
- import { ProblemTree } from './problem-tree-model';
34
- import { FileService } from '@theia/filesystem/lib/browser/file-service';
35
-
36
- disableJSDOM();
37
-
38
- let problemTree: ProblemTree;
39
-
40
- before(() => {
41
- disableJSDOM = enableJSDOM();
42
- const testContainer = new Container();
43
-
44
- testContainer.bind(MarkerManager).toSelf().inSingletonScope();
45
- testContainer.bind(ProblemManager).toSelf();
46
- testContainer.bind(MarkerOptions).toConstantValue(PROBLEM_OPTIONS);
47
- testContainer.bind(FileService).toConstantValue(<FileService>{
48
- onDidFilesChange: Event.None
49
- });
50
-
51
- testContainer.bind(ProblemTree).toSelf().inSingletonScope();
52
- problemTree = testContainer.get<ProblemTree>(ProblemTree);
53
- });
54
-
55
- after(() => {
56
- disableJSDOM();
57
- });
58
-
59
- describe('Problem Tree', () => {
60
-
61
- describe('#sortMarkers', () => {
62
- describe('should sort markers based on the highest severity', () => {
63
- it('should sort errors higher than warnings', () => {
64
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
65
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
66
- const nodeA = createMockMarkerNode(markerA);
67
- const nodeB = createMockMarkerNode(markerB);
68
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
69
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
70
- });
71
- it('should sort errors higher than infos', () => {
72
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
73
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
74
- const nodeA = createMockMarkerNode(markerA);
75
- const nodeB = createMockMarkerNode(markerB);
76
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-2);
77
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(2);
78
- });
79
- it('should sort errors higher than hints', () => {
80
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
81
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
82
- const nodeA = createMockMarkerNode(markerA);
83
- const nodeB = createMockMarkerNode(markerB);
84
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-3);
85
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(3);
86
- });
87
- it('should sort warnings higher than infos', () => {
88
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
89
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
90
- const nodeA = createMockMarkerNode(markerA);
91
- const nodeB = createMockMarkerNode(markerB);
92
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
93
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
94
- });
95
- it('should sort warnings higher than hints', () => {
96
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
97
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
98
- const nodeA = createMockMarkerNode(markerA);
99
- const nodeB = createMockMarkerNode(markerB);
100
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-2);
101
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(2);
102
- });
103
- it('should sort infos higher than hints', () => {
104
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
105
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
106
- const nodeA = createMockMarkerNode(markerA);
107
- const nodeB = createMockMarkerNode(markerB);
108
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
109
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
110
- });
111
- });
112
-
113
- it('should sort markers based on lowest line number if their severities are equal', () => {
114
- const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 20 } }, DiagnosticSeverity.Error);
115
- const markerB = createMockMarker({ start: { line: 5, character: 10 }, end: { line: 5, character: 20 } }, DiagnosticSeverity.Error);
116
- const nodeA = createMockMarkerNode(markerA);
117
- const nodeB = createMockMarkerNode(markerB);
118
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-4);
119
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(4);
120
- });
121
-
122
- it('should sort markers based on lowest column number if their severities and line numbers are equal', () => {
123
- const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error);
124
- const markerB = createMockMarker({ start: { line: 1, character: 20 }, end: { line: 1, character: 20 } }, DiagnosticSeverity.Error);
125
- const nodeA = createMockMarkerNode(markerA);
126
- const nodeB = createMockMarkerNode(markerB);
127
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-10);
128
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(10);
129
- });
130
-
131
- it('should sort markers based on owner if their severities, line numbers and columns are equal', () => {
132
- const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error, 'A');
133
- const markerB = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error, 'B');
134
- const nodeA = createMockMarkerNode(markerA);
135
- const nodeB = createMockMarkerNode(markerB);
136
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
137
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
138
- });
139
-
140
- it('should not sort if markers are equal', () => {
141
- const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
142
- const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
143
- const nodeA = createMockMarkerNode(markerA);
144
- const nodeB = createMockMarkerNode(markerB);
145
- expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(0);
146
- expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(0);
147
- });
148
- });
149
-
150
- });
151
-
152
- /**
153
- * Create a mock marker node with the given diagnostic marker.
154
- * @param marker the diagnostic marker.
155
- *
156
- * @returns a mock marker node.
157
- */
158
- function createMockMarkerNode(marker: Marker<Diagnostic>): MarkerNode {
159
- return {
160
- id: 'id',
161
- name: 'marker',
162
- parent: undefined,
163
- selected: false,
164
- uri: new URI(''),
165
- marker
166
- };
167
- }
168
-
169
- /**
170
- * Create a mock diagnostic marker.
171
- * @param range the diagnostic range.
172
- * @param severity the diagnostic severity.
173
- * @param owner the optional owner of the diagnostic
174
- *
175
- * @returns a mock diagnostic marker.
176
- */
177
- function createMockMarker(range: Range, severity: DiagnosticSeverity, owner?: string): Readonly<Marker<Diagnostic>> {
178
- const data: Diagnostic = {
179
- range: range,
180
- severity: severity,
181
- message: 'message'
182
- };
183
- return Object.freeze({
184
- uri: 'uri',
185
- kind: 'marker',
186
- owner: owner ?? 'owner',
187
- data
188
- });
189
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 Ericsson 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 { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
18
+ let disableJSDOM = enableJSDOM();
19
+
20
+ import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
21
+ FrontendApplicationConfigProvider.set({});
22
+
23
+ import URI from '@theia/core/lib/common/uri';
24
+ import { expect } from 'chai';
25
+ import { Container } from '@theia/core/shared/inversify';
26
+ import { Diagnostic, Range, DiagnosticSeverity } from '@theia/core/shared/vscode-languageserver-protocol';
27
+ import { Event } from '@theia/core/lib/common/event';
28
+ import { Marker } from '../../common/marker';
29
+ import { MarkerManager } from '../marker-manager';
30
+ import { MarkerNode, MarkerOptions } from '../marker-tree';
31
+ import { PROBLEM_OPTIONS } from './problem-container';
32
+ import { ProblemManager } from './problem-manager';
33
+ import { ProblemTree } from './problem-tree-model';
34
+ import { FileService } from '@theia/filesystem/lib/browser/file-service';
35
+
36
+ disableJSDOM();
37
+
38
+ let problemTree: ProblemTree;
39
+
40
+ before(() => {
41
+ disableJSDOM = enableJSDOM();
42
+ const testContainer = new Container();
43
+
44
+ testContainer.bind(MarkerManager).toSelf().inSingletonScope();
45
+ testContainer.bind(ProblemManager).toSelf();
46
+ testContainer.bind(MarkerOptions).toConstantValue(PROBLEM_OPTIONS);
47
+ testContainer.bind(FileService).toConstantValue(<FileService>{
48
+ onDidFilesChange: Event.None
49
+ });
50
+
51
+ testContainer.bind(ProblemTree).toSelf().inSingletonScope();
52
+ problemTree = testContainer.get<ProblemTree>(ProblemTree);
53
+ });
54
+
55
+ after(() => {
56
+ disableJSDOM();
57
+ });
58
+
59
+ describe('Problem Tree', () => {
60
+
61
+ describe('#sortMarkers', () => {
62
+ describe('should sort markers based on the highest severity', () => {
63
+ it('should sort errors higher than warnings', () => {
64
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
65
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
66
+ const nodeA = createMockMarkerNode(markerA);
67
+ const nodeB = createMockMarkerNode(markerB);
68
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
69
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
70
+ });
71
+ it('should sort errors higher than infos', () => {
72
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
73
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
74
+ const nodeA = createMockMarkerNode(markerA);
75
+ const nodeB = createMockMarkerNode(markerB);
76
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-2);
77
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(2);
78
+ });
79
+ it('should sort errors higher than hints', () => {
80
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
81
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
82
+ const nodeA = createMockMarkerNode(markerA);
83
+ const nodeB = createMockMarkerNode(markerB);
84
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-3);
85
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(3);
86
+ });
87
+ it('should sort warnings higher than infos', () => {
88
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
89
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
90
+ const nodeA = createMockMarkerNode(markerA);
91
+ const nodeB = createMockMarkerNode(markerB);
92
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
93
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
94
+ });
95
+ it('should sort warnings higher than hints', () => {
96
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Warning);
97
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
98
+ const nodeA = createMockMarkerNode(markerA);
99
+ const nodeB = createMockMarkerNode(markerB);
100
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-2);
101
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(2);
102
+ });
103
+ it('should sort infos higher than hints', () => {
104
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Information);
105
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Hint);
106
+ const nodeA = createMockMarkerNode(markerA);
107
+ const nodeB = createMockMarkerNode(markerB);
108
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
109
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
110
+ });
111
+ });
112
+
113
+ it('should sort markers based on lowest line number if their severities are equal', () => {
114
+ const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 20 } }, DiagnosticSeverity.Error);
115
+ const markerB = createMockMarker({ start: { line: 5, character: 10 }, end: { line: 5, character: 20 } }, DiagnosticSeverity.Error);
116
+ const nodeA = createMockMarkerNode(markerA);
117
+ const nodeB = createMockMarkerNode(markerB);
118
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-4);
119
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(4);
120
+ });
121
+
122
+ it('should sort markers based on lowest column number if their severities and line numbers are equal', () => {
123
+ const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error);
124
+ const markerB = createMockMarker({ start: { line: 1, character: 20 }, end: { line: 1, character: 20 } }, DiagnosticSeverity.Error);
125
+ const nodeA = createMockMarkerNode(markerA);
126
+ const nodeB = createMockMarkerNode(markerB);
127
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-10);
128
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(10);
129
+ });
130
+
131
+ it('should sort markers based on owner if their severities, line numbers and columns are equal', () => {
132
+ const markerA = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error, 'A');
133
+ const markerB = createMockMarker({ start: { line: 1, character: 10 }, end: { line: 1, character: 10 } }, DiagnosticSeverity.Error, 'B');
134
+ const nodeA = createMockMarkerNode(markerA);
135
+ const nodeB = createMockMarkerNode(markerB);
136
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(-1);
137
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(1);
138
+ });
139
+
140
+ it('should not sort if markers are equal', () => {
141
+ const markerA = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
142
+ const markerB = createMockMarker({ start: { line: 0, character: 10 }, end: { line: 0, character: 10 } }, DiagnosticSeverity.Error);
143
+ const nodeA = createMockMarkerNode(markerA);
144
+ const nodeB = createMockMarkerNode(markerB);
145
+ expect(problemTree['sortMarkers'](nodeA, nodeB)).equals(0);
146
+ expect(problemTree['sortMarkers'](nodeB, nodeA)).equals(0);
147
+ });
148
+ });
149
+
150
+ });
151
+
152
+ /**
153
+ * Create a mock marker node with the given diagnostic marker.
154
+ * @param marker the diagnostic marker.
155
+ *
156
+ * @returns a mock marker node.
157
+ */
158
+ function createMockMarkerNode(marker: Marker<Diagnostic>): MarkerNode {
159
+ return {
160
+ id: 'id',
161
+ name: 'marker',
162
+ parent: undefined,
163
+ selected: false,
164
+ uri: new URI(''),
165
+ marker
166
+ };
167
+ }
168
+
169
+ /**
170
+ * Create a mock diagnostic marker.
171
+ * @param range the diagnostic range.
172
+ * @param severity the diagnostic severity.
173
+ * @param owner the optional owner of the diagnostic
174
+ *
175
+ * @returns a mock diagnostic marker.
176
+ */
177
+ function createMockMarker(range: Range, severity: DiagnosticSeverity, owner?: string): Readonly<Marker<Diagnostic>> {
178
+ const data: Diagnostic = {
179
+ range: range,
180
+ severity: severity,
181
+ message: 'message'
182
+ };
183
+ return Object.freeze({
184
+ uri: 'uri',
185
+ kind: 'marker',
186
+ owner: owner ?? 'owner',
187
+ data
188
+ });
189
+ }
@@ -1,124 +1,124 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 TypeFox 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 { ProblemMarker } from '../../common/problem-marker';
18
- import { ProblemManager } from './problem-manager';
19
- import { ProblemCompositeTreeNode } from './problem-composite-tree-node';
20
- import { MarkerNode, MarkerTree, MarkerOptions, MarkerInfoNode, MarkerRootNode } from '../marker-tree';
21
- import { MarkerTreeModel } from '../marker-tree-model';
22
- import { injectable, inject } from '@theia/core/shared/inversify';
23
- import { OpenerOptions, TreeNode } from '@theia/core/lib/browser';
24
- import { Marker } from '../../common/marker';
25
- import { Diagnostic } from '@theia/core/shared/vscode-languageserver-protocol';
26
- import { ProblemUtils } from './problem-utils';
27
- import debounce = require('@theia/core/shared/lodash.debounce');
28
-
29
- @injectable()
30
- export class ProblemTree extends MarkerTree<Diagnostic> {
31
- protected markers: { node: MarkerInfoNode, markers: Marker<Diagnostic>[] }[] = [];
32
-
33
- constructor(
34
- @inject(ProblemManager) markerManager: ProblemManager,
35
- @inject(MarkerOptions) markerOptions: MarkerOptions
36
- ) {
37
- super(markerManager, markerOptions);
38
- }
39
-
40
- protected override getMarkerNodes(parent: MarkerInfoNode, markers: Marker<Diagnostic>[]): MarkerNode[] {
41
- const nodes = super.getMarkerNodes(parent, markers);
42
- return nodes.sort((a, b) => this.sortMarkers(a, b));
43
- }
44
-
45
- /**
46
- * Sort markers based on the following rules:
47
- * - Markers are fist sorted by `severity`.
48
- * - Markers are sorted by `line number` if applicable.
49
- * - Markers are sorted by `column number` if applicable.
50
- * - Markers are then finally sorted by `owner` if applicable.
51
- * @param a the first marker for comparison.
52
- * @param b the second marker for comparison.
53
- */
54
- protected sortMarkers(a: MarkerNode, b: MarkerNode): number {
55
- const markerA = a.marker as Marker<Diagnostic>;
56
- const markerB = b.marker as Marker<Diagnostic>;
57
-
58
- // Determine the marker with the highest severity.
59
- const severity = ProblemUtils.severityCompareMarker(markerA, markerB);
60
- if (severity !== 0) {
61
- return severity;
62
- }
63
- // Determine the marker with the lower line number.
64
- const lineNumber = ProblemUtils.lineNumberCompare(markerA, markerB);
65
- if (lineNumber !== 0) {
66
- return lineNumber;
67
- }
68
- // Determine the marker with the lower column number.
69
- const columnNumber = ProblemUtils.columnNumberCompare(markerA, markerB);
70
- if (columnNumber !== 0) {
71
- return columnNumber;
72
- }
73
- // Sort by owner in alphabetical order.
74
- const owner = ProblemUtils.ownerCompare(markerA, markerB);
75
- if (owner !== 0) {
76
- return owner;
77
- }
78
- return 0;
79
- }
80
-
81
- protected override insertNodeWithMarkers(node: MarkerInfoNode, markers: Marker<Diagnostic>[]): void {
82
- this.markers.push({ node, markers });
83
- this.doInsertNodesWithMarkers();
84
- }
85
-
86
- protected doInsertNodesWithMarkers = debounce(() => {
87
- ProblemCompositeTreeNode.addChildren(this.root as MarkerRootNode, this.markers);
88
-
89
- for (const { node, markers } of this.markers) {
90
- const children = this.getMarkerNodes(node, markers);
91
- node.numberOfMarkers = markers.length;
92
- this.setChildren(node, children);
93
- }
94
-
95
- this.markers.length = 0;
96
- }, 50);
97
- }
98
-
99
- @injectable()
100
- export class ProblemTreeModel extends MarkerTreeModel {
101
-
102
- @inject(ProblemManager) protected readonly problemManager: ProblemManager;
103
-
104
- protected override getOpenerOptionsByMarker(node: MarkerNode): OpenerOptions | undefined {
105
- if (ProblemMarker.is(node.marker)) {
106
- return {
107
- selection: node.marker.data.range
108
- };
109
- }
110
- return undefined;
111
- }
112
-
113
- removeNode(node: TreeNode): void {
114
- if (MarkerInfoNode.is(node)) {
115
- this.problemManager.cleanAllMarkers(node.uri);
116
- }
117
- if (MarkerNode.is(node)) {
118
- const { uri } = node;
119
- const { owner } = node.marker;
120
- const diagnostics = this.problemManager.findMarkers({ uri, owner, dataFilter: data => node.marker.data !== data }).map(({ data }) => data);
121
- this.problemManager.setMarkers(uri, owner, diagnostics);
122
- }
123
- }
124
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 TypeFox 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 { ProblemMarker } from '../../common/problem-marker';
18
+ import { ProblemManager } from './problem-manager';
19
+ import { ProblemCompositeTreeNode } from './problem-composite-tree-node';
20
+ import { MarkerNode, MarkerTree, MarkerOptions, MarkerInfoNode, MarkerRootNode } from '../marker-tree';
21
+ import { MarkerTreeModel } from '../marker-tree-model';
22
+ import { injectable, inject } from '@theia/core/shared/inversify';
23
+ import { OpenerOptions, TreeNode } from '@theia/core/lib/browser';
24
+ import { Marker } from '../../common/marker';
25
+ import { Diagnostic } from '@theia/core/shared/vscode-languageserver-protocol';
26
+ import { ProblemUtils } from './problem-utils';
27
+ import debounce = require('@theia/core/shared/lodash.debounce');
28
+
29
+ @injectable()
30
+ export class ProblemTree extends MarkerTree<Diagnostic> {
31
+ protected markers: { node: MarkerInfoNode, markers: Marker<Diagnostic>[] }[] = [];
32
+
33
+ constructor(
34
+ @inject(ProblemManager) markerManager: ProblemManager,
35
+ @inject(MarkerOptions) markerOptions: MarkerOptions
36
+ ) {
37
+ super(markerManager, markerOptions);
38
+ }
39
+
40
+ protected override getMarkerNodes(parent: MarkerInfoNode, markers: Marker<Diagnostic>[]): MarkerNode[] {
41
+ const nodes = super.getMarkerNodes(parent, markers);
42
+ return nodes.sort((a, b) => this.sortMarkers(a, b));
43
+ }
44
+
45
+ /**
46
+ * Sort markers based on the following rules:
47
+ * - Markers are fist sorted by `severity`.
48
+ * - Markers are sorted by `line number` if applicable.
49
+ * - Markers are sorted by `column number` if applicable.
50
+ * - Markers are then finally sorted by `owner` if applicable.
51
+ * @param a the first marker for comparison.
52
+ * @param b the second marker for comparison.
53
+ */
54
+ protected sortMarkers(a: MarkerNode, b: MarkerNode): number {
55
+ const markerA = a.marker as Marker<Diagnostic>;
56
+ const markerB = b.marker as Marker<Diagnostic>;
57
+
58
+ // Determine the marker with the highest severity.
59
+ const severity = ProblemUtils.severityCompareMarker(markerA, markerB);
60
+ if (severity !== 0) {
61
+ return severity;
62
+ }
63
+ // Determine the marker with the lower line number.
64
+ const lineNumber = ProblemUtils.lineNumberCompare(markerA, markerB);
65
+ if (lineNumber !== 0) {
66
+ return lineNumber;
67
+ }
68
+ // Determine the marker with the lower column number.
69
+ const columnNumber = ProblemUtils.columnNumberCompare(markerA, markerB);
70
+ if (columnNumber !== 0) {
71
+ return columnNumber;
72
+ }
73
+ // Sort by owner in alphabetical order.
74
+ const owner = ProblemUtils.ownerCompare(markerA, markerB);
75
+ if (owner !== 0) {
76
+ return owner;
77
+ }
78
+ return 0;
79
+ }
80
+
81
+ protected override insertNodeWithMarkers(node: MarkerInfoNode, markers: Marker<Diagnostic>[]): void {
82
+ this.markers.push({ node, markers });
83
+ this.doInsertNodesWithMarkers();
84
+ }
85
+
86
+ protected doInsertNodesWithMarkers = debounce(() => {
87
+ ProblemCompositeTreeNode.addChildren(this.root as MarkerRootNode, this.markers);
88
+
89
+ for (const { node, markers } of this.markers) {
90
+ const children = this.getMarkerNodes(node, markers);
91
+ node.numberOfMarkers = markers.length;
92
+ this.setChildren(node, children);
93
+ }
94
+
95
+ this.markers.length = 0;
96
+ }, 50);
97
+ }
98
+
99
+ @injectable()
100
+ export class ProblemTreeModel extends MarkerTreeModel {
101
+
102
+ @inject(ProblemManager) protected readonly problemManager: ProblemManager;
103
+
104
+ protected override getOpenerOptionsByMarker(node: MarkerNode): OpenerOptions | undefined {
105
+ if (ProblemMarker.is(node.marker)) {
106
+ return {
107
+ selection: node.marker.data.range
108
+ };
109
+ }
110
+ return undefined;
111
+ }
112
+
113
+ removeNode(node: TreeNode): void {
114
+ if (MarkerInfoNode.is(node)) {
115
+ this.problemManager.cleanAllMarkers(node.uri);
116
+ }
117
+ if (MarkerNode.is(node)) {
118
+ const { uri } = node;
119
+ const { owner } = node.marker;
120
+ const diagnostics = this.problemManager.findMarkers({ uri, owner, dataFilter: data => node.marker.data !== data }).map(({ data }) => data);
121
+ this.problemManager.setMarkers(uri, owner, diagnostics);
122
+ }
123
+ }
124
+ }