@theia/preferences 1.34.2 → 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,31 +1,31 @@
1
- /// <reference types="lodash" />
2
- import { CompositeTreeNode, PreferenceSchemaProvider, PreferenceDataProperty } from '@theia/core/lib/browser';
3
- import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
4
- import { Emitter } from '@theia/core';
5
- import { Preference } from './preference-types';
6
- export declare const COMMONLY_USED_SECTION_PREFIX = "commonly-used";
7
- export declare class PreferenceTreeGenerator {
8
- protected readonly schemaProvider: PreferenceSchemaProvider;
9
- protected readonly preferenceConfigs: PreferenceConfigurations;
10
- protected _root: CompositeTreeNode;
11
- protected readonly onSchemaChangedEmitter: Emitter<CompositeTreeNode>;
12
- readonly onSchemaChanged: import("@theia/core").Event<CompositeTreeNode>;
13
- protected readonly commonlyUsedPreferences: string[];
14
- protected readonly topLevelCategories: Map<string, string>;
15
- protected readonly sectionAssignments: Map<string, string>;
16
- protected readonly defaultTopLevelCategory = "extensions";
17
- get root(): CompositeTreeNode;
18
- protected init(): Promise<void>;
19
- generateTree(): CompositeTreeNode;
20
- getNodeId(preferenceId: string): string;
21
- protected getGroupName(labels: string[]): string;
22
- protected getSubgroupName(labels: string[], computedGroupName: string): string | undefined;
23
- doHandleChangedSchema(): void;
24
- handleChangedSchema: import("lodash").DebouncedFunc<() => void>;
25
- protected createRootNode(): CompositeTreeNode;
26
- protected createLeafNode(property: string, preferencesGroup: Preference.CompositeTreeNode, data: PreferenceDataProperty): Preference.LeafNode;
27
- protected createPreferencesGroup(id: string, group: string, root: CompositeTreeNode): Preference.CompositeTreeNode;
28
- getCustomLabelFor(id: string): string | undefined;
29
- protected getOrCreatePreferencesGroup(id: string, group: string, root: CompositeTreeNode, groups: Map<string, Preference.CompositeTreeNode>): Preference.CompositeTreeNode;
30
- }
1
+ /// <reference types="lodash" />
2
+ import { CompositeTreeNode, PreferenceSchemaProvider, PreferenceDataProperty } from '@theia/core/lib/browser';
3
+ import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
4
+ import { Emitter } from '@theia/core';
5
+ import { Preference } from './preference-types';
6
+ export declare const COMMONLY_USED_SECTION_PREFIX = "commonly-used";
7
+ export declare class PreferenceTreeGenerator {
8
+ protected readonly schemaProvider: PreferenceSchemaProvider;
9
+ protected readonly preferenceConfigs: PreferenceConfigurations;
10
+ protected _root: CompositeTreeNode;
11
+ protected readonly onSchemaChangedEmitter: Emitter<CompositeTreeNode>;
12
+ readonly onSchemaChanged: import("@theia/core").Event<CompositeTreeNode>;
13
+ protected readonly commonlyUsedPreferences: string[];
14
+ protected readonly topLevelCategories: Map<string, string>;
15
+ protected readonly sectionAssignments: Map<string, string>;
16
+ protected readonly defaultTopLevelCategory = "extensions";
17
+ get root(): CompositeTreeNode;
18
+ protected init(): Promise<void>;
19
+ generateTree(): CompositeTreeNode;
20
+ getNodeId(preferenceId: string): string;
21
+ protected getGroupName(labels: string[]): string;
22
+ protected getSubgroupName(labels: string[], computedGroupName: string): string | undefined;
23
+ doHandleChangedSchema(): void;
24
+ handleChangedSchema: import("lodash").DebouncedFunc<() => void>;
25
+ protected createRootNode(): CompositeTreeNode;
26
+ protected createLeafNode(property: string, preferencesGroup: Preference.CompositeTreeNode, data: PreferenceDataProperty): Preference.LeafNode;
27
+ protected createPreferencesGroup(id: string, group: string, root: CompositeTreeNode): Preference.CompositeTreeNode;
28
+ getCustomLabelFor(id: string): string | undefined;
29
+ protected getOrCreatePreferencesGroup(id: string, group: string, root: CompositeTreeNode, groups: Map<string, Preference.CompositeTreeNode>): Preference.CompositeTreeNode;
30
+ }
31
31
  //# sourceMappingURL=preference-tree-generator.d.ts.map
@@ -1,235 +1,235 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2020 Ericsson and others.
4
- //
5
- // This program and the accompanying materials are made available under the
6
- // terms of the Eclipse Public License v. 2.0 which is available at
7
- // http://www.eclipse.org/legal/epl-2.0.
8
- //
9
- // This Source Code may also be made available under the following Secondary
10
- // Licenses when the conditions for such availability set forth in the Eclipse
11
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
- // with the GNU Classpath Exception which is available at
13
- // https://www.gnu.org/software/classpath/license.html.
14
- //
15
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
16
- // *****************************************************************************
17
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
- return c > 3 && r && Object.defineProperty(target, key, r), r;
22
- };
23
- var __metadata = (this && this.__metadata) || function (k, v) {
24
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
- };
26
- Object.defineProperty(exports, "__esModule", { value: true });
27
- exports.PreferenceTreeGenerator = exports.COMMONLY_USED_SECTION_PREFIX = void 0;
28
- const inversify_1 = require("@theia/core/shared/inversify");
29
- const browser_1 = require("@theia/core/lib/browser");
30
- const preference_configurations_1 = require("@theia/core/lib/browser/preferences/preference-configurations");
31
- const core_1 = require("@theia/core");
32
- const debounce = require("@theia/core/shared/lodash.debounce");
33
- const preference_types_1 = require("./preference-types");
34
- exports.COMMONLY_USED_SECTION_PREFIX = 'commonly-used';
35
- let PreferenceTreeGenerator = class PreferenceTreeGenerator {
36
- constructor() {
37
- this.onSchemaChangedEmitter = new core_1.Emitter();
38
- this.onSchemaChanged = this.onSchemaChangedEmitter.event;
39
- this.commonlyUsedPreferences = [
40
- 'files.autoSave', 'files.autoSaveDelay', 'editor.fontSize',
41
- 'editor.fontFamily', 'editor.tabSize', 'editor.renderWhitespace',
42
- 'editor.cursorStyle', 'editor.multiCursorModifier', 'editor.insertSpaces',
43
- 'editor.wordWrap', 'files.exclude', 'files.associations'
44
- ];
45
- this.topLevelCategories = new Map([
46
- [exports.COMMONLY_USED_SECTION_PREFIX, 'Commonly Used'],
47
- ['editor', 'Text Editor'],
48
- ['workbench', 'Workbench'],
49
- ['window', 'Window'],
50
- ['features', 'Features'],
51
- ['application', 'Application'],
52
- ['security', 'Security'],
53
- ['extensions', 'Extensions']
54
- ]);
55
- this.sectionAssignments = new Map([
56
- ['breadcrumbs', 'workbench'],
57
- ['comments', 'features'],
58
- ['debug', 'features'],
59
- ['diffEditor', 'editor'],
60
- ['explorer', 'features'],
61
- ['extensions', 'features'],
62
- ['files', 'editor'],
63
- ['hosted-plugin', 'features'],
64
- ['http', 'application'],
65
- ['keyboard', 'application'],
66
- ['notification', 'workbench'],
67
- ['output', 'features'],
68
- ['preview', 'features'],
69
- ['problems', 'features'],
70
- ['scm', 'features'],
71
- ['search', 'features'],
72
- ['task', 'features'],
73
- ['terminal', 'features'],
74
- ['toolbar', 'features'],
75
- ['webview', 'features'],
76
- ['workspace', 'application'],
77
- ]);
78
- this.defaultTopLevelCategory = 'extensions';
79
- this.handleChangedSchema = debounce(this.doHandleChangedSchema, 200);
80
- }
81
- get root() {
82
- var _a;
83
- return (_a = this._root) !== null && _a !== void 0 ? _a : this.generateTree();
84
- }
85
- async init() {
86
- await this.schemaProvider.ready;
87
- this.schemaProvider.onDidPreferenceSchemaChanged(() => this.handleChangedSchema());
88
- this.handleChangedSchema();
89
- }
90
- generateTree() {
91
- const preferencesSchema = this.schemaProvider.getCombinedSchema();
92
- const propertyNames = Object.keys(preferencesSchema.properties);
93
- const groups = new Map();
94
- const root = this.createRootNode();
95
- for (const id of this.topLevelCategories.keys()) {
96
- this.getOrCreatePreferencesGroup(id, id, root, groups);
97
- }
98
- const commonlyUsed = this.getOrCreatePreferencesGroup(exports.COMMONLY_USED_SECTION_PREFIX, exports.COMMONLY_USED_SECTION_PREFIX, root, groups);
99
- for (const preference of this.commonlyUsedPreferences) {
100
- if (preference in preferencesSchema.properties) {
101
- this.createLeafNode(preference, commonlyUsed, preferencesSchema.properties[preference]);
102
- }
103
- }
104
- for (const propertyName of propertyNames) {
105
- const property = preferencesSchema.properties[propertyName];
106
- if (!this.preferenceConfigs.isSectionName(propertyName) && !browser_1.OVERRIDE_PROPERTY_PATTERN.test(propertyName) && !property.deprecationMessage) {
107
- const labels = propertyName.split('.');
108
- const groupID = this.getGroupName(labels);
109
- const subgroupName = this.getSubgroupName(labels, groupID);
110
- const subgroupID = [groupID, subgroupName].join('.');
111
- const toplevelParent = this.getOrCreatePreferencesGroup(groupID, groupID, root, groups);
112
- const immediateParent = subgroupName && this.getOrCreatePreferencesGroup(subgroupID, groupID, toplevelParent, groups);
113
- this.createLeafNode(propertyName, immediateParent || toplevelParent, property);
114
- }
115
- }
116
- for (const group of groups.values()) {
117
- if (group.id !== `${exports.COMMONLY_USED_SECTION_PREFIX}@${exports.COMMONLY_USED_SECTION_PREFIX}`) {
118
- group.children.sort((a, b) => {
119
- const aIsComposite = browser_1.CompositeTreeNode.is(a);
120
- const bIsComposite = browser_1.CompositeTreeNode.is(b);
121
- if (aIsComposite && !bIsComposite) {
122
- return 1;
123
- }
124
- if (bIsComposite && !aIsComposite) {
125
- return -1;
126
- }
127
- return a.id.localeCompare(b.id);
128
- });
129
- }
130
- }
131
- this._root = root;
132
- return root;
133
- }
134
- ;
135
- getNodeId(preferenceId) {
136
- const expectedGroup = this.getGroupName(preferenceId.split('.'));
137
- const expectedId = `${expectedGroup}@${preferenceId}`;
138
- return expectedId;
139
- }
140
- getGroupName(labels) {
141
- const defaultGroup = labels[0];
142
- if (this.topLevelCategories.has(defaultGroup)) {
143
- return defaultGroup;
144
- }
145
- const assignedGroup = this.sectionAssignments.get(defaultGroup);
146
- if (assignedGroup) {
147
- return assignedGroup;
148
- }
149
- return this.defaultTopLevelCategory;
150
- }
151
- getSubgroupName(labels, computedGroupName) {
152
- if (computedGroupName !== labels[0]) {
153
- return labels[0];
154
- }
155
- else if (labels.length > 2) {
156
- return labels[1];
157
- }
158
- }
159
- doHandleChangedSchema() {
160
- const newTree = this.generateTree();
161
- this.onSchemaChangedEmitter.fire(newTree);
162
- }
163
- createRootNode() {
164
- return {
165
- id: 'root-node-id',
166
- name: '',
167
- parent: undefined,
168
- visible: true,
169
- children: []
170
- };
171
- }
172
- createLeafNode(property, preferencesGroup, data) {
173
- const { group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(preferencesGroup.id);
174
- const newNode = {
175
- id: `${group}@${property}`,
176
- preferenceId: property,
177
- parent: preferencesGroup,
178
- preference: { data },
179
- depth: preference_types_1.Preference.TreeNode.isTopLevel(preferencesGroup) ? 1 : 2,
180
- };
181
- browser_1.CompositeTreeNode.addChild(preferencesGroup, newNode);
182
- return newNode;
183
- }
184
- createPreferencesGroup(id, group, root) {
185
- const newNode = {
186
- id: `${group}@${id}`,
187
- visible: true,
188
- parent: root,
189
- children: [],
190
- expanded: false,
191
- selected: false,
192
- depth: 0,
193
- };
194
- const isTopLevel = preference_types_1.Preference.TreeNode.isTopLevel(newNode);
195
- if (!isTopLevel) {
196
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
197
- delete newNode.expanded;
198
- }
199
- newNode.depth = isTopLevel ? 0 : 1;
200
- browser_1.CompositeTreeNode.addChild(root, newNode);
201
- return newNode;
202
- }
203
- getCustomLabelFor(id) {
204
- return this.topLevelCategories.get(id);
205
- }
206
- getOrCreatePreferencesGroup(id, group, root, groups) {
207
- const existingGroup = groups.get(id);
208
- if (existingGroup) {
209
- return existingGroup;
210
- }
211
- const newNode = this.createPreferencesGroup(id, group, root);
212
- groups.set(id, newNode);
213
- return newNode;
214
- }
215
- ;
216
- };
217
- __decorate([
218
- (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
219
- __metadata("design:type", browser_1.PreferenceSchemaProvider)
220
- ], PreferenceTreeGenerator.prototype, "schemaProvider", void 0);
221
- __decorate([
222
- (0, inversify_1.inject)(preference_configurations_1.PreferenceConfigurations),
223
- __metadata("design:type", preference_configurations_1.PreferenceConfigurations)
224
- ], PreferenceTreeGenerator.prototype, "preferenceConfigs", void 0);
225
- __decorate([
226
- (0, inversify_1.postConstruct)(),
227
- __metadata("design:type", Function),
228
- __metadata("design:paramtypes", []),
229
- __metadata("design:returntype", Promise)
230
- ], PreferenceTreeGenerator.prototype, "init", null);
231
- PreferenceTreeGenerator = __decorate([
232
- (0, inversify_1.injectable)()
233
- ], PreferenceTreeGenerator);
234
- exports.PreferenceTreeGenerator = PreferenceTreeGenerator;
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2020 Ericsson and others.
4
+ //
5
+ // This program and the accompanying materials are made available under the
6
+ // terms of the Eclipse Public License v. 2.0 which is available at
7
+ // http://www.eclipse.org/legal/epl-2.0.
8
+ //
9
+ // This Source Code may also be made available under the following Secondary
10
+ // Licenses when the conditions for such availability set forth in the Eclipse
11
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
+ // with the GNU Classpath Exception which is available at
13
+ // https://www.gnu.org/software/classpath/license.html.
14
+ //
15
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
16
+ // *****************************************************************************
17
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
22
+ };
23
+ var __metadata = (this && this.__metadata) || function (k, v) {
24
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
+ };
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.PreferenceTreeGenerator = exports.COMMONLY_USED_SECTION_PREFIX = void 0;
28
+ const inversify_1 = require("@theia/core/shared/inversify");
29
+ const browser_1 = require("@theia/core/lib/browser");
30
+ const preference_configurations_1 = require("@theia/core/lib/browser/preferences/preference-configurations");
31
+ const core_1 = require("@theia/core");
32
+ const debounce = require("@theia/core/shared/lodash.debounce");
33
+ const preference_types_1 = require("./preference-types");
34
+ exports.COMMONLY_USED_SECTION_PREFIX = 'commonly-used';
35
+ let PreferenceTreeGenerator = class PreferenceTreeGenerator {
36
+ constructor() {
37
+ this.onSchemaChangedEmitter = new core_1.Emitter();
38
+ this.onSchemaChanged = this.onSchemaChangedEmitter.event;
39
+ this.commonlyUsedPreferences = [
40
+ 'files.autoSave', 'files.autoSaveDelay', 'editor.fontSize',
41
+ 'editor.fontFamily', 'editor.tabSize', 'editor.renderWhitespace',
42
+ 'editor.cursorStyle', 'editor.multiCursorModifier', 'editor.insertSpaces',
43
+ 'editor.wordWrap', 'files.exclude', 'files.associations'
44
+ ];
45
+ this.topLevelCategories = new Map([
46
+ [exports.COMMONLY_USED_SECTION_PREFIX, 'Commonly Used'],
47
+ ['editor', 'Text Editor'],
48
+ ['workbench', 'Workbench'],
49
+ ['window', 'Window'],
50
+ ['features', 'Features'],
51
+ ['application', 'Application'],
52
+ ['security', 'Security'],
53
+ ['extensions', 'Extensions']
54
+ ]);
55
+ this.sectionAssignments = new Map([
56
+ ['breadcrumbs', 'workbench'],
57
+ ['comments', 'features'],
58
+ ['debug', 'features'],
59
+ ['diffEditor', 'editor'],
60
+ ['explorer', 'features'],
61
+ ['extensions', 'features'],
62
+ ['files', 'editor'],
63
+ ['hosted-plugin', 'features'],
64
+ ['http', 'application'],
65
+ ['keyboard', 'application'],
66
+ ['notification', 'workbench'],
67
+ ['output', 'features'],
68
+ ['preview', 'features'],
69
+ ['problems', 'features'],
70
+ ['scm', 'features'],
71
+ ['search', 'features'],
72
+ ['task', 'features'],
73
+ ['terminal', 'features'],
74
+ ['toolbar', 'features'],
75
+ ['webview', 'features'],
76
+ ['workspace', 'application'],
77
+ ]);
78
+ this.defaultTopLevelCategory = 'extensions';
79
+ this.handleChangedSchema = debounce(this.doHandleChangedSchema, 200);
80
+ }
81
+ get root() {
82
+ var _a;
83
+ return (_a = this._root) !== null && _a !== void 0 ? _a : this.generateTree();
84
+ }
85
+ async init() {
86
+ await this.schemaProvider.ready;
87
+ this.schemaProvider.onDidPreferenceSchemaChanged(() => this.handleChangedSchema());
88
+ this.handleChangedSchema();
89
+ }
90
+ generateTree() {
91
+ const preferencesSchema = this.schemaProvider.getCombinedSchema();
92
+ const propertyNames = Object.keys(preferencesSchema.properties);
93
+ const groups = new Map();
94
+ const root = this.createRootNode();
95
+ for (const id of this.topLevelCategories.keys()) {
96
+ this.getOrCreatePreferencesGroup(id, id, root, groups);
97
+ }
98
+ const commonlyUsed = this.getOrCreatePreferencesGroup(exports.COMMONLY_USED_SECTION_PREFIX, exports.COMMONLY_USED_SECTION_PREFIX, root, groups);
99
+ for (const preference of this.commonlyUsedPreferences) {
100
+ if (preference in preferencesSchema.properties) {
101
+ this.createLeafNode(preference, commonlyUsed, preferencesSchema.properties[preference]);
102
+ }
103
+ }
104
+ for (const propertyName of propertyNames) {
105
+ const property = preferencesSchema.properties[propertyName];
106
+ if (!this.preferenceConfigs.isSectionName(propertyName) && !browser_1.OVERRIDE_PROPERTY_PATTERN.test(propertyName) && !property.deprecationMessage) {
107
+ const labels = propertyName.split('.');
108
+ const groupID = this.getGroupName(labels);
109
+ const subgroupName = this.getSubgroupName(labels, groupID);
110
+ const subgroupID = [groupID, subgroupName].join('.');
111
+ const toplevelParent = this.getOrCreatePreferencesGroup(groupID, groupID, root, groups);
112
+ const immediateParent = subgroupName && this.getOrCreatePreferencesGroup(subgroupID, groupID, toplevelParent, groups);
113
+ this.createLeafNode(propertyName, immediateParent || toplevelParent, property);
114
+ }
115
+ }
116
+ for (const group of groups.values()) {
117
+ if (group.id !== `${exports.COMMONLY_USED_SECTION_PREFIX}@${exports.COMMONLY_USED_SECTION_PREFIX}`) {
118
+ group.children.sort((a, b) => {
119
+ const aIsComposite = browser_1.CompositeTreeNode.is(a);
120
+ const bIsComposite = browser_1.CompositeTreeNode.is(b);
121
+ if (aIsComposite && !bIsComposite) {
122
+ return 1;
123
+ }
124
+ if (bIsComposite && !aIsComposite) {
125
+ return -1;
126
+ }
127
+ return a.id.localeCompare(b.id);
128
+ });
129
+ }
130
+ }
131
+ this._root = root;
132
+ return root;
133
+ }
134
+ ;
135
+ getNodeId(preferenceId) {
136
+ const expectedGroup = this.getGroupName(preferenceId.split('.'));
137
+ const expectedId = `${expectedGroup}@${preferenceId}`;
138
+ return expectedId;
139
+ }
140
+ getGroupName(labels) {
141
+ const defaultGroup = labels[0];
142
+ if (this.topLevelCategories.has(defaultGroup)) {
143
+ return defaultGroup;
144
+ }
145
+ const assignedGroup = this.sectionAssignments.get(defaultGroup);
146
+ if (assignedGroup) {
147
+ return assignedGroup;
148
+ }
149
+ return this.defaultTopLevelCategory;
150
+ }
151
+ getSubgroupName(labels, computedGroupName) {
152
+ if (computedGroupName !== labels[0]) {
153
+ return labels[0];
154
+ }
155
+ else if (labels.length > 2) {
156
+ return labels[1];
157
+ }
158
+ }
159
+ doHandleChangedSchema() {
160
+ const newTree = this.generateTree();
161
+ this.onSchemaChangedEmitter.fire(newTree);
162
+ }
163
+ createRootNode() {
164
+ return {
165
+ id: 'root-node-id',
166
+ name: '',
167
+ parent: undefined,
168
+ visible: true,
169
+ children: []
170
+ };
171
+ }
172
+ createLeafNode(property, preferencesGroup, data) {
173
+ const { group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(preferencesGroup.id);
174
+ const newNode = {
175
+ id: `${group}@${property}`,
176
+ preferenceId: property,
177
+ parent: preferencesGroup,
178
+ preference: { data },
179
+ depth: preference_types_1.Preference.TreeNode.isTopLevel(preferencesGroup) ? 1 : 2,
180
+ };
181
+ browser_1.CompositeTreeNode.addChild(preferencesGroup, newNode);
182
+ return newNode;
183
+ }
184
+ createPreferencesGroup(id, group, root) {
185
+ const newNode = {
186
+ id: `${group}@${id}`,
187
+ visible: true,
188
+ parent: root,
189
+ children: [],
190
+ expanded: false,
191
+ selected: false,
192
+ depth: 0,
193
+ };
194
+ const isTopLevel = preference_types_1.Preference.TreeNode.isTopLevel(newNode);
195
+ if (!isTopLevel) {
196
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
197
+ delete newNode.expanded;
198
+ }
199
+ newNode.depth = isTopLevel ? 0 : 1;
200
+ browser_1.CompositeTreeNode.addChild(root, newNode);
201
+ return newNode;
202
+ }
203
+ getCustomLabelFor(id) {
204
+ return this.topLevelCategories.get(id);
205
+ }
206
+ getOrCreatePreferencesGroup(id, group, root, groups) {
207
+ const existingGroup = groups.get(id);
208
+ if (existingGroup) {
209
+ return existingGroup;
210
+ }
211
+ const newNode = this.createPreferencesGroup(id, group, root);
212
+ groups.set(id, newNode);
213
+ return newNode;
214
+ }
215
+ ;
216
+ };
217
+ __decorate([
218
+ (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
219
+ __metadata("design:type", browser_1.PreferenceSchemaProvider)
220
+ ], PreferenceTreeGenerator.prototype, "schemaProvider", void 0);
221
+ __decorate([
222
+ (0, inversify_1.inject)(preference_configurations_1.PreferenceConfigurations),
223
+ __metadata("design:type", preference_configurations_1.PreferenceConfigurations)
224
+ ], PreferenceTreeGenerator.prototype, "preferenceConfigs", void 0);
225
+ __decorate([
226
+ (0, inversify_1.postConstruct)(),
227
+ __metadata("design:type", Function),
228
+ __metadata("design:paramtypes", []),
229
+ __metadata("design:returntype", Promise)
230
+ ], PreferenceTreeGenerator.prototype, "init", null);
231
+ PreferenceTreeGenerator = __decorate([
232
+ (0, inversify_1.injectable)()
233
+ ], PreferenceTreeGenerator);
234
+ exports.PreferenceTreeGenerator = PreferenceTreeGenerator;
235
235
  //# sourceMappingURL=preference-tree-generator.js.map
@@ -1,12 +1,12 @@
1
- import { LabelProviderContribution } from '@theia/core/lib/browser';
2
- import { Preference } from './preference-types';
3
- import { PreferenceTreeGenerator } from './preference-tree-generator';
4
- export declare class PreferenceTreeLabelProvider implements LabelProviderContribution {
5
- protected readonly treeGenerator: PreferenceTreeGenerator;
6
- canHandle(element: object): number;
7
- getName(node: Preference.TreeNode): string;
8
- getPrefix(node: Preference.TreeNode, fullPath?: boolean): string | undefined;
9
- protected formatString(string: string): string;
10
- protected isUpperCase(char: string): boolean;
11
- }
1
+ import { LabelProviderContribution } from '@theia/core/lib/browser';
2
+ import { Preference } from './preference-types';
3
+ import { PreferenceTreeGenerator } from './preference-tree-generator';
4
+ export declare class PreferenceTreeLabelProvider implements LabelProviderContribution {
5
+ protected readonly treeGenerator: PreferenceTreeGenerator;
6
+ canHandle(element: object): number;
7
+ getName(node: Preference.TreeNode): string;
8
+ getPrefix(node: Preference.TreeNode, fullPath?: boolean): string | undefined;
9
+ protected formatString(string: string): string;
10
+ protected isUpperCase(char: string): boolean;
11
+ }
12
12
  //# sourceMappingURL=preference-tree-label-provider.d.ts.map