@theia/preferences 1.34.1 → 1.34.3

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 (128) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +81 -81
  3. package/lib/browser/abstract-resource-preference-provider.d.ts +46 -46
  4. package/lib/browser/abstract-resource-preference-provider.js +237 -237
  5. package/lib/browser/abstract-resource-preference-provider.spec.d.ts +1 -1
  6. package/lib/browser/abstract-resource-preference-provider.spec.js +83 -83
  7. package/lib/browser/folder-preference-provider.d.ts +20 -20
  8. package/lib/browser/folder-preference-provider.js +59 -59
  9. package/lib/browser/folders-preferences-provider.d.ts +25 -25
  10. package/lib/browser/folders-preferences-provider.js +239 -239
  11. package/lib/browser/index.d.ts +7 -7
  12. package/lib/browser/index.js +34 -34
  13. package/lib/browser/monaco-jsonc-editor.d.ts +9 -9
  14. package/lib/browser/monaco-jsonc-editor.js +80 -80
  15. package/lib/browser/package.spec.js +25 -25
  16. package/lib/browser/preference-bindings.d.ts +4 -4
  17. package/lib/browser/preference-bindings.js +63 -63
  18. package/lib/browser/preference-frontend-module.d.ts +6 -6
  19. package/lib/browser/preference-frontend-module.js +52 -52
  20. package/lib/browser/preference-open-handler.d.ts +9 -9
  21. package/lib/browser/preference-open-handler.js +64 -64
  22. package/lib/browser/preference-transaction-manager.d.ts +98 -98
  23. package/lib/browser/preference-transaction-manager.js +295 -295
  24. package/lib/browser/preference-tree-model.d.ts +59 -59
  25. package/lib/browser/preference-tree-model.js +240 -240
  26. package/lib/browser/preferences-contribution.d.ts +37 -37
  27. package/lib/browser/preferences-contribution.js +279 -279
  28. package/lib/browser/preferences-json-schema-contribution.d.ts +17 -17
  29. package/lib/browser/preferences-json-schema-contribution.js +91 -91
  30. package/lib/browser/preferences-monaco-contribution.d.ts +1 -1
  31. package/lib/browser/preferences-monaco-contribution.js +30 -30
  32. package/lib/browser/section-preference-provider.d.ts +21 -21
  33. package/lib/browser/section-preference-provider.js +96 -96
  34. package/lib/browser/user-configs-preference-provider.d.ts +21 -21
  35. package/lib/browser/user-configs-preference-provider.js +134 -134
  36. package/lib/browser/user-preference-provider.d.ts +13 -13
  37. package/lib/browser/user-preference-provider.js +41 -41
  38. package/lib/browser/util/preference-scope-command-manager.d.ts +17 -17
  39. package/lib/browser/util/preference-scope-command-manager.js +87 -87
  40. package/lib/browser/util/preference-tree-generator.d.ts +30 -30
  41. package/lib/browser/util/preference-tree-generator.js +234 -234
  42. package/lib/browser/util/preference-tree-label-provider.d.ts +11 -11
  43. package/lib/browser/util/preference-tree-label-provider.js +77 -77
  44. package/lib/browser/util/preference-tree-label-provider.spec.d.ts +1 -1
  45. package/lib/browser/util/preference-tree-label-provider.spec.js +87 -87
  46. package/lib/browser/util/preference-types.d.ts +62 -62
  47. package/lib/browser/util/preference-types.js +128 -128
  48. package/lib/browser/views/components/preference-array-input.d.ts +28 -28
  49. package/lib/browser/views/components/preference-array-input.js +180 -180
  50. package/lib/browser/views/components/preference-boolean-input.d.ts +17 -17
  51. package/lib/browser/views/components/preference-boolean-input.js +79 -79
  52. package/lib/browser/views/components/preference-file-input.d.ts +29 -29
  53. package/lib/browser/views/components/preference-file-input.js +110 -110
  54. package/lib/browser/views/components/preference-json-input.d.ts +19 -19
  55. package/lib/browser/views/components/preference-json-input.js +93 -93
  56. package/lib/browser/views/components/preference-node-renderer-creator.d.ts +48 -48
  57. package/lib/browser/views/components/preference-node-renderer-creator.js +132 -132
  58. package/lib/browser/views/components/preference-node-renderer.d.ts +111 -111
  59. package/lib/browser/views/components/preference-node-renderer.js +460 -460
  60. package/lib/browser/views/components/preference-number-input.d.ts +34 -34
  61. package/lib/browser/views/components/preference-number-input.js +142 -142
  62. package/lib/browser/views/components/preference-select-input.d.ts +27 -27
  63. package/lib/browser/views/components/preference-select-input.js +135 -135
  64. package/lib/browser/views/components/preference-string-input.d.ts +17 -17
  65. package/lib/browser/views/components/preference-string-input.js +89 -89
  66. package/lib/browser/views/preference-editor-widget.d.ts +67 -67
  67. package/lib/browser/views/preference-editor-widget.js +376 -376
  68. package/lib/browser/views/preference-scope-tabbar-widget.d.ts +54 -54
  69. package/lib/browser/views/preference-scope-tabbar-widget.js +343 -343
  70. package/lib/browser/views/preference-searchbar-widget.d.ts +53 -53
  71. package/lib/browser/views/preference-searchbar-widget.js +173 -173
  72. package/lib/browser/views/preference-tree-widget.d.ts +17 -17
  73. package/lib/browser/views/preference-tree-widget.js +104 -104
  74. package/lib/browser/views/preference-widget-bindings.d.ts +3 -3
  75. package/lib/browser/views/preference-widget-bindings.js +85 -85
  76. package/lib/browser/views/preference-widget.d.ts +35 -35
  77. package/lib/browser/views/preference-widget.js +123 -123
  78. package/lib/browser/workspace-file-preference-provider.d.ts +23 -23
  79. package/lib/browser/workspace-file-preference-provider.js +110 -110
  80. package/lib/browser/workspace-preference-provider.d.ts +28 -28
  81. package/lib/browser/workspace-preference-provider.js +142 -142
  82. package/package.json +9 -9
  83. package/src/browser/abstract-resource-preference-provider.spec.ts +95 -95
  84. package/src/browser/abstract-resource-preference-provider.ts +228 -228
  85. package/src/browser/folder-preference-provider.ts +58 -58
  86. package/src/browser/folders-preferences-provider.ts +236 -236
  87. package/src/browser/index.ts +23 -23
  88. package/src/browser/monaco-jsonc-editor.ts +67 -67
  89. package/src/browser/package.spec.ts +28 -28
  90. package/src/browser/preference-bindings.ts +65 -65
  91. package/src/browser/preference-frontend-module.ts +57 -57
  92. package/src/browser/preference-open-handler.ts +53 -53
  93. package/src/browser/preference-transaction-manager.ts +283 -283
  94. package/src/browser/preference-tree-model.ts +246 -246
  95. package/src/browser/preferences-contribution.ts +263 -263
  96. package/src/browser/preferences-json-schema-contribution.ts +86 -86
  97. package/src/browser/preferences-monaco-contribution.ts +30 -30
  98. package/src/browser/section-preference-provider.ts +83 -83
  99. package/src/browser/style/index.css +456 -456
  100. package/src/browser/style/preference-array.css +90 -90
  101. package/src/browser/style/preference-context-menu.css +74 -74
  102. package/src/browser/style/preference-file.css +32 -32
  103. package/src/browser/style/preference-object.css +49 -49
  104. package/src/browser/style/search-input.css +66 -66
  105. package/src/browser/user-configs-preference-provider.ts +123 -123
  106. package/src/browser/user-preference-provider.ts +35 -35
  107. package/src/browser/util/preference-scope-command-manager.ts +75 -75
  108. package/src/browser/util/preference-tree-generator.ts +222 -222
  109. package/src/browser/util/preference-tree-label-provider.spec.ts +108 -108
  110. package/src/browser/util/preference-tree-label-provider.ts +64 -64
  111. package/src/browser/util/preference-types.ts +169 -169
  112. package/src/browser/views/components/preference-array-input.ts +174 -174
  113. package/src/browser/views/components/preference-boolean-input.ts +69 -69
  114. package/src/browser/views/components/preference-file-input.ts +104 -104
  115. package/src/browser/views/components/preference-json-input.ts +78 -78
  116. package/src/browser/views/components/preference-node-renderer-creator.ts +141 -141
  117. package/src/browser/views/components/preference-node-renderer.ts +499 -499
  118. package/src/browser/views/components/preference-number-input.ts +147 -147
  119. package/src/browser/views/components/preference-select-input.ts +127 -127
  120. package/src/browser/views/components/preference-string-input.ts +76 -76
  121. package/src/browser/views/preference-editor-widget.ts +361 -361
  122. package/src/browser/views/preference-scope-tabbar-widget.tsx +344 -344
  123. package/src/browser/views/preference-searchbar-widget.tsx +183 -183
  124. package/src/browser/views/preference-tree-widget.tsx +93 -93
  125. package/src/browser/views/preference-widget-bindings.ts +99 -99
  126. package/src/browser/views/preference-widget.tsx +113 -113
  127. package/src/browser/workspace-file-preference-provider.ts +100 -100
  128. package/src/browser/workspace-preference-provider.ts +134 -134
@@ -1,499 +1,499 @@
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 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
- import {
19
- PreferenceService, ContextMenuRenderer, PreferenceInspection,
20
- PreferenceScope, PreferenceProvider, codicon, OpenerService, open
21
- } from '@theia/core/lib/browser';
22
- import { Preference, PreferenceMenus } from '../../util/preference-types';
23
- import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
24
- import { PreferencesScopeTabBar } from '../preference-scope-tabbar-widget';
25
- import { Disposable, nls } from '@theia/core/lib/common';
26
- import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
27
- import debounce = require('@theia/core/shared/lodash.debounce');
28
- import { PreferenceTreeModel } from '../../preference-tree-model';
29
- import { PreferencesSearchbarWidget } from '../preference-searchbar-widget';
30
- import * as markdownit from '@theia/core/shared/markdown-it';
31
- import * as DOMPurify from '@theia/core/shared/dompurify';
32
- import URI from '@theia/core/lib/common/uri';
33
-
34
- export const PreferenceNodeRendererFactory = Symbol('PreferenceNodeRendererFactory');
35
- export type PreferenceNodeRendererFactory = (node: Preference.TreeNode) => PreferenceNodeRenderer;
36
- export const HEADER_CLASS = 'settings-section-category-title';
37
- export const SUBHEADER_CLASS = 'settings-section-subcategory-title';
38
-
39
- export interface GeneralPreferenceNodeRenderer extends Disposable {
40
- node: HTMLElement;
41
- id: string;
42
- group: string;
43
- nodeId: string;
44
- visible: boolean;
45
- insertBefore(nextSibling: HTMLElement): void;
46
- insertAfter(previousSibling: HTMLElement): void;
47
- appendTo(parent: HTMLElement): void;
48
- prependTo(parent: HTMLElement): void;
49
- handleValueChange?(): void;
50
- handleSearchChange?(isFiltered?: boolean): void;
51
- handleScopeChange?(isFiltered?: boolean): void;
52
- hide(): void;
53
- show(): void;
54
- }
55
-
56
- @injectable()
57
- export abstract class PreferenceNodeRenderer implements Disposable, GeneralPreferenceNodeRenderer {
58
- @inject(Preference.Node) protected readonly preferenceNode: Preference.Node;
59
- @inject(PreferenceTreeLabelProvider) protected readonly labelProvider: PreferenceTreeLabelProvider;
60
-
61
- protected attached = false;
62
-
63
- _id: string;
64
- _group: string;
65
- _subgroup: string;
66
- protected domNode: HTMLElement;
67
-
68
- get node(): HTMLElement {
69
- return this.domNode;
70
- }
71
-
72
- get nodeId(): string {
73
- return this.preferenceNode.id;
74
- }
75
-
76
- get id(): string {
77
- return this._id;
78
- }
79
-
80
- get group(): string {
81
- return this._group;
82
- }
83
-
84
- get visible(): boolean {
85
- return !this.node.classList.contains('hidden');
86
- }
87
-
88
- @postConstruct()
89
- protected init(): void {
90
- this.setId();
91
- this.domNode = this.createDomNode();
92
- }
93
-
94
- protected setId(): void {
95
- const { id, group } = Preference.TreeNode.getGroupAndIdFromNodeId(this.preferenceNode.id);
96
- const segments = id.split('.');
97
- this._id = id;
98
- this._group = group;
99
- this._subgroup = (group === segments[0] ? segments[1] : segments[0]) ?? '';
100
- }
101
-
102
- protected abstract createDomNode(): HTMLElement;
103
-
104
- protected getAdditionalNodeClassnames(): Iterable<string> {
105
- return [];
106
- }
107
-
108
- insertBefore(nextSibling: HTMLElement): void {
109
- nextSibling.insertAdjacentElement('beforebegin', this.domNode);
110
- this.attached = true;
111
- }
112
-
113
- insertAfter(previousSibling: HTMLElement): void {
114
- previousSibling.insertAdjacentElement('afterend', this.domNode);
115
- }
116
-
117
- appendTo(parent: HTMLElement): void {
118
- parent.appendChild(this.domNode);
119
- }
120
-
121
- prependTo(parent: HTMLElement): void {
122
- parent.prepend(this.domNode);
123
- }
124
-
125
- hide(): void {
126
- this.domNode.classList.add('hidden');
127
- }
128
-
129
- show(): void {
130
- this.domNode.classList.remove('hidden');
131
- }
132
-
133
- dispose(): void {
134
- this.domNode.remove();
135
- }
136
- }
137
-
138
- export class PreferenceHeaderRenderer extends PreferenceNodeRenderer {
139
- protected createDomNode(): HTMLElement {
140
- const wrapper = document.createElement('ul');
141
- wrapper.className = 'settings-section';
142
- wrapper.id = `${this.preferenceNode.id}-editor`;
143
- const isCategory = Preference.TreeNode.isTopLevel(this.preferenceNode);
144
- const hierarchyClassName = isCategory ? HEADER_CLASS : SUBHEADER_CLASS;
145
- const name = this.labelProvider.getName(this.preferenceNode);
146
- const label = document.createElement('li');
147
- label.classList.add('settings-section-title', hierarchyClassName);
148
- label.textContent = name;
149
- wrapper.appendChild(label);
150
- return wrapper;
151
- }
152
- }
153
-
154
- @injectable()
155
- export abstract class PreferenceLeafNodeRenderer<ValueType extends JSONValue, InteractableType extends HTMLElement>
156
- extends PreferenceNodeRenderer
157
- implements Required<GeneralPreferenceNodeRenderer> {
158
- @inject(Preference.Node) protected override readonly preferenceNode: Preference.LeafNode;
159
- @inject(PreferenceService) protected readonly preferenceService: PreferenceService;
160
- @inject(ContextMenuRenderer) protected readonly menuRenderer: ContextMenuRenderer;
161
- @inject(PreferencesScopeTabBar) protected readonly scopeTracker: PreferencesScopeTabBar;
162
- @inject(PreferenceTreeModel) protected readonly model: PreferenceTreeModel;
163
- @inject(PreferencesSearchbarWidget) protected readonly searchbar: PreferencesSearchbarWidget;
164
- @inject(OpenerService) protected readonly openerService: OpenerService;
165
-
166
- protected headlineWrapper: HTMLDivElement;
167
- protected gutter: HTMLDivElement;
168
- protected interactable: InteractableType;
169
- protected inspection: PreferenceInspection<ValueType> | undefined;
170
- protected isModifiedFromDefault = false;
171
- protected markdownRenderer: markdownit;
172
-
173
- @postConstruct()
174
- protected override init(): void {
175
- this.setId();
176
- this.updateInspection();
177
- this.markdownRenderer = this.buildMarkdownRenderer();
178
- this.domNode = this.createDomNode();
179
- this.updateModificationStatus();
180
- }
181
-
182
- protected updateInspection(): void {
183
- this.inspection = this.preferenceService.inspect<ValueType>(this.id, this.scopeTracker.currentScope.uri);
184
- }
185
-
186
- protected buildMarkdownRenderer(): markdownit {
187
- const engine = markdownit();
188
- const inlineCode = engine.renderer.rules.code_inline;
189
-
190
- engine.renderer.rules.code_inline = (tokens, idx, options, env, self) => {
191
- const token = tokens[idx];
192
- const content = token.content;
193
- if (content.startsWith('#') && content.endsWith('#')) {
194
- const preferenceId = content.substring(1, content.length - 1);
195
- const preferenceNode = this.model.getNodeFromPreferenceId(preferenceId);
196
- if (preferenceNode) {
197
- let name = this.labelProvider.getName(preferenceNode);
198
- const prefix = this.labelProvider.getPrefix(preferenceNode, true);
199
- if (prefix) {
200
- name = prefix + name;
201
- }
202
- return `<a title="${preferenceId}" href="preference:${preferenceId}">${name}</a>`;
203
- } else {
204
- console.warn(`Linked preference "${preferenceId}" not found. Source: "${this.preferenceNode.preferenceId}"`);
205
- }
206
- }
207
- return inlineCode ? inlineCode(tokens, idx, options, env, self) : '';
208
- };
209
- return engine;
210
- }
211
-
212
- protected openLink(event: MouseEvent): void {
213
- if (event.target instanceof HTMLAnchorElement) {
214
- event.preventDefault();
215
- event.stopPropagation();
216
- // Exclude right click
217
- if (event.button < 2) {
218
- const uri = new URI(event.target.href);
219
- open(this.openerService, uri);
220
- }
221
- }
222
- }
223
-
224
- protected createDomNode(): HTMLLIElement {
225
- const wrapper = document.createElement('li');
226
- wrapper.classList.add('single-pref');
227
- wrapper.id = `${this.id}-editor`;
228
- wrapper.tabIndex = 0;
229
- wrapper.setAttribute('data-pref-id', this.id);
230
- wrapper.setAttribute('data-node-id', this.preferenceNode.id);
231
-
232
- const headlineWrapper = document.createElement('div');
233
- headlineWrapper.classList.add('pref-name');
234
- headlineWrapper.title = this.id;
235
- this.headlineWrapper = headlineWrapper;
236
- wrapper.appendChild(headlineWrapper);
237
-
238
- this.updateHeadline();
239
-
240
- const gutter = document.createElement('div');
241
- gutter.classList.add('pref-context-gutter');
242
- this.gutter = gutter;
243
- wrapper.appendChild(gutter);
244
-
245
- const cog = document.createElement('i');
246
- cog.className = `${codicon('settings-gear', true)} settings-context-menu-btn`;
247
- cog.setAttribute('aria-label', 'Open Context Menu');
248
- cog.setAttribute('role', 'button');
249
- cog.onclick = this.handleCogAction.bind(this);
250
- cog.onkeydown = this.handleCogAction.bind(this);
251
- cog.title = nls.localizeByDefault('More Actions...');
252
- gutter.appendChild(cog);
253
-
254
- const contentWrapper = document.createElement('div');
255
- contentWrapper.classList.add('pref-content-container', ...this.getAdditionalNodeClassnames());
256
- wrapper.appendChild(contentWrapper);
257
-
258
- const { description, markdownDescription } = this.preferenceNode.preference.data;
259
- if (markdownDescription || description) {
260
- const descriptionWrapper = document.createElement('div');
261
- descriptionWrapper.classList.add('pref-description');
262
- if (markdownDescription) {
263
- const renderedDescription = this.markdownRenderer.render(markdownDescription);
264
- descriptionWrapper.onauxclick = this.openLink.bind(this);
265
- descriptionWrapper.onclick = this.openLink.bind(this);
266
- descriptionWrapper.oncontextmenu = () => false;
267
- descriptionWrapper.innerHTML = DOMPurify.sanitize(renderedDescription, {
268
- ALLOW_UNKNOWN_PROTOCOLS: true
269
- });
270
- } else if (description) {
271
- descriptionWrapper.textContent = description;
272
- }
273
- contentWrapper.appendChild(descriptionWrapper);
274
- }
275
-
276
- const interactableWrapper = document.createElement('div');
277
- interactableWrapper.classList.add('pref-input');
278
- contentWrapper.appendChild(interactableWrapper);
279
- this.createInteractable(interactableWrapper);
280
-
281
- return wrapper;
282
- }
283
-
284
- protected handleCogAction({ currentTarget }: KeyboardEvent | MouseEvent): void {
285
- const value = Preference.getValueInScope(this.inspection, this.scopeTracker.currentScope.scope) ?? this.inspection?.defaultValue;
286
- const target = currentTarget as HTMLElement | undefined;
287
- if (target && value !== undefined) {
288
- this.showCog();
289
- const domRect = target.getBoundingClientRect();
290
- this.menuRenderer.render({
291
- menuPath: PreferenceMenus.PREFERENCE_EDITOR_CONTEXT_MENU,
292
- anchor: { x: domRect.left, y: domRect.bottom },
293
- args: [{ id: this.id, value }],
294
- onHide: () => this.hideCog()
295
- });
296
- }
297
- }
298
-
299
- protected addModifiedMarking(): void {
300
- this.gutter.classList.add('theia-mod-item-modified');
301
- }
302
-
303
- protected removeModifiedMarking(): void {
304
- this.gutter.classList.remove('theia-mod-item-modified');
305
- }
306
-
307
- protected showCog(): void {
308
- this.gutter.classList.add('show-cog');
309
- }
310
-
311
- protected hideCog(): void {
312
- this.gutter.classList.remove('show-cog');
313
- }
314
-
315
- protected updateModificationStatus(knownCurrentValue?: JSONValue): void {
316
- const wasModified = this.isModifiedFromDefault;
317
- const { inspection } = this;
318
- const valueInCurrentScope = knownCurrentValue ?? Preference.getValueInScope(inspection, this.scopeTracker.currentScope.scope);
319
- this.isModifiedFromDefault = valueInCurrentScope !== undefined && !PreferenceProvider.deepEqual(valueInCurrentScope, inspection?.defaultValue);
320
- if (wasModified !== this.isModifiedFromDefault) {
321
- this.gutter.classList.toggle('theia-mod-item-modified', this.isModifiedFromDefault);
322
- }
323
- }
324
-
325
- protected updateHeadline(filtered = this.model.isFiltered): void {
326
- const { headlineWrapper } = this;
327
- if (this.headlineWrapper.childElementCount === 0) {
328
- const name = this.labelProvider.getName(this.preferenceNode);
329
- const nameWrapper = document.createElement('span');
330
- nameWrapper.classList.add('preference-leaf-headline-name');
331
- nameWrapper.textContent = name;
332
- headlineWrapper.appendChild(nameWrapper);
333
- }
334
- const prefix = this.labelProvider.getPrefix(this.preferenceNode, filtered);
335
- const currentFirstChild = headlineWrapper.children[0];
336
- const currentFirstChildIsPrefix = currentFirstChild.classList.contains('preference-leaf-headline-prefix');
337
- if (prefix) {
338
- let prefixWrapper;
339
- if (currentFirstChildIsPrefix) {
340
- prefixWrapper = currentFirstChild;
341
- } else {
342
- prefixWrapper = document.createElement('span');
343
- prefixWrapper.classList.add('preference-leaf-headline-prefix');
344
- headlineWrapper.insertBefore(prefixWrapper, currentFirstChild);
345
- }
346
- prefixWrapper.textContent = prefix;
347
- } else if (currentFirstChildIsPrefix) {
348
- headlineWrapper.removeChild(currentFirstChild);
349
- }
350
-
351
- const currentLastChild = headlineWrapper.lastChild as HTMLElement;
352
- if (currentLastChild.classList.contains('preference-leaf-headline-suffix')) {
353
- this.compareOtherModifiedScopes(headlineWrapper, currentLastChild);
354
- } else {
355
- this.createOtherModifiedScopes(headlineWrapper);
356
- }
357
- }
358
-
359
- protected compareOtherModifiedScopes(headlineWrapper: HTMLDivElement, currentSuffix: HTMLElement): void {
360
- const modifiedScopes = this.getModifiedScopesAsStrings();
361
- if (modifiedScopes.length === 0) {
362
- headlineWrapper.removeChild(currentSuffix);
363
- } else {
364
-
365
- const modifiedMessagePrefix = currentSuffix.children[0] as HTMLElement;
366
- const newMessagePrefix = this.getModifiedMessagePrefix();
367
- if (modifiedMessagePrefix.textContent !== newMessagePrefix) {
368
- modifiedMessagePrefix.textContent = newMessagePrefix;
369
- }
370
-
371
- const [firstModifiedScope, secondModifiedScope] = modifiedScopes;
372
-
373
- const firstScopeMessage = currentSuffix.children[1] as HTMLElement;
374
- const secondScopeMessage = currentSuffix.children[2] as HTMLElement;
375
- firstScopeMessage.children[0].textContent = PreferenceScope[firstModifiedScope];
376
- this.addEventHandlerToModifiedScope(firstModifiedScope, firstScopeMessage.children[0] as HTMLElement);
377
- if (modifiedScopes.length === 1 && secondScopeMessage) {
378
- currentSuffix.removeChild(secondScopeMessage);
379
- } else if (modifiedScopes.length === 2 && !secondScopeMessage) {
380
- const newSecondMessage = this.createModifiedScopeMessage(secondModifiedScope);
381
- currentSuffix.appendChild(newSecondMessage);
382
- }
383
- // If both scopes are modified and both messages are present, do nothing.
384
- }
385
- }
386
-
387
- protected createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void {
388
- const modifiedScopes = this.getModifiedScopesAsStrings();
389
- if (modifiedScopes.length !== 0) {
390
- const wrapper = document.createElement('i');
391
- wrapper.classList.add('preference-leaf-headline-suffix');
392
- headlineWrapper.appendChild(wrapper);
393
-
394
- const messagePrefix = this.getModifiedMessagePrefix();
395
- const messageWrapper = document.createElement('span');
396
- messageWrapper.classList.add('preference-other-modified-scope-alert');
397
- messageWrapper.textContent = messagePrefix;
398
- wrapper.appendChild(messageWrapper);
399
- modifiedScopes.forEach((scopeName, i) => {
400
- const scopeWrapper = this.createModifiedScopeMessage(scopeName);
401
- wrapper.appendChild(scopeWrapper);
402
- });
403
- }
404
- }
405
-
406
- protected createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement {
407
- const scopeWrapper = document.createElement('span');
408
- scopeWrapper.classList.add('preference-modified-scope-wrapper');
409
- const scopeInteractable = document.createElement('span');
410
- scopeInteractable.classList.add('preference-scope-underlined');
411
- const scopeName = PreferenceScope[scope];
412
- this.addEventHandlerToModifiedScope(scope, scopeInteractable);
413
- scopeInteractable.textContent = scopeName;
414
- scopeWrapper.appendChild(scopeInteractable);
415
- return scopeWrapper;
416
- }
417
-
418
- protected getModifiedMessagePrefix(): string {
419
- return (this.isModifiedFromDefault ? nls.localizeByDefault('Also modified in') : nls.localizeByDefault('Modified in')) + ': ';
420
- }
421
-
422
- protected addEventHandlerToModifiedScope(scope: PreferenceScope, scopeWrapper: HTMLElement): void {
423
- if (scope === PreferenceScope.User || scope === PreferenceScope.Workspace) {
424
- const eventHandler = () => {
425
- this.scopeTracker.setScope(scope);
426
- this.searchbar.updateSearchTerm(this.id);
427
- };
428
- scopeWrapper.onclick = eventHandler;
429
- scopeWrapper.onkeydown = eventHandler;
430
- scopeWrapper.tabIndex = 0;
431
- } else {
432
- scopeWrapper.onclick = null; // eslint-disable-line no-null/no-null
433
- scopeWrapper.onkeydown = null; // eslint-disable-line no-null/no-null
434
- scopeWrapper.tabIndex = -1;
435
- }
436
- }
437
-
438
- protected getModifiedScopesAsStrings(): PreferenceScope[] {
439
- const currentScopeInView = this.scopeTracker.currentScope.scope;
440
- const { inspection } = this;
441
- const modifiedScopes = [];
442
- if (inspection) {
443
- for (const otherScope of [PreferenceScope.User, PreferenceScope.Workspace]) {
444
- if (otherScope !== currentScopeInView) {
445
- const valueInOtherScope = Preference.getValueInScope(inspection, otherScope);
446
- if (valueInOtherScope !== undefined && !PreferenceProvider.deepEqual(valueInOtherScope, inspection.defaultValue)) {
447
- modifiedScopes.push(otherScope);
448
- }
449
- }
450
- }
451
- }
452
- return modifiedScopes;
453
- }
454
-
455
- // Many preferences allow `null` and even use it as a default regardless of the declared type.
456
- protected getValue(): ValueType | null {
457
- let currentValue = Preference.getValueInScope(this.inspection, this.scopeTracker.currentScope.scope);
458
- if (currentValue === undefined) {
459
- currentValue = this.inspection?.defaultValue;
460
- }
461
- return currentValue !== undefined ? currentValue : this.getFallbackValue();
462
- }
463
-
464
- protected setPreferenceWithDebounce = debounce(this.setPreferenceImmediately.bind(this), 500, { leading: false, trailing: true });
465
-
466
- protected setPreferenceImmediately(value: ValueType | undefined): Promise<void> {
467
- return this.preferenceService.set(this.id, value, this.scopeTracker.currentScope.scope, this.scopeTracker.currentScope.uri)
468
- .catch(() => this.handleValueChange());
469
- }
470
-
471
- handleSearchChange(isFiltered = this.model.isFiltered): void {
472
- this.updateHeadline(isFiltered);
473
- }
474
-
475
- handleScopeChange(isFiltered = this.model.isFiltered): void {
476
- this.handleValueChange();
477
- this.updateHeadline(isFiltered);
478
- }
479
-
480
- handleValueChange(): void {
481
- this.doHandleValueChange();
482
- this.updateHeadline();
483
- }
484
-
485
- /**
486
- * Should create an HTML element that the user can interact with to change the value of the preference.
487
- * @param container the parent element for the interactable. This method is responsible for adding the new element to its parent.
488
- */
489
- protected abstract createInteractable(container: HTMLElement): void;
490
- /**
491
- * @returns a fallback default value for a preference of the type implemented by a concrete leaf renderer
492
- * This function is only called if the default value for a given preference is not specified in its schema.
493
- */
494
- protected abstract getFallbackValue(): ValueType;
495
- /**
496
- * This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.
497
- */
498
- protected abstract doHandleValueChange(): void;
499
- }
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 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
+ import {
19
+ PreferenceService, ContextMenuRenderer, PreferenceInspection,
20
+ PreferenceScope, PreferenceProvider, codicon, OpenerService, open
21
+ } from '@theia/core/lib/browser';
22
+ import { Preference, PreferenceMenus } from '../../util/preference-types';
23
+ import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
24
+ import { PreferencesScopeTabBar } from '../preference-scope-tabbar-widget';
25
+ import { Disposable, nls } from '@theia/core/lib/common';
26
+ import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
27
+ import debounce = require('@theia/core/shared/lodash.debounce');
28
+ import { PreferenceTreeModel } from '../../preference-tree-model';
29
+ import { PreferencesSearchbarWidget } from '../preference-searchbar-widget';
30
+ import * as markdownit from '@theia/core/shared/markdown-it';
31
+ import * as DOMPurify from '@theia/core/shared/dompurify';
32
+ import URI from '@theia/core/lib/common/uri';
33
+
34
+ export const PreferenceNodeRendererFactory = Symbol('PreferenceNodeRendererFactory');
35
+ export type PreferenceNodeRendererFactory = (node: Preference.TreeNode) => PreferenceNodeRenderer;
36
+ export const HEADER_CLASS = 'settings-section-category-title';
37
+ export const SUBHEADER_CLASS = 'settings-section-subcategory-title';
38
+
39
+ export interface GeneralPreferenceNodeRenderer extends Disposable {
40
+ node: HTMLElement;
41
+ id: string;
42
+ group: string;
43
+ nodeId: string;
44
+ visible: boolean;
45
+ insertBefore(nextSibling: HTMLElement): void;
46
+ insertAfter(previousSibling: HTMLElement): void;
47
+ appendTo(parent: HTMLElement): void;
48
+ prependTo(parent: HTMLElement): void;
49
+ handleValueChange?(): void;
50
+ handleSearchChange?(isFiltered?: boolean): void;
51
+ handleScopeChange?(isFiltered?: boolean): void;
52
+ hide(): void;
53
+ show(): void;
54
+ }
55
+
56
+ @injectable()
57
+ export abstract class PreferenceNodeRenderer implements Disposable, GeneralPreferenceNodeRenderer {
58
+ @inject(Preference.Node) protected readonly preferenceNode: Preference.Node;
59
+ @inject(PreferenceTreeLabelProvider) protected readonly labelProvider: PreferenceTreeLabelProvider;
60
+
61
+ protected attached = false;
62
+
63
+ _id: string;
64
+ _group: string;
65
+ _subgroup: string;
66
+ protected domNode: HTMLElement;
67
+
68
+ get node(): HTMLElement {
69
+ return this.domNode;
70
+ }
71
+
72
+ get nodeId(): string {
73
+ return this.preferenceNode.id;
74
+ }
75
+
76
+ get id(): string {
77
+ return this._id;
78
+ }
79
+
80
+ get group(): string {
81
+ return this._group;
82
+ }
83
+
84
+ get visible(): boolean {
85
+ return !this.node.classList.contains('hidden');
86
+ }
87
+
88
+ @postConstruct()
89
+ protected init(): void {
90
+ this.setId();
91
+ this.domNode = this.createDomNode();
92
+ }
93
+
94
+ protected setId(): void {
95
+ const { id, group } = Preference.TreeNode.getGroupAndIdFromNodeId(this.preferenceNode.id);
96
+ const segments = id.split('.');
97
+ this._id = id;
98
+ this._group = group;
99
+ this._subgroup = (group === segments[0] ? segments[1] : segments[0]) ?? '';
100
+ }
101
+
102
+ protected abstract createDomNode(): HTMLElement;
103
+
104
+ protected getAdditionalNodeClassnames(): Iterable<string> {
105
+ return [];
106
+ }
107
+
108
+ insertBefore(nextSibling: HTMLElement): void {
109
+ nextSibling.insertAdjacentElement('beforebegin', this.domNode);
110
+ this.attached = true;
111
+ }
112
+
113
+ insertAfter(previousSibling: HTMLElement): void {
114
+ previousSibling.insertAdjacentElement('afterend', this.domNode);
115
+ }
116
+
117
+ appendTo(parent: HTMLElement): void {
118
+ parent.appendChild(this.domNode);
119
+ }
120
+
121
+ prependTo(parent: HTMLElement): void {
122
+ parent.prepend(this.domNode);
123
+ }
124
+
125
+ hide(): void {
126
+ this.domNode.classList.add('hidden');
127
+ }
128
+
129
+ show(): void {
130
+ this.domNode.classList.remove('hidden');
131
+ }
132
+
133
+ dispose(): void {
134
+ this.domNode.remove();
135
+ }
136
+ }
137
+
138
+ export class PreferenceHeaderRenderer extends PreferenceNodeRenderer {
139
+ protected createDomNode(): HTMLElement {
140
+ const wrapper = document.createElement('ul');
141
+ wrapper.className = 'settings-section';
142
+ wrapper.id = `${this.preferenceNode.id}-editor`;
143
+ const isCategory = Preference.TreeNode.isTopLevel(this.preferenceNode);
144
+ const hierarchyClassName = isCategory ? HEADER_CLASS : SUBHEADER_CLASS;
145
+ const name = this.labelProvider.getName(this.preferenceNode);
146
+ const label = document.createElement('li');
147
+ label.classList.add('settings-section-title', hierarchyClassName);
148
+ label.textContent = name;
149
+ wrapper.appendChild(label);
150
+ return wrapper;
151
+ }
152
+ }
153
+
154
+ @injectable()
155
+ export abstract class PreferenceLeafNodeRenderer<ValueType extends JSONValue, InteractableType extends HTMLElement>
156
+ extends PreferenceNodeRenderer
157
+ implements Required<GeneralPreferenceNodeRenderer> {
158
+ @inject(Preference.Node) protected override readonly preferenceNode: Preference.LeafNode;
159
+ @inject(PreferenceService) protected readonly preferenceService: PreferenceService;
160
+ @inject(ContextMenuRenderer) protected readonly menuRenderer: ContextMenuRenderer;
161
+ @inject(PreferencesScopeTabBar) protected readonly scopeTracker: PreferencesScopeTabBar;
162
+ @inject(PreferenceTreeModel) protected readonly model: PreferenceTreeModel;
163
+ @inject(PreferencesSearchbarWidget) protected readonly searchbar: PreferencesSearchbarWidget;
164
+ @inject(OpenerService) protected readonly openerService: OpenerService;
165
+
166
+ protected headlineWrapper: HTMLDivElement;
167
+ protected gutter: HTMLDivElement;
168
+ protected interactable: InteractableType;
169
+ protected inspection: PreferenceInspection<ValueType> | undefined;
170
+ protected isModifiedFromDefault = false;
171
+ protected markdownRenderer: markdownit;
172
+
173
+ @postConstruct()
174
+ protected override init(): void {
175
+ this.setId();
176
+ this.updateInspection();
177
+ this.markdownRenderer = this.buildMarkdownRenderer();
178
+ this.domNode = this.createDomNode();
179
+ this.updateModificationStatus();
180
+ }
181
+
182
+ protected updateInspection(): void {
183
+ this.inspection = this.preferenceService.inspect<ValueType>(this.id, this.scopeTracker.currentScope.uri);
184
+ }
185
+
186
+ protected buildMarkdownRenderer(): markdownit {
187
+ const engine = markdownit();
188
+ const inlineCode = engine.renderer.rules.code_inline;
189
+
190
+ engine.renderer.rules.code_inline = (tokens, idx, options, env, self) => {
191
+ const token = tokens[idx];
192
+ const content = token.content;
193
+ if (content.startsWith('#') && content.endsWith('#')) {
194
+ const preferenceId = content.substring(1, content.length - 1);
195
+ const preferenceNode = this.model.getNodeFromPreferenceId(preferenceId);
196
+ if (preferenceNode) {
197
+ let name = this.labelProvider.getName(preferenceNode);
198
+ const prefix = this.labelProvider.getPrefix(preferenceNode, true);
199
+ if (prefix) {
200
+ name = prefix + name;
201
+ }
202
+ return `<a title="${preferenceId}" href="preference:${preferenceId}">${name}</a>`;
203
+ } else {
204
+ console.warn(`Linked preference "${preferenceId}" not found. Source: "${this.preferenceNode.preferenceId}"`);
205
+ }
206
+ }
207
+ return inlineCode ? inlineCode(tokens, idx, options, env, self) : '';
208
+ };
209
+ return engine;
210
+ }
211
+
212
+ protected openLink(event: MouseEvent): void {
213
+ if (event.target instanceof HTMLAnchorElement) {
214
+ event.preventDefault();
215
+ event.stopPropagation();
216
+ // Exclude right click
217
+ if (event.button < 2) {
218
+ const uri = new URI(event.target.href);
219
+ open(this.openerService, uri);
220
+ }
221
+ }
222
+ }
223
+
224
+ protected createDomNode(): HTMLLIElement {
225
+ const wrapper = document.createElement('li');
226
+ wrapper.classList.add('single-pref');
227
+ wrapper.id = `${this.id}-editor`;
228
+ wrapper.tabIndex = 0;
229
+ wrapper.setAttribute('data-pref-id', this.id);
230
+ wrapper.setAttribute('data-node-id', this.preferenceNode.id);
231
+
232
+ const headlineWrapper = document.createElement('div');
233
+ headlineWrapper.classList.add('pref-name');
234
+ headlineWrapper.title = this.id;
235
+ this.headlineWrapper = headlineWrapper;
236
+ wrapper.appendChild(headlineWrapper);
237
+
238
+ this.updateHeadline();
239
+
240
+ const gutter = document.createElement('div');
241
+ gutter.classList.add('pref-context-gutter');
242
+ this.gutter = gutter;
243
+ wrapper.appendChild(gutter);
244
+
245
+ const cog = document.createElement('i');
246
+ cog.className = `${codicon('settings-gear', true)} settings-context-menu-btn`;
247
+ cog.setAttribute('aria-label', 'Open Context Menu');
248
+ cog.setAttribute('role', 'button');
249
+ cog.onclick = this.handleCogAction.bind(this);
250
+ cog.onkeydown = this.handleCogAction.bind(this);
251
+ cog.title = nls.localizeByDefault('More Actions...');
252
+ gutter.appendChild(cog);
253
+
254
+ const contentWrapper = document.createElement('div');
255
+ contentWrapper.classList.add('pref-content-container', ...this.getAdditionalNodeClassnames());
256
+ wrapper.appendChild(contentWrapper);
257
+
258
+ const { description, markdownDescription } = this.preferenceNode.preference.data;
259
+ if (markdownDescription || description) {
260
+ const descriptionWrapper = document.createElement('div');
261
+ descriptionWrapper.classList.add('pref-description');
262
+ if (markdownDescription) {
263
+ const renderedDescription = this.markdownRenderer.render(markdownDescription);
264
+ descriptionWrapper.onauxclick = this.openLink.bind(this);
265
+ descriptionWrapper.onclick = this.openLink.bind(this);
266
+ descriptionWrapper.oncontextmenu = () => false;
267
+ descriptionWrapper.innerHTML = DOMPurify.sanitize(renderedDescription, {
268
+ ALLOW_UNKNOWN_PROTOCOLS: true
269
+ });
270
+ } else if (description) {
271
+ descriptionWrapper.textContent = description;
272
+ }
273
+ contentWrapper.appendChild(descriptionWrapper);
274
+ }
275
+
276
+ const interactableWrapper = document.createElement('div');
277
+ interactableWrapper.classList.add('pref-input');
278
+ contentWrapper.appendChild(interactableWrapper);
279
+ this.createInteractable(interactableWrapper);
280
+
281
+ return wrapper;
282
+ }
283
+
284
+ protected handleCogAction({ currentTarget }: KeyboardEvent | MouseEvent): void {
285
+ const value = Preference.getValueInScope(this.inspection, this.scopeTracker.currentScope.scope) ?? this.inspection?.defaultValue;
286
+ const target = currentTarget as HTMLElement | undefined;
287
+ if (target && value !== undefined) {
288
+ this.showCog();
289
+ const domRect = target.getBoundingClientRect();
290
+ this.menuRenderer.render({
291
+ menuPath: PreferenceMenus.PREFERENCE_EDITOR_CONTEXT_MENU,
292
+ anchor: { x: domRect.left, y: domRect.bottom },
293
+ args: [{ id: this.id, value }],
294
+ onHide: () => this.hideCog()
295
+ });
296
+ }
297
+ }
298
+
299
+ protected addModifiedMarking(): void {
300
+ this.gutter.classList.add('theia-mod-item-modified');
301
+ }
302
+
303
+ protected removeModifiedMarking(): void {
304
+ this.gutter.classList.remove('theia-mod-item-modified');
305
+ }
306
+
307
+ protected showCog(): void {
308
+ this.gutter.classList.add('show-cog');
309
+ }
310
+
311
+ protected hideCog(): void {
312
+ this.gutter.classList.remove('show-cog');
313
+ }
314
+
315
+ protected updateModificationStatus(knownCurrentValue?: JSONValue): void {
316
+ const wasModified = this.isModifiedFromDefault;
317
+ const { inspection } = this;
318
+ const valueInCurrentScope = knownCurrentValue ?? Preference.getValueInScope(inspection, this.scopeTracker.currentScope.scope);
319
+ this.isModifiedFromDefault = valueInCurrentScope !== undefined && !PreferenceProvider.deepEqual(valueInCurrentScope, inspection?.defaultValue);
320
+ if (wasModified !== this.isModifiedFromDefault) {
321
+ this.gutter.classList.toggle('theia-mod-item-modified', this.isModifiedFromDefault);
322
+ }
323
+ }
324
+
325
+ protected updateHeadline(filtered = this.model.isFiltered): void {
326
+ const { headlineWrapper } = this;
327
+ if (this.headlineWrapper.childElementCount === 0) {
328
+ const name = this.labelProvider.getName(this.preferenceNode);
329
+ const nameWrapper = document.createElement('span');
330
+ nameWrapper.classList.add('preference-leaf-headline-name');
331
+ nameWrapper.textContent = name;
332
+ headlineWrapper.appendChild(nameWrapper);
333
+ }
334
+ const prefix = this.labelProvider.getPrefix(this.preferenceNode, filtered);
335
+ const currentFirstChild = headlineWrapper.children[0];
336
+ const currentFirstChildIsPrefix = currentFirstChild.classList.contains('preference-leaf-headline-prefix');
337
+ if (prefix) {
338
+ let prefixWrapper;
339
+ if (currentFirstChildIsPrefix) {
340
+ prefixWrapper = currentFirstChild;
341
+ } else {
342
+ prefixWrapper = document.createElement('span');
343
+ prefixWrapper.classList.add('preference-leaf-headline-prefix');
344
+ headlineWrapper.insertBefore(prefixWrapper, currentFirstChild);
345
+ }
346
+ prefixWrapper.textContent = prefix;
347
+ } else if (currentFirstChildIsPrefix) {
348
+ headlineWrapper.removeChild(currentFirstChild);
349
+ }
350
+
351
+ const currentLastChild = headlineWrapper.lastChild as HTMLElement;
352
+ if (currentLastChild.classList.contains('preference-leaf-headline-suffix')) {
353
+ this.compareOtherModifiedScopes(headlineWrapper, currentLastChild);
354
+ } else {
355
+ this.createOtherModifiedScopes(headlineWrapper);
356
+ }
357
+ }
358
+
359
+ protected compareOtherModifiedScopes(headlineWrapper: HTMLDivElement, currentSuffix: HTMLElement): void {
360
+ const modifiedScopes = this.getModifiedScopesAsStrings();
361
+ if (modifiedScopes.length === 0) {
362
+ headlineWrapper.removeChild(currentSuffix);
363
+ } else {
364
+
365
+ const modifiedMessagePrefix = currentSuffix.children[0] as HTMLElement;
366
+ const newMessagePrefix = this.getModifiedMessagePrefix();
367
+ if (modifiedMessagePrefix.textContent !== newMessagePrefix) {
368
+ modifiedMessagePrefix.textContent = newMessagePrefix;
369
+ }
370
+
371
+ const [firstModifiedScope, secondModifiedScope] = modifiedScopes;
372
+
373
+ const firstScopeMessage = currentSuffix.children[1] as HTMLElement;
374
+ const secondScopeMessage = currentSuffix.children[2] as HTMLElement;
375
+ firstScopeMessage.children[0].textContent = PreferenceScope[firstModifiedScope];
376
+ this.addEventHandlerToModifiedScope(firstModifiedScope, firstScopeMessage.children[0] as HTMLElement);
377
+ if (modifiedScopes.length === 1 && secondScopeMessage) {
378
+ currentSuffix.removeChild(secondScopeMessage);
379
+ } else if (modifiedScopes.length === 2 && !secondScopeMessage) {
380
+ const newSecondMessage = this.createModifiedScopeMessage(secondModifiedScope);
381
+ currentSuffix.appendChild(newSecondMessage);
382
+ }
383
+ // If both scopes are modified and both messages are present, do nothing.
384
+ }
385
+ }
386
+
387
+ protected createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void {
388
+ const modifiedScopes = this.getModifiedScopesAsStrings();
389
+ if (modifiedScopes.length !== 0) {
390
+ const wrapper = document.createElement('i');
391
+ wrapper.classList.add('preference-leaf-headline-suffix');
392
+ headlineWrapper.appendChild(wrapper);
393
+
394
+ const messagePrefix = this.getModifiedMessagePrefix();
395
+ const messageWrapper = document.createElement('span');
396
+ messageWrapper.classList.add('preference-other-modified-scope-alert');
397
+ messageWrapper.textContent = messagePrefix;
398
+ wrapper.appendChild(messageWrapper);
399
+ modifiedScopes.forEach((scopeName, i) => {
400
+ const scopeWrapper = this.createModifiedScopeMessage(scopeName);
401
+ wrapper.appendChild(scopeWrapper);
402
+ });
403
+ }
404
+ }
405
+
406
+ protected createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement {
407
+ const scopeWrapper = document.createElement('span');
408
+ scopeWrapper.classList.add('preference-modified-scope-wrapper');
409
+ const scopeInteractable = document.createElement('span');
410
+ scopeInteractable.classList.add('preference-scope-underlined');
411
+ const scopeName = PreferenceScope[scope];
412
+ this.addEventHandlerToModifiedScope(scope, scopeInteractable);
413
+ scopeInteractable.textContent = scopeName;
414
+ scopeWrapper.appendChild(scopeInteractable);
415
+ return scopeWrapper;
416
+ }
417
+
418
+ protected getModifiedMessagePrefix(): string {
419
+ return (this.isModifiedFromDefault ? nls.localizeByDefault('Also modified in') : nls.localizeByDefault('Modified in')) + ': ';
420
+ }
421
+
422
+ protected addEventHandlerToModifiedScope(scope: PreferenceScope, scopeWrapper: HTMLElement): void {
423
+ if (scope === PreferenceScope.User || scope === PreferenceScope.Workspace) {
424
+ const eventHandler = () => {
425
+ this.scopeTracker.setScope(scope);
426
+ this.searchbar.updateSearchTerm(this.id);
427
+ };
428
+ scopeWrapper.onclick = eventHandler;
429
+ scopeWrapper.onkeydown = eventHandler;
430
+ scopeWrapper.tabIndex = 0;
431
+ } else {
432
+ scopeWrapper.onclick = null; // eslint-disable-line no-null/no-null
433
+ scopeWrapper.onkeydown = null; // eslint-disable-line no-null/no-null
434
+ scopeWrapper.tabIndex = -1;
435
+ }
436
+ }
437
+
438
+ protected getModifiedScopesAsStrings(): PreferenceScope[] {
439
+ const currentScopeInView = this.scopeTracker.currentScope.scope;
440
+ const { inspection } = this;
441
+ const modifiedScopes = [];
442
+ if (inspection) {
443
+ for (const otherScope of [PreferenceScope.User, PreferenceScope.Workspace]) {
444
+ if (otherScope !== currentScopeInView) {
445
+ const valueInOtherScope = Preference.getValueInScope(inspection, otherScope);
446
+ if (valueInOtherScope !== undefined && !PreferenceProvider.deepEqual(valueInOtherScope, inspection.defaultValue)) {
447
+ modifiedScopes.push(otherScope);
448
+ }
449
+ }
450
+ }
451
+ }
452
+ return modifiedScopes;
453
+ }
454
+
455
+ // Many preferences allow `null` and even use it as a default regardless of the declared type.
456
+ protected getValue(): ValueType | null {
457
+ let currentValue = Preference.getValueInScope(this.inspection, this.scopeTracker.currentScope.scope);
458
+ if (currentValue === undefined) {
459
+ currentValue = this.inspection?.defaultValue;
460
+ }
461
+ return currentValue !== undefined ? currentValue : this.getFallbackValue();
462
+ }
463
+
464
+ protected setPreferenceWithDebounce = debounce(this.setPreferenceImmediately.bind(this), 500, { leading: false, trailing: true });
465
+
466
+ protected setPreferenceImmediately(value: ValueType | undefined): Promise<void> {
467
+ return this.preferenceService.set(this.id, value, this.scopeTracker.currentScope.scope, this.scopeTracker.currentScope.uri)
468
+ .catch(() => this.handleValueChange());
469
+ }
470
+
471
+ handleSearchChange(isFiltered = this.model.isFiltered): void {
472
+ this.updateHeadline(isFiltered);
473
+ }
474
+
475
+ handleScopeChange(isFiltered = this.model.isFiltered): void {
476
+ this.handleValueChange();
477
+ this.updateHeadline(isFiltered);
478
+ }
479
+
480
+ handleValueChange(): void {
481
+ this.doHandleValueChange();
482
+ this.updateHeadline();
483
+ }
484
+
485
+ /**
486
+ * Should create an HTML element that the user can interact with to change the value of the preference.
487
+ * @param container the parent element for the interactable. This method is responsible for adding the new element to its parent.
488
+ */
489
+ protected abstract createInteractable(container: HTMLElement): void;
490
+ /**
491
+ * @returns a fallback default value for a preference of the type implemented by a concrete leaf renderer
492
+ * This function is only called if the default value for a given preference is not specified in its schema.
493
+ */
494
+ protected abstract getFallbackValue(): ValueType;
495
+ /**
496
+ * This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.
497
+ */
498
+ protected abstract doHandleValueChange(): void;
499
+ }