-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
/
pluginlist.tsx
548 lines (498 loc) · 15.8 KB
/
pluginlist.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
/* -----------------------------------------------------------------------------
| Copyright (c) Jupyter Development Team.
| Distributed under the terms of the Modified BSD License.
|----------------------------------------------------------------------------*/
import React from 'react';
import { ReactWidget } from '@jupyterlab/apputils';
import { ISettingRegistry, Settings } from '@jupyterlab/settingregistry';
import { ITranslator, nullTranslator } from '@jupyterlab/translation';
import {
classes,
FilterBox,
IScore,
LabIcon,
settingsIcon,
updateFilterFunction
} from '@jupyterlab/ui-components';
import { StringExt } from '@lumino/algorithm';
import { PartialJSONObject } from '@lumino/coreutils';
import { Message } from '@lumino/messaging';
import { ISignal, Signal } from '@lumino/signaling';
import type { SettingsEditor } from './settingseditor';
/**
* The JupyterLab plugin schema key for the setting editor
* icon class of a plugin.
*/
const ICON_KEY = 'jupyter.lab.setting-icon';
/**
* The JupyterLab plugin schema key for the setting editor
* icon class of a plugin.
*/
const ICON_CLASS_KEY = 'jupyter.lab.setting-icon-class';
/**
* The JupyterLab plugin schema key for the setting editor
* icon label of a plugin.
*/
const ICON_LABEL_KEY = 'jupyter.lab.setting-icon-label';
/**
* A list of plugins with editable settings.
*/
export class PluginList extends ReactWidget {
/**
* Create a new plugin list.
*/
constructor(options: PluginList.IOptions) {
super();
this.registry = options.registry;
this.translator = options.translator || nullTranslator;
this.addClass('jp-PluginList');
this._confirm = options.confirm;
this.registry.pluginChanged.connect(() => {
this.update();
}, this);
this.mapPlugins = this.mapPlugins.bind(this);
this.setFilter = this.setFilter.bind(this);
this.setFilter(
options.query ? updateFilterFunction(options.query, false, false) : null
);
this.setError = this.setError.bind(this);
this._evtMousedown = this._evtMousedown.bind(this);
this._query = options.query ?? '';
this._allPlugins = PluginList.sortPlugins(this.registry).filter(plugin => {
const { schema } = plugin;
const deprecated = schema['jupyter.lab.setting-deprecated'] === true;
const editable = Object.keys(schema.properties || {}).length > 0;
const extensible = schema.additionalProperties !== false;
// Filters out a couple of plugins that take too long to load in the new settings editor.
const correctEditor =
// If this is the json settings editor, anything is fine
this._confirm ||
// If this is the new settings editor, remove context menu / main menu settings.
(!this._confirm && !(options.toSkip ?? []).includes(plugin.id));
return !deprecated && correctEditor && (editable || extensible);
});
/**
* Loads all settings and stores them for easy access when displaying search results.
*/
const loadSettings = async () => {
for (const plugin of this._allPlugins) {
const pluginSettings = (await this.registry.load(
plugin.id
)) as Settings;
this._settings[plugin.id] = pluginSettings;
}
this.update();
};
void loadSettings();
this._errors = {};
}
/**
* The setting registry.
*/
readonly registry: ISettingRegistry;
/**
* A signal emitted when a list user interaction happens.
*/
get changed(): ISignal<this, void> {
return this._changed;
}
/**
* The selection value of the plugin list.
*/
get scrollTop(): number | undefined {
return this.node.querySelector('ul')?.scrollTop;
}
get hasErrors(): boolean {
for (const id in this._errors) {
if (this._errors[id]) {
return true;
}
}
return false;
}
get filter(): SettingsEditor.PluginSearchFilter {
return this._filter;
}
/**
* The selection value of the plugin list.
*/
get selection(): string {
return this._selection;
}
set selection(selection: string) {
this._selection = selection;
this.update();
}
/**
* Signal that fires when search filter is updated so that settings panel can filter results.
*/
get updateFilterSignal(): ISignal<this, SettingsEditor.PluginSearchFilter> {
return this._updateFilterSignal;
}
get handleSelectSignal(): ISignal<this, string> {
return this._handleSelectSignal;
}
/**
* Handle `'update-request'` messages.
*/
protected onUpdateRequest(msg: Message): void {
const ul = this.node.querySelector('ul');
if (ul && this._scrollTop !== undefined) {
ul.scrollTop = this._scrollTop;
}
super.onUpdateRequest(msg);
}
/**
* Handle the `'mousedown'` event for the plugin list.
*
* @param event - The DOM event sent to the widget
*/
private _evtMousedown(event: React.MouseEvent<HTMLDivElement>): void {
const target = event.currentTarget;
const id = target.getAttribute('data-id');
if (!id) {
return;
}
if (this._confirm) {
this._confirm(id)
.then(() => {
this.selection = id!;
this._changed.emit(undefined);
this.update();
})
.catch(() => {
/* no op */
});
} else {
this._scrollTop = this.scrollTop;
this._selection = id!;
this._handleSelectSignal.emit(id!);
this._changed.emit(undefined);
this.update();
}
}
/**
* Check the plugin for a rendering hint's value.
*
* #### Notes
* The order of priority for overridden hints is as follows, from most
* important to least:
* 1. Data set by the end user in a settings file.
* 2. Data set by the plugin author as a schema default.
* 3. Data set by the plugin author as a top-level key of the schema.
*/
getHint(
key: string,
registry: ISettingRegistry,
plugin: ISettingRegistry.IPlugin
): string {
// First, give priority to checking if the hint exists in the user data.
let hint = plugin.data.user[key];
// Second, check to see if the hint exists in composite data, which folds
// in default values from the schema.
if (!hint) {
hint = plugin.data.composite[key];
}
// Third, check to see if the plugin schema has defined the hint.
if (!hint) {
hint = plugin.schema[key];
}
// Finally, use the defaults from the registry schema.
if (!hint) {
const { properties } = registry.schema;
hint = properties && properties[key] && properties[key].default;
}
return typeof hint === 'string' ? hint : '';
}
/**
* Function to recursively filter properties that match search results.
* @param filter - Function to filter based on search results
* @param props - Schema properties being filtered
* @param definitions - Definitions to use for filling in references in properties
* @param ref - Reference to a definition
* @returns - String array of properties that match the search results.
*/
getFilterString(
filter: (item: string) => Partial<IScore> | null,
props: ISettingRegistry.IProperty,
definitions?: any,
ref?: string
): string[] {
// If properties given are references, populate properties
// with corresponding definition.
if (ref && definitions) {
ref = ref.replace('#/definitions/', '');
props = definitions[ref] ?? {};
}
// If given properties are an object, advance into the properties
// for that object instead.
if (props.properties) {
props = props.properties;
// If given properties are an array, advance into the properties
// for the items instead.
} else if (props.items) {
props = props.items as any;
// Otherwise, you've reached the base case and don't need to check for matching properties
} else {
return [];
}
// If reference found, recurse
if (props['$ref']) {
return this.getFilterString(
filter,
props,
definitions,
props['$ref'] as string
);
}
// Make sure props is non-empty before calling reduce
if (Object.keys(props).length === 0) {
return [];
}
// Iterate through the properties and check for titles / descriptions that match search.
return Object.keys(props).reduce((acc: string[], value: any) => {
// If this is the base case, check for matching title / description
const subProps = props[value] as PartialJSONObject;
if (!subProps) {
if (filter((props.title as string) ?? '')) {
return props.title;
}
if (filter(value)) {
return value;
}
}
// If there are properties in the object, check for title / description
if (filter((subProps.title as string) ?? '')) {
acc.push(subProps.title as string);
}
if (filter(value)) {
acc.push(value);
}
// Finally, recurse on the properties left.
acc.concat(
this.getFilterString(
filter,
subProps as ISettingRegistry.IProperty,
definitions,
subProps['$ref'] as string
)
);
return acc;
}, []);
}
/**
* Updates the filter when the search bar value changes.
* @param filter Filter function passed by search bar based on search value.
*/
setFilter(
filter: ((item: string) => Partial<IScore> | null) | null,
query?: string
): void {
if (filter) {
this._filter = (plugin: ISettingRegistry.IPlugin): string[] | null => {
if (!filter || filter(plugin.schema.title ?? '')) {
return null;
}
const filtered = this.getFilterString(
filter,
plugin.schema ?? {},
plugin.schema.definitions
);
return filtered;
};
} else {
this._filter = null;
}
this._query = query;
this._updateFilterSignal.emit(this._filter);
this.update();
}
setError(id: string, error: boolean): void {
if (this._errors[id] !== error) {
this._errors[id] = error;
this.update();
} else {
this._errors[id] = error;
}
}
mapPlugins(plugin: ISettingRegistry.IPlugin): JSX.Element {
const { id, schema, version } = plugin;
const trans = this.translator.load('jupyterlab');
const title =
typeof schema.title === 'string' ? trans._p('schema', schema.title) : id;
const highlightedTitleIndices = StringExt.matchSumOfSquares(
title.toLocaleLowerCase(),
this._query?.toLocaleLowerCase() ?? ''
);
const hightlightedTitle = StringExt.highlight(
title,
highlightedTitleIndices?.indices ?? [],
chunk => {
return <mark>{chunk}</mark>;
}
);
const description =
typeof schema.description === 'string'
? trans._p('schema', schema.description)
: '';
const itemTitle = `${description}\n${id}\n${version}`;
const icon = this.getHint(ICON_KEY, this.registry, plugin);
const iconClass = this.getHint(ICON_CLASS_KEY, this.registry, plugin);
const iconTitle = this.getHint(ICON_LABEL_KEY, this.registry, plugin);
const filteredProperties = this._filter
? this._filter(plugin)?.map(fieldValue => {
const highlightedIndices = StringExt.matchSumOfSquares(
fieldValue.toLocaleLowerCase(),
this._query?.toLocaleLowerCase() ?? ''
);
const highlighted = StringExt.highlight(
fieldValue,
highlightedIndices?.indices ?? [],
chunk => {
return <mark>{chunk}</mark>;
}
);
return <li key={`${id}-${fieldValue}`}> {highlighted} </li>;
})
: undefined;
return (
<div
onClick={this._evtMousedown}
className={`${
id === this.selection
? 'jp-mod-selected jp-PluginList-entry'
: 'jp-PluginList-entry'
} ${this._errors[id] ? 'jp-ErrorPlugin' : ''}`}
data-id={id}
key={id}
title={itemTitle}
>
<div className="jp-PluginList-entry-label" role="tab">
<div className="jp-SelectedIndicator" />
<LabIcon.resolveReact
icon={icon || (iconClass ? undefined : settingsIcon)}
iconClass={classes(iconClass, 'jp-Icon')}
title={iconTitle}
tag="span"
stylesheet="settingsEditor"
/>
<span className="jp-PluginList-entry-label-text">
{hightlightedTitle}
</span>
</div>
<ul>{filteredProperties}</ul>
</div>
);
}
render(): JSX.Element {
const trans = this.translator.load('jupyterlab');
// Filter all plugins based on search value before displaying list.
const allPlugins = this._allPlugins.filter(plugin => {
if (!this._filter) {
return false;
}
const filtered = this._filter(plugin);
return filtered === null || filtered.length > 0;
});
const modifiedPlugins = allPlugins.filter(plugin => {
return this._settings[plugin.id]?.isModified;
});
const modifiedItems = modifiedPlugins.map(this.mapPlugins);
const otherItems = allPlugins
.filter(plugin => {
return !modifiedPlugins.includes(plugin);
})
.map(this.mapPlugins);
return (
<div className="jp-PluginList-wrapper">
<FilterBox
updateFilter={this.setFilter}
useFuzzyFilter={false}
placeholder={trans.__('Search settings…')}
forceRefresh={false}
caseSensitive={false}
initialQuery={this._query}
/>
{modifiedItems.length > 0 && (
<div>
<h1 className="jp-PluginList-header">{trans.__('Modified')}</h1>
<ul>{modifiedItems}</ul>
</div>
)}
{otherItems.length > 0 && (
<div>
<h1 className="jp-PluginList-header">{trans.__('Settings')}</h1>
<ul>{otherItems}</ul>
</div>
)}
{modifiedItems.length === 0 && otherItems.length === 0 && (
<p className="jp-PluginList-noResults">
{trans.__('No items match your search.')}
</p>
)}
</div>
);
}
protected translator: ITranslator;
private _changed = new Signal<this, void>(this);
private _errors: { [id: string]: boolean };
private _filter: SettingsEditor.PluginSearchFilter;
private _query: string | undefined;
private _handleSelectSignal = new Signal<this, string>(this);
private _updateFilterSignal = new Signal<
this,
SettingsEditor.PluginSearchFilter
>(this);
private _allPlugins: ISettingRegistry.IPlugin[] = [];
private _settings: { [id: string]: Settings } = {};
private _confirm?: (id: string) => Promise<void>;
private _scrollTop: number | undefined = 0;
private _selection = '';
}
/**
* A namespace for `PluginList` statics.
*/
export namespace PluginList {
/**
* The instantiation options for a plugin list.
*/
export interface IOptions {
/**
* A function that allows for asynchronously confirming a selection.
*
* #### Notes
* If the promise returned by the function resolves, then the selection will
* succeed and emit an event. If the promise rejects, the selection is not
* made.
*/
confirm?: (id: string) => Promise<void>;
/**
* The setting registry for the plugin list.
*/
registry: ISettingRegistry;
/**
* List of plugins to skip
*/
toSkip?: string[];
/**
* The setting registry for the plugin list.
*/
translator?: ITranslator;
/**
* An optional initial query so the plugin list can filter on start.
*/
query?: string;
}
/**
* Sort a list of plugins by title and ID.
*/
export function sortPlugins(
registry: ISettingRegistry
): ISettingRegistry.IPlugin[] {
return Object.keys(registry.plugins)
.map(plugin => registry.plugins[plugin]!)
.sort((a, b) => {
return (a.schema.title || a.id).localeCompare(b.schema.title || b.id);
});
}
}