/
settingregistry.ts
1077 lines (905 loc) · 26.6 KB
/
settingregistry.ts
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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import * as Ajv from 'ajv';
import * as json from 'comment-json';
import {
find
} from '@phosphor/algorithm';
import {
JSONExt, JSONObject, JSONValue, ReadonlyJSONObject, Token
} from '@phosphor/coreutils';
import {
IDisposable
} from '@phosphor/disposable';
import {
ISignal, Signal
} from '@phosphor/signaling';
import {
IDataConnector
} from './interfaces';
/**
* The key in the schema for setting editor icon class hints.
*/
export
const ICON_CLASS_KEY ='jupyter.lab.setting-icon-class';
/**
* The key in the schema for setting editor icon label hints.
*/
export
const ICON_LABEL_KEY = 'jupyter.lab.setting-icon-label';
/**
* An alias for the JSON deep copy function.
*/
const copy = JSONExt.deepCopy;
/**
* An implementation of a schema validator.
*/
export
interface ISchemaValidator {
/**
* Validate a plugin's schema and user data; populate the `composite` data.
*
* @param plugin - The plugin being validated. Its `composite` data will be
* populated by reference.
*
* @param populate - Whether plugin data should be populated, defaults to
* `true`.
*
* @return A list of errors if either the schema or data fail to validate or
* `null` if there are no errors.
*/
validateData(plugin: ISettingRegistry.IPlugin, populate?: boolean): ISchemaValidator.IError[] | null;
}
/**
* A namespace for schema validator interfaces.
*/
export
namespace ISchemaValidator {
/**
* A schema validation error definition.
*/
export
interface IError {
/**
* The path in the data where the error occurred.
*/
dataPath: string;
/**
* The keyword whose validation failed.
*/
keyword: string;
/**
* The error message.
*/
message: string;
/**
* Optional parameter metadata that might be included in an error.
*/
params?: ReadonlyJSONObject;
/**
* The path in the schema where the error occurred.
*/
schemaPath: string;
}
}
/* tslint:disable */
/**
* The setting registry token.
*/
export
const ISettingRegistry = new Token<ISettingRegistry>('@jupyterlab/coreutils:ISettingRegistry');
/* tslint:enable */
/**
* A namespace for setting registry interfaces.
*/
export
namespace ISettingRegistry {
/**
* The settings for a specific plugin.
*/
export
interface IPlugin extends JSONObject {
/**
* The name of the plugin.
*/
id: string;
/**
* The collection of values for a specified setting.
*/
data: ISettingBundle;
/**
* The raw user settings data as a string containing JSON with comments.
*/
raw: string;
/**
* The JSON schema for the plugin.
*/
schema: ISchema;
}
/**
* A schema type that is a minimal subset of the formal JSON Schema along with
* optional JupyterLab rendering hints.
*/
export
interface ISchema extends JSONObject {
/**
* The JupyterLab icon class hint for a plugin can be overridden by user
* settings. It can also be root level and therefore "private".
*/
'jupyter.lab.setting-icon-class'?: string;
/**
* The JupyterLab icon label hint for a plugin can be overridden by user
* settings. It can also be root level and therefore "private".
*/
'jupyter.lab.setting-icon-label'?: string;
/**
* The default value, if any.
*/
default?: any;
/**
* The schema description.
*/
description?: string;
/**
* The schema's child properties.
*/
properties?: {
/**
* The JupyterLab icon class hint for a plugin can be overridden by user
* settings. It can also be root level and therefore "private".
*/
'jupyter.lab.setting-icon-class'?: ISchema;
/**
* The JupyterLab icon label hint for a plugin can be overridden by user
* settings. It can also be root level and therefore "private".
*/
'jupyter.lab.setting-icon-label'?: ISchema;
/**
* Arbitrary setting keys can be added.
*/
[key: string]: ISchema;
};
/**
* The title of the schema.
*/
title?: string;
/**
* The type or types of the data.
*/
type?: string | string[];
}
/**
* The setting values for a plugin.
*/
export
interface ISettingBundle extends JSONObject {
/**
* A composite of the user setting values and the plugin schema defaults.
*
* #### Notes
* The `composite` values will always be a superset of the `user` values.
*/
composite: JSONObject;
/**
* The user setting values.
*/
user: JSONObject;
}
/**
* An interface for manipulating the settings of a specific plugin.
*/
export
interface ISettings extends IDisposable {
/**
* A signal that emits when the plugin's settings have changed.
*/
readonly changed: ISignal<this, void>;
/**
* Get the composite of user settings and extension defaults.
*/
readonly composite: JSONObject;
/*
* The plugin name.
*/
readonly plugin: string;
/**
* The plugin settings raw text value.
*/
readonly raw: string;
/**
* Get the plugin settings schema.
*/
readonly schema: ISettingRegistry.ISchema;
/**
* Get the user settings.
*/
readonly user: JSONObject;
/**
* Return the defaults in a commented JSON format.
*/
annotatedDefaults(): string;
/**
* Calculate the default value of a setting by iterating through the schema.
*
* @param key - The name of the setting whose default value is calculated.
*
* @returns A calculated default JSON value for a specific setting.
*/
default(key: string): JSONValue | undefined;
/**
* Get an individual setting.
*
* @param key - The name of the setting being retrieved.
*
* @returns The setting value.
*/
get(key: string): { composite: JSONValue, user: JSONValue };
/**
* Remove a single setting.
*
* @param key - The name of the setting being removed.
*
* @returns A promise that resolves when the setting is removed.
*
* #### Notes
* This function is asynchronous because it writes to the setting registry.
*/
remove(key: string): Promise<void>;
/**
* Save all of the plugin's user settings at once.
*/
save(raw: string): Promise<void>;
/**
* Set a single setting.
*
* @param key - The name of the setting being set.
*
* @param value - The value of the setting.
*
* @returns A promise that resolves when the setting has been saved.
*
* #### Notes
* This function is asynchronous because it writes to the setting registry.
*/
set(key: string, value: JSONValue): Promise<void>;
/**
* Validates raw settings with comments.
*
* @param raw - The JSON with comments string being validated.
*
* @returns A list of errors or `null` if valid.
*/
validate(raw: string): ISchemaValidator.IError[] | null;
}
}
/**
* An implementation of a setting registry.
*/
export
interface ISettingRegistry extends SettingRegistry {}
/**
* The default implementation of a schema validator.
*/
export
class DefaultSchemaValidator implements ISchemaValidator {
/**
* Instantiate a schema validator.
*/
constructor() {
this._composer.addSchema(Private.SCHEMA, 'main');
this._validator.addSchema(Private.SCHEMA, 'main');
}
/**
* Validate a plugin's schema and user data; populate the `composite` data.
*
* @param plugin - The plugin being validated. Its `composite` data will be
* populated by reference.
*
* @param populate - Whether plugin data should be populated, defaults to
* `true`.
*
* @return A list of errors if either the schema or data fail to validate or
* `null` if there are no errors.
*/
validateData(plugin: ISettingRegistry.IPlugin, populate = true): ISchemaValidator.IError[] | null {
const validate = this._validator.getSchema(plugin.id);
const compose = this._composer.getSchema(plugin.id);
// If the schemas do not exist, add them to the validator and continue.
if (!validate || !compose) {
const errors = this._addSchema(plugin.id, plugin.schema);
if (errors) {
return errors;
}
return this.validateData(plugin);
}
// Parse the raw commented JSON into a user map.
let user: JSONObject;
try {
const strip = true;
user = json.parse(plugin.raw, null, strip) as JSONObject;
} catch (error) {
if (error instanceof SyntaxError) {
return [{
dataPath: '', keyword: 'syntax', schemaPath: '',
message: error.message
}];
}
const { column, description } = error;
const line = error.lineNumber;
return [{
dataPath: '', keyword: 'parse', schemaPath: '',
message: `${description} (line ${line} column ${column})`
}];
}
if (!validate(user)) {
return validate.errors as ISchemaValidator.IError[];
}
// Copy the user data before merging defaults into composite map.
const composite = copy(user);
if (!compose(composite)) {
return compose.errors as ISchemaValidator.IError[];
}
if (populate) {
plugin.data = { composite, user };
}
return null;
}
/**
* Add a schema to the validator.
*
* @param plugin - The plugin ID.
*
* @param schema - The schema being added.
*
* @return A list of errors if the schema fails to validate or `null` if there
* are no errors.
*
* #### Notes
* It is safe to call this function multiple times with the same plugin name.
*/
private _addSchema(plugin: string, schema: ISettingRegistry.ISchema): ISchemaValidator.IError[] | null {
const composer = this._composer;
const validator = this._validator;
const validate = validator.getSchema('main');
// Validate against the main schema.
if (!(validate(schema) as boolean)) {
return validate.errors as ISchemaValidator.IError[];
}
// Validate against the JSON schema meta-schema.
if (!(validator.validateSchema(schema) as boolean)) {
return validator.errors as ISchemaValidator.IError[];
}
// Remove if schema already exists.
composer.removeSchema(plugin);
validator.removeSchema(plugin);
// Add schema to the validator and composer.
composer.addSchema(schema, plugin);
validator.addSchema(schema, plugin);
return null;
}
private _composer = new Ajv({ useDefaults: true });
private _validator = new Ajv();
}
/**
* The default concrete implementation of a setting registry.
*/
export
class SettingRegistry {
/**
* Create a new setting registry.
*/
constructor(options: SettingRegistry.IOptions) {
this._connector = options.connector;
this.validator = options.validator || new DefaultSchemaValidator();
}
/**
* The schema of the setting registry.
*/
readonly schema = Private.SCHEMA;
/**
* The schema validator used by the setting registry.
*/
readonly validator: ISchemaValidator;
/**
* A signal that emits the name of a plugin when its settings change.
*/
get pluginChanged(): ISignal<this, string> {
return this._pluginChanged;
}
/**
* Returns a list of plugin settings held in the registry.
*/
get plugins(): ISettingRegistry.IPlugin[] {
const plugins = this._plugins;
return Object.keys(plugins)
.map(p => copy(plugins[p]) as ISettingRegistry.IPlugin);
}
/**
* Get an individual setting.
*
* @param plugin - The name of the plugin whose settings are being retrieved.
*
* @param key - The name of the setting being retrieved.
*
* @returns A promise that resolves when the setting is retrieved.
*/
get(plugin: string, key: string): Promise<{ composite: JSONValue, user: JSONValue }> {
const plugins = this._plugins;
if (plugin in plugins) {
const { composite, user } = plugins[plugin].data;
const result = {
composite: key in composite ? copy(composite[key]) : undefined,
user: key in user ? copy(user[key]) : undefined
};
return Promise.resolve(result);
}
return this.load(plugin).then(() => this.get(plugin, key));
}
/**
* Load a plugin's settings into the setting registry.
*
* @param plugin - The name of the plugin whose settings are being loaded.
*
* @returns A promise that resolves with a plugin settings object or rejects
* if the plugin is not found.
*/
load(plugin: string): Promise<ISettingRegistry.ISettings> {
const plugins = this._plugins;
const registry = this;
// If the plugin exists, resolve.
if (plugin in plugins) {
const settings = new Settings({ plugin: plugins[plugin], registry });
return Promise.resolve(settings);
}
// If the plugin needs to be loaded from the data connector, fetch.
return this.reload(plugin);
}
/**
* Reload a plugin's settings into the registry even if they already exist.
*
* @param plugin - The name of the plugin whose settings are being reloaded.
*
* @returns A promise that resolves with a plugin settings object or rejects
* with a list of `ISchemaValidator.IError` objects if it fails.
*/
reload(plugin: string): Promise<ISettingRegistry.ISettings> {
const connector = this._connector;
const plugins = this._plugins;
const registry = this;
// If the plugin needs to be loaded from the connector, fetch.
return connector.fetch(plugin).then(data => {
// Validate the response from the connector; populate `composite` field.
try {
this._validate(data);
} catch (errors) {
const output = [`Validating ${plugin} failed:`];
(errors as ISchemaValidator.IError[]).forEach((error, index) => {
const { dataPath, schemaPath, keyword, message } = error;
output.push(`${index} - schema @ ${schemaPath}, data @ ${dataPath}`);
output.push(`\t${keyword} ${message}`);
});
console.error(output.join('\n'));
throw new Error(`Failed validating ${plugin}`);
}
// Emit that a plugin has changed.
this._pluginChanged.emit(plugin);
return new Settings({ plugin: plugins[plugin], registry });
});
}
/**
* Remove a single setting in the registry.
*
* @param plugin - The name of the plugin whose setting is being removed.
*
* @param key - The name of the setting being removed.
*
* @returns A promise that resolves when the setting is removed.
*/
remove(plugin: string, key: string): Promise<void> {
const plugins = this._plugins;
if (!(plugin in plugins)) {
return Promise.resolve(undefined);
}
const raw = json.parse(plugins[plugin].raw);
// Delete both the value and any associated comment.
delete raw[key];
delete raw[`// ${key}`];
plugins[plugin].raw = json.stringify(raw);
return this._save(plugin);
}
/**
* Set a single setting in the registry.
*
* @param plugin - The name of the plugin whose setting is being set.
*
* @param key - The name of the setting being set.
*
* @param value - The value of the setting being set.
*
* @returns A promise that resolves when the setting has been saved.
*
*/
set(plugin: string, key: string, value: JSONValue): Promise<void> {
const plugins = this._plugins;
if (!(plugin in plugins)) {
return this.load(plugin).then(() => this.set(plugin, key, value));
}
const raw = json.parse(plugins[plugin].raw);
plugins[plugin].raw = json.stringify({ ...raw, [key]: value });
return this._save(plugin);
}
/**
* Upload a plugin's settings.
*
* @param plugin - The name of the plugin whose settings are being set.
*
* @param raw - The raw plugin settings being uploaded.
*
* @returns A promise that resolves when the settings have been saved.
*/
upload(plugin: string, raw: string): Promise<void> {
const plugins = this._plugins;
if (!(plugin in plugins)) {
return this.load(plugin).then(() => this.upload(plugin, raw));
}
// Set the local copy.
plugins[plugin].raw = raw;
return this._save(plugin);
}
/**
* Save a plugin in the registry.
*/
private _save(plugin: string): Promise<void> {
const plugins = this._plugins;
if (!(plugin in plugins)) {
const message = `${plugin} does not exist in setting registry.`;
return Promise.reject(new Error(message));
}
try {
this._validate(plugins[plugin]);
} catch (errors) {
const message = `${plugin} failed to validate; check console for errors.`;
console.warn(`${plugin} validation errors:`, errors);
return Promise.reject(new Error(message));
}
return this._connector.save(plugin, plugins[plugin].raw)
.then(() => { this._pluginChanged.emit(plugin); });
}
/**
* Validate a plugin's data and schema, compose the `composite` data.
*/
private _validate(plugin: ISettingRegistry.IPlugin): void {
// Validate the user data and create the composite data.
const errors = this.validator.validateData(plugin);
if (errors) {
throw errors;
}
// Set the local copy.
this._plugins[plugin.id] = plugin;
}
private _connector: IDataConnector<ISettingRegistry.IPlugin, string>;
private _pluginChanged = new Signal<this, string>(this);
private _plugins: { [name: string]: ISettingRegistry.IPlugin } = Object.create(null);
}
/**
* A manager for a specific plugin's settings.
*/
export
class Settings implements ISettingRegistry.ISettings {
/**
* Instantiate a new plugin settings manager.
*/
constructor(options: Settings.IOptions) {
const { plugin } = options;
this.plugin = plugin.id;
this.registry = options.registry;
this._composite = plugin.data.composite || { };
this._raw = plugin.raw || '{ }';
this._schema = plugin.schema || { type: 'object' };
this._user = plugin.data.user || { };
this.registry.pluginChanged.connect(this._onPluginChanged, this);
}
/**
* A signal that emits when the plugin's settings have changed.
*/
get changed(): ISignal<this, void> {
return this._changed;
}
/**
* Get the composite of user settings and extension defaults.
*/
get composite(): JSONObject {
return this._composite;
}
/**
* Test whether the plugin settings manager disposed.
*/
get isDisposed(): boolean {
return this._isDisposed;
}
/**
* Get the plugin settings schema.
*/
get schema(): ISettingRegistry.ISchema {
return this._schema;
}
/**
* Get the plugin settings raw text value.
*/
get raw(): string {
return this._raw;
}
/**
* Get the user settings.
*/
get user(): JSONObject {
return this._user;
}
/*
* The plugin name.
*/
readonly plugin: string;
/**
* The system registry instance used by the settings manager.
*/
readonly registry: SettingRegistry;
/**
* Return the defaults in a commented JSON format.
*/
annotatedDefaults(): string {
return Private.annotatedDefaults(this._schema, this.plugin);
}
/**
* Calculate the default value of a setting by iterating through the schema.
*
* @param key - The name of the setting whose default value is calculated.
*
* @returns A calculated default JSON value for a specific setting.
*/
default(key: string): JSONValue | undefined {
return Private.reifyDefault(this.schema, key);
}
/**
* Dispose of the plugin settings resources.
*/
dispose(): void {
if (this._isDisposed) {
return;
}
this._isDisposed = true;
Signal.clearData(this);
}
/**
* Get an individual setting.
*
* @param key - The name of the setting being retrieved.
*
* @returns The setting value.
*
* #### Notes
* This method returns synchronously because it uses a cached copy of the
* plugin settings that is synchronized with the registry.
*/
get(key: string): { composite: JSONValue, user: JSONValue } {
const { composite, user } = this;
return {
composite: key in composite ? copy(composite[key]) : undefined,
user: key in user ? copy(user[key]) : undefined
};
}
/**
* Remove a single setting.
*
* @param key - The name of the setting being removed.
*
* @returns A promise that resolves when the setting is removed.
*
* #### Notes
* This function is asynchronous because it writes to the setting registry.
*/
remove(key: string): Promise<void> {
return this.registry.remove(this.plugin, key);
}
/**
* Save all of the plugin's user settings at once.
*/
save(raw: string): Promise<void> {
return this.registry.upload(this.plugin, raw);
}
/**
* Set a single setting.
*
* @param key - The name of the setting being set.
*
* @param value - The value of the setting.
*
* @returns A promise that resolves when the setting has been saved.
*
* #### Notes
* This function is asynchronous because it writes to the setting registry.
*/
set(key: string, value: JSONValue): Promise<void> {
return this.registry.set(this.plugin, key, value);
}
/**
* Validates raw settings with comments.
*
* @param raw - The JSON with comments string being validated.
*
* @returns A list of errors or `null` if valid.
*/
validate(raw: string): ISchemaValidator.IError[] | null {
const data = { composite: { }, user: { } };
const id = this.plugin;
const schema = this._schema;
const validator = this.registry.validator;
return validator.validateData({ data, id, raw, schema }, false);
}
/**
* Handle plugin changes in the setting registry.
*/
private _onPluginChanged(sender: any, plugin: string): void {
if (plugin === this.plugin) {
const found = find(this.registry.plugins, p => p.id === plugin);
if (!found) {
return;
}
const { composite, user } = found.data;
const { raw, schema } = found;
this._composite = composite || { };
this._raw = raw;
this._schema = schema || { type: 'object' };
this._user = user || { };
this._changed.emit(undefined);
}
}
private _changed = new Signal<this, void>(this);
private _composite: JSONObject = Object.create(null);
private _isDisposed = false;
private _raw = '{ }';
private _schema: ISettingRegistry.ISchema = Object.create(null);
private _user: JSONObject = Object.create(null);
}
/**
* A namespace for `SettingRegistry` statics.
*/
export
namespace SettingRegistry {
/**
* The instantiation options for a setting registry
*/
export
interface IOptions {
/**
* The data connector used by the setting registry.
*/
connector: IDataConnector<ISettingRegistry.IPlugin, string>;
/**
* The validator used to enforce the settings JSON schema.
*/
validator?: ISchemaValidator;
}
}
/**
* A namespace for `Settings` statics.
*/
export
namespace Settings {
/**
* The instantiation options for a `Settings` object.
*/
export
interface IOptions {
/**
* The setting values for a plugin.
*/
plugin: ISettingRegistry.IPlugin;
/**
* The system registry instance used by the settings manager.
*/
registry: SettingRegistry;
}
}
/**
* A namespace for private module data.
*/
export
namespace Private {
/* tslint:disable */
/**
* The schema for settings.
*/
export
const SCHEMA: ISettingRegistry.ISchema = {
"$schema": "http://json-schema.org/draft-06/schema",
"title": "Jupyter Settings/Preferences Schema",
"description": "Jupyter settings/preferences schema v0.1.0",
"type": "object",
"additionalProperties": true,
"properties": {
[ICON_CLASS_KEY]: { "type": "string", "default": "jp-FileIcon" },
[ICON_LABEL_KEY]: { "type": "string", "default": "Plugin" }
}
};
/* tslint:enable */
/**
* The default indentation level, uses spaces instead of tabs.
*/
const indent = ' ';
/**
* Replacement text for schema properties missing a `description` field.
*/
const nondescript = '[missing schema description]';
/**
* Replacement text for schema properties missing a `default` field.
*/
const undefaulted = '[missing schema default]';
/**
* Replacement text for schema properties missing a `title` field.
*/