@jupyterlab/settingregistry 4.0.0-alpha.8 → 4.0.0-beta.0
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.
- package/lib/plugin-schema.json +88 -0
- package/lib/settingregistry.d.ts +49 -21
- package/lib/settingregistry.js +115 -95
- package/lib/settingregistry.js.map +1 -1
- package/lib/tokens.d.ts +94 -0
- package/lib/tokens.js.map +1 -1
- package/package.json +17 -15
- package/src/index.ts +11 -0
- package/src/plugin-schema.json +388 -0
- package/src/settingregistry.ts +1489 -0
- package/src/tokens.ts +771 -0
|
@@ -0,0 +1,388 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema",
|
|
3
|
+
"title": "JupyterLab Plugin Settings/Preferences Schema",
|
|
4
|
+
"description": "JupyterLab plugin settings/preferences schema",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"additionalProperties": true,
|
|
8
|
+
"properties": {
|
|
9
|
+
"jupyter.lab.internationalization": {
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"selectors": {
|
|
13
|
+
"type": "array",
|
|
14
|
+
"items": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"minLength": 1
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"domain": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"minLength": 1
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"jupyter.lab.menus": {
|
|
26
|
+
"type": "object",
|
|
27
|
+
"properties": {
|
|
28
|
+
"main": {
|
|
29
|
+
"title": "Main menu entries",
|
|
30
|
+
"description": "List of menu items to add to the main menubar.",
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "#/definitions/menu"
|
|
33
|
+
},
|
|
34
|
+
"type": "array",
|
|
35
|
+
"default": []
|
|
36
|
+
},
|
|
37
|
+
"context": {
|
|
38
|
+
"title": "The application context menu.",
|
|
39
|
+
"description": "List of context menu items.",
|
|
40
|
+
"items": {
|
|
41
|
+
"allOf": [
|
|
42
|
+
{ "$ref": "#/definitions/menuItem" },
|
|
43
|
+
{
|
|
44
|
+
"properties": {
|
|
45
|
+
"selector": {
|
|
46
|
+
"description": "The CSS selector for the context menu item.",
|
|
47
|
+
"type": "string"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"type": "array",
|
|
54
|
+
"default": []
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"additionalProperties": false
|
|
58
|
+
},
|
|
59
|
+
"jupyter.lab.metadataforms": {
|
|
60
|
+
"items": {
|
|
61
|
+
"$ref": "#/definitions/metadataForm"
|
|
62
|
+
},
|
|
63
|
+
"type": "array",
|
|
64
|
+
"default": []
|
|
65
|
+
},
|
|
66
|
+
"jupyter.lab.setting-deprecated": {
|
|
67
|
+
"type": "boolean",
|
|
68
|
+
"default": false
|
|
69
|
+
},
|
|
70
|
+
"jupyter.lab.setting-icon": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"default": ""
|
|
73
|
+
},
|
|
74
|
+
"jupyter.lab.setting-icon-class": {
|
|
75
|
+
"type": "string",
|
|
76
|
+
"default": ""
|
|
77
|
+
},
|
|
78
|
+
"jupyter.lab.setting-icon-label": {
|
|
79
|
+
"type": "string",
|
|
80
|
+
"default": "Plugin"
|
|
81
|
+
},
|
|
82
|
+
"jupyter.lab.shortcuts": {
|
|
83
|
+
"items": {
|
|
84
|
+
"$ref": "#/definitions/shortcut"
|
|
85
|
+
},
|
|
86
|
+
"type": "array",
|
|
87
|
+
"default": []
|
|
88
|
+
},
|
|
89
|
+
"jupyter.lab.toolbars": {
|
|
90
|
+
"properties": {
|
|
91
|
+
"^\\w[\\w-\\.]*$": {
|
|
92
|
+
"items": {
|
|
93
|
+
"$ref": "#/definitions/toolbarItem"
|
|
94
|
+
},
|
|
95
|
+
"type": "array",
|
|
96
|
+
"default": []
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"type": "object",
|
|
100
|
+
"default": {}
|
|
101
|
+
},
|
|
102
|
+
"jupyter.lab.transform": {
|
|
103
|
+
"type": "boolean",
|
|
104
|
+
"default": false
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"definitions": {
|
|
108
|
+
"menu": {
|
|
109
|
+
"properties": {
|
|
110
|
+
"disabled": {
|
|
111
|
+
"description": "Whether the menu is disabled or not",
|
|
112
|
+
"type": "boolean",
|
|
113
|
+
"default": false
|
|
114
|
+
},
|
|
115
|
+
"icon": {
|
|
116
|
+
"description": "Menu icon id",
|
|
117
|
+
"type": "string"
|
|
118
|
+
},
|
|
119
|
+
"id": {
|
|
120
|
+
"description": "Menu unique id",
|
|
121
|
+
"oneOf": [
|
|
122
|
+
{
|
|
123
|
+
"type": "string",
|
|
124
|
+
"enum": [
|
|
125
|
+
"jp-menu-file",
|
|
126
|
+
"jp-menu-file-new",
|
|
127
|
+
"jp-menu-edit",
|
|
128
|
+
"jp-menu-help",
|
|
129
|
+
"jp-menu-kernel",
|
|
130
|
+
"jp-menu-run",
|
|
131
|
+
"jp-menu-settings",
|
|
132
|
+
"jp-menu-view",
|
|
133
|
+
"jp-menu-tabs"
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
{ "type": "string", "pattern": "[a-z][a-z0-9\\-_]+" }
|
|
137
|
+
]
|
|
138
|
+
},
|
|
139
|
+
"items": {
|
|
140
|
+
"description": "Menu items",
|
|
141
|
+
"type": "array",
|
|
142
|
+
"items": {
|
|
143
|
+
"$ref": "#/definitions/menuItem"
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"label": {
|
|
147
|
+
"description": "Menu label",
|
|
148
|
+
"type": "string"
|
|
149
|
+
},
|
|
150
|
+
"mnemonic": {
|
|
151
|
+
"description": "Mnemonic index for the label",
|
|
152
|
+
"type": "number",
|
|
153
|
+
"minimum": -1,
|
|
154
|
+
"default": -1
|
|
155
|
+
},
|
|
156
|
+
"rank": {
|
|
157
|
+
"description": "Menu rank",
|
|
158
|
+
"type": "number",
|
|
159
|
+
"minimum": 0
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
"required": ["id"],
|
|
163
|
+
"type": "object"
|
|
164
|
+
},
|
|
165
|
+
"menuItem": {
|
|
166
|
+
"properties": {
|
|
167
|
+
"args": {
|
|
168
|
+
"description": "Command arguments",
|
|
169
|
+
"type": "object"
|
|
170
|
+
},
|
|
171
|
+
"command": {
|
|
172
|
+
"description": "Command id",
|
|
173
|
+
"type": "string"
|
|
174
|
+
},
|
|
175
|
+
"disabled": {
|
|
176
|
+
"description": "Whether the item is disabled or not",
|
|
177
|
+
"type": "boolean",
|
|
178
|
+
"default": false
|
|
179
|
+
},
|
|
180
|
+
"type": {
|
|
181
|
+
"description": "Item type",
|
|
182
|
+
"type": "string",
|
|
183
|
+
"enum": ["command", "submenu", "separator"],
|
|
184
|
+
"default": "command"
|
|
185
|
+
},
|
|
186
|
+
"rank": {
|
|
187
|
+
"description": "Item rank",
|
|
188
|
+
"type": "number",
|
|
189
|
+
"minimum": 0
|
|
190
|
+
},
|
|
191
|
+
"submenu": {
|
|
192
|
+
"oneOf": [
|
|
193
|
+
{
|
|
194
|
+
"$ref": "#/definitions/menu"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"type": "null"
|
|
198
|
+
}
|
|
199
|
+
]
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"type": "object"
|
|
203
|
+
},
|
|
204
|
+
"shortcut": {
|
|
205
|
+
"properties": {
|
|
206
|
+
"args": {
|
|
207
|
+
"title": "The arguments for the command",
|
|
208
|
+
"type": "object"
|
|
209
|
+
},
|
|
210
|
+
"command": {
|
|
211
|
+
"title": "The command id",
|
|
212
|
+
"description": "The command executed when the binding is matched.",
|
|
213
|
+
"type": "string"
|
|
214
|
+
},
|
|
215
|
+
"disabled": {
|
|
216
|
+
"description": "Whether this shortcut is disabled or not.",
|
|
217
|
+
"type": "boolean",
|
|
218
|
+
"default": false
|
|
219
|
+
},
|
|
220
|
+
"keys": {
|
|
221
|
+
"title": "The key sequence for the binding",
|
|
222
|
+
"description": "The key shortcut like `Accel A` or the sequence of shortcuts to press like [`Accel A`, `B`]",
|
|
223
|
+
"items": {
|
|
224
|
+
"type": "string"
|
|
225
|
+
},
|
|
226
|
+
"type": "array"
|
|
227
|
+
},
|
|
228
|
+
"macKeys": {
|
|
229
|
+
"title": "The key sequence for the binding on macOS",
|
|
230
|
+
"description": "The key shortcut like `Cmd A` or the sequence of shortcuts to press like [`Cmd A`, `B`]",
|
|
231
|
+
"items": {
|
|
232
|
+
"type": "string"
|
|
233
|
+
},
|
|
234
|
+
"type": "array"
|
|
235
|
+
},
|
|
236
|
+
"winKeys": {
|
|
237
|
+
"title": "The key sequence for the binding on Windows",
|
|
238
|
+
"description": "The key shortcut like `Ctrl A` or the sequence of shortcuts to press like [`Ctrl A`, `B`]",
|
|
239
|
+
"items": {
|
|
240
|
+
"type": "string"
|
|
241
|
+
},
|
|
242
|
+
"type": "array"
|
|
243
|
+
},
|
|
244
|
+
"linuxKeys": {
|
|
245
|
+
"title": "The key sequence for the binding on Linux",
|
|
246
|
+
"description": "The key shortcut like `Ctrl A` or the sequence of shortcuts to press like [`Ctrl A`, `B`]",
|
|
247
|
+
"items": {
|
|
248
|
+
"type": "string"
|
|
249
|
+
},
|
|
250
|
+
"type": "array"
|
|
251
|
+
},
|
|
252
|
+
"selector": {
|
|
253
|
+
"title": "CSS selector",
|
|
254
|
+
"type": "string"
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"required": ["command", "keys", "selector"],
|
|
258
|
+
"type": "object"
|
|
259
|
+
},
|
|
260
|
+
"toolbarItem": {
|
|
261
|
+
"properties": {
|
|
262
|
+
"name": {
|
|
263
|
+
"title": "Unique name",
|
|
264
|
+
"type": "string"
|
|
265
|
+
},
|
|
266
|
+
"args": {
|
|
267
|
+
"title": "Command arguments",
|
|
268
|
+
"type": "object"
|
|
269
|
+
},
|
|
270
|
+
"command": {
|
|
271
|
+
"title": "Command id",
|
|
272
|
+
"type": "string",
|
|
273
|
+
"default": ""
|
|
274
|
+
},
|
|
275
|
+
"disabled": {
|
|
276
|
+
"title": "Whether the item is ignored or not",
|
|
277
|
+
"type": "boolean",
|
|
278
|
+
"default": false
|
|
279
|
+
},
|
|
280
|
+
"icon": {
|
|
281
|
+
"title": "Item icon id",
|
|
282
|
+
"description": "If defined, it will override the command icon",
|
|
283
|
+
"type": "string"
|
|
284
|
+
},
|
|
285
|
+
"label": {
|
|
286
|
+
"title": "Item label",
|
|
287
|
+
"description": "If defined, it will override the command label",
|
|
288
|
+
"type": "string"
|
|
289
|
+
},
|
|
290
|
+
"type": {
|
|
291
|
+
"title": "Item type",
|
|
292
|
+
"type": "string",
|
|
293
|
+
"enum": ["command", "spacer"]
|
|
294
|
+
},
|
|
295
|
+
"rank": {
|
|
296
|
+
"title": "Item rank",
|
|
297
|
+
"type": "number",
|
|
298
|
+
"minimum": 0,
|
|
299
|
+
"default": 50
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
"required": ["name"],
|
|
303
|
+
"additionalProperties": false,
|
|
304
|
+
"type": "object"
|
|
305
|
+
},
|
|
306
|
+
"metadataForm": {
|
|
307
|
+
"type": "object",
|
|
308
|
+
"properties": {
|
|
309
|
+
"id": {
|
|
310
|
+
"type": "string",
|
|
311
|
+
"description": "The section ID"
|
|
312
|
+
},
|
|
313
|
+
"metadataSchema": {
|
|
314
|
+
"type": "object",
|
|
315
|
+
"items": {
|
|
316
|
+
"$ref": "#/definitions/metadataSchema"
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
"uiSchema": {
|
|
320
|
+
"type": "object"
|
|
321
|
+
},
|
|
322
|
+
"metadataOptions": {
|
|
323
|
+
"type": "object",
|
|
324
|
+
"items": {
|
|
325
|
+
"$ref": "#/definitions/metadataOptions"
|
|
326
|
+
}
|
|
327
|
+
},
|
|
328
|
+
"label": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"description": "The section label"
|
|
331
|
+
},
|
|
332
|
+
"rank": {
|
|
333
|
+
"type": "integer",
|
|
334
|
+
"description": "The rank of the section in the right panel"
|
|
335
|
+
},
|
|
336
|
+
"showModified": {
|
|
337
|
+
"type": "boolean",
|
|
338
|
+
"description": "Whether to show modified values from defaults"
|
|
339
|
+
}
|
|
340
|
+
},
|
|
341
|
+
"required": ["id", "metadataSchema"]
|
|
342
|
+
},
|
|
343
|
+
"metadataSchema": {
|
|
344
|
+
"properties": {
|
|
345
|
+
"properties": {
|
|
346
|
+
"type": "object",
|
|
347
|
+
"description": "The property set up by extension",
|
|
348
|
+
"properties": {
|
|
349
|
+
"title": {
|
|
350
|
+
"type": "string"
|
|
351
|
+
},
|
|
352
|
+
"description": {
|
|
353
|
+
"type": "string"
|
|
354
|
+
},
|
|
355
|
+
"type": {
|
|
356
|
+
"type": "string"
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
}
|
|
360
|
+
},
|
|
361
|
+
"type": "object",
|
|
362
|
+
"required": ["properties"]
|
|
363
|
+
},
|
|
364
|
+
"metadataOptions": {
|
|
365
|
+
"properties": {
|
|
366
|
+
"customRenderer": {
|
|
367
|
+
"type": "string"
|
|
368
|
+
},
|
|
369
|
+
"metadataLevel": {
|
|
370
|
+
"type": "string",
|
|
371
|
+
"enum": ["cell", "notebook"],
|
|
372
|
+
"default": "cell"
|
|
373
|
+
},
|
|
374
|
+
"cellTypes": {
|
|
375
|
+
"type": "array",
|
|
376
|
+
"items": {
|
|
377
|
+
"type": "string",
|
|
378
|
+
"enum": ["code", "markdown", "raw"]
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"writeDefault": {
|
|
382
|
+
"type": "boolean"
|
|
383
|
+
}
|
|
384
|
+
},
|
|
385
|
+
"type": "object"
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
}
|