@linkdesk/plugin-sdk 0.1.14 → 0.1.15
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/README.md +35 -35
- package/package.json +1 -1
- package/schemas/icon-theme.schema.json +97 -97
- package/schemas/plugin.schema.json +169 -169
- package/schemas/theme.schema.json +109 -109
|
@@ -1,154 +1,154 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://embeddesk.app/schemas/plugin.schema.json",
|
|
4
|
-
"title": "
|
|
5
|
-
"description": "plugin.json
|
|
4
|
+
"title": "Plugin metadata",
|
|
5
|
+
"description": "JSON Schema for plugin.json — IDE autocompletion + JSON validation",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"required": ["name", "version"],
|
|
8
8
|
"properties": {
|
|
9
9
|
"$schema": {
|
|
10
10
|
"type": "string",
|
|
11
|
-
"description": "JSON Schema
|
|
12
|
-
"$comment": "$schema
|
|
11
|
+
"description": "JSON Schema reference — used for IDE autocompletion",
|
|
12
|
+
"$comment": "$schema is used only for IDE autocompletion; no JSON Schema validation is performed at runtime"
|
|
13
13
|
},
|
|
14
14
|
"pluginId": {
|
|
15
15
|
"type": "string",
|
|
16
16
|
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$",
|
|
17
|
-
"description": "🔴
|
|
17
|
+
"description": "🔴 Plugin identity — immutable once published (mirrors VS Code's publisher.name). Everything keys off it: install directory {userData}/plugins/<pluginId>/, distribution file name <pluginId>.linkdesk-plugin, marketplace dedup key, uninstall tombstone key, and update reconciliation. Strongly recommended to declare it explicitly: when omitted it falls back to the project directory name, but repository names and local directory names are free-form — rename the directory and the identity changes with it, and none of the five consequences (two install directories side by side / tombstone mismatch / duplicate marketplace entries / silently broken update chain / plugin data appearing lost) reports an error. Character set: letters, digits, `.`, `_`, `-`; the first character must be a letter or a digit."
|
|
18
18
|
},
|
|
19
19
|
"type": {
|
|
20
20
|
"type": "string",
|
|
21
|
-
"description": "
|
|
21
|
+
"description": "[Deprecated] Plugin type — no longer required. The loader infers the contribution type from declared fields such as entry/mode/themes/languages/resources. Kept only for backward compatibility. The value is an open string, not a closed enum."
|
|
22
22
|
},
|
|
23
23
|
"core": {
|
|
24
24
|
"type": "boolean",
|
|
25
|
-
"description": "
|
|
25
|
+
"description": "Pure UI safeguard against accidental removal — marks the plugin as important, so the uninstall entry is hidden in the plugin detail UI (newcomers cannot delete it by mistake). Grants no behavioral privilege: disable/uninstall still work through the API/command layer (uninstall writes a `removed` tombstone; boot does not resurrect it). Built-in capabilities such as the settings page and marketplace come from factoryRole slots (replaceable) and are unrelated to this flag. Absent = an ordinary plugin that the UI can freely install and uninstall. Default false.",
|
|
26
26
|
"default": false
|
|
27
27
|
},
|
|
28
28
|
"factoryRole": {
|
|
29
29
|
"type": "string",
|
|
30
|
-
"description": "
|
|
30
|
+
"description": "System slot role — declares which system-level feature this plugin fills. settings = settings page (opened with Ctrl+,), marketplace = plugin marketplace. Multiple plugins with the same role may legally coexist (all become slot candidates, one-to-many); the default is the first registered in stable order (core:true grants no privilege and does not claim the default), and a user-switched active candidate is persisted."
|
|
31
31
|
},
|
|
32
32
|
"pluginRole": {
|
|
33
33
|
"type": "string",
|
|
34
|
-
"description": "
|
|
34
|
+
"description": "Plugin loading strategy — view = has React UI components, data = pure data (themes/languages/protocols); inferred when omitted. The value is an open string, so third parties may declare new strategy names."
|
|
35
35
|
},
|
|
36
36
|
"appearsIn": {
|
|
37
37
|
"type": "object",
|
|
38
|
-
"description": "
|
|
38
|
+
"description": "Where the plugin's UI appears — declarative. Replaces iconLocation + viewRole + keepSidebarOnFocus.",
|
|
39
39
|
"properties": {
|
|
40
|
-
"iconBar": { "type": "string", "enum": ["top", "bottom"], "description": "
|
|
41
|
-
"sidePanel": { "type": "boolean", "description": "
|
|
42
|
-
"tabBar": { "type": "boolean", "description": "
|
|
43
|
-
"statusBar": { "type": "string", "description": "
|
|
40
|
+
"iconBar": { "type": "string", "enum": ["top", "bottom"], "description": "Icon Bar position; omitted = no icon shown" },
|
|
41
|
+
"sidePanel": { "type": "boolean", "description": "Has a Sidebar view container. Default false." },
|
|
42
|
+
"tabBar": { "type": "boolean", "description": "Can be opened as a tab. Default false." },
|
|
43
|
+
"statusBar": { "type": "string", "description": "File path of a self-drawn (code) Status Bar component, relative to the plugin root, .tsx, e.g. \"src/components/statusBar.tsx\" — the pool renders it from the declared URL, replacing static statusBar contributions; omit it when you only contribute static entries." }
|
|
44
44
|
}
|
|
45
45
|
},
|
|
46
46
|
"distribution": {
|
|
47
47
|
"type": "string",
|
|
48
48
|
"enum": ["builtin", "user"],
|
|
49
49
|
"default": "user",
|
|
50
|
-
"description": "⚠️
|
|
50
|
+
"description": "⚠️ Legacy field — after the single-root flattening there is no longer any plugins/builtin vs. plugins/user distinction, so this field maps to no directory and is always normalized to user on install. Whether a plugin ships built-in is declared by `core`, not by this field. Third-party plugins should not set it."
|
|
51
51
|
},
|
|
52
52
|
"name": {
|
|
53
53
|
"type": "string",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "Display name",
|
|
55
55
|
"minLength": 1
|
|
56
56
|
},
|
|
57
57
|
"version": {
|
|
58
58
|
"type": "string",
|
|
59
|
-
"description": "
|
|
59
|
+
"description": "Semantic version",
|
|
60
60
|
"pattern": "^\\d+\\.\\d+\\.\\d+$"
|
|
61
61
|
},
|
|
62
62
|
"icon": {
|
|
63
63
|
"type": "string",
|
|
64
|
-
"description": "
|
|
64
|
+
"description": "Icon (split of the three-image model) — plugins placed on the Icon Bar set a Type-1 monochrome silhouette glyph here (the shell Icon Bar reads only this field); for plugins not on the Icon Bar this field is the Type-2 colored identity image, which the tab bar and marketplace reuse as marketIcon ?? icon ?? default colored block. A codicon name, or a path relative to a bundled svg/png asset (inferred from the value when iconSource is omitted)."
|
|
65
65
|
},
|
|
66
66
|
"iconSource": {
|
|
67
67
|
"type": "string",
|
|
68
|
-
"description": "
|
|
68
|
+
"description": "Icon source",
|
|
69
69
|
"enum": ["codicon", "svg", "url", "lucide"],
|
|
70
70
|
"default": "codicon"
|
|
71
71
|
},
|
|
72
72
|
"marketIcon": {
|
|
73
73
|
"type": "string",
|
|
74
|
-
"description": "Type-2
|
|
74
|
+
"description": "Type-2 colored plugin identity image (the earlier \"cover art / scene cover\" meaning is retired — embed a scene cover in the README instead) — the marketplace Sidebar row / detail header and the tab bar view label show the same image. A path relative to a bundled svg asset; omitted → falls back to icon → shared default colored block. Optional: the whole chain falls back automatically for plugins with no images, so this split is invisible to third parties."
|
|
75
75
|
},
|
|
76
76
|
"marketIconSource": {
|
|
77
77
|
"type": "string",
|
|
78
|
-
"description": "
|
|
78
|
+
"description": "Identity image source — same enum as iconSource; the value is a path relative to a bundled svg asset, and when source is omitted it is inferred from the path (an explicit svg treats the path as a bare URL, which breaks already-installed plugins).",
|
|
79
79
|
"enum": ["codicon", "svg", "url", "lucide"],
|
|
80
80
|
"default": "codicon"
|
|
81
81
|
},
|
|
82
82
|
"description": {
|
|
83
83
|
"type": "string",
|
|
84
|
-
"description": "
|
|
84
|
+
"description": "One-line description shown on the plugin detail page. Multi-line supported."
|
|
85
85
|
},
|
|
86
86
|
"author": {
|
|
87
87
|
"type": "string",
|
|
88
|
-
"description": "
|
|
88
|
+
"description": "Author name"
|
|
89
89
|
},
|
|
90
90
|
"entry": {
|
|
91
91
|
"type": "string",
|
|
92
|
-
"description": "
|
|
92
|
+
"description": "Entry file path, relative to the plugin directory. Required for view/card/protocol."
|
|
93
93
|
},
|
|
94
94
|
"sidebar": {
|
|
95
95
|
"type": "string",
|
|
96
|
-
"description": "
|
|
97
|
-
"$comment": "
|
|
96
|
+
"description": "Sidebar component path; only meaningful for the view type.",
|
|
97
|
+
"$comment": "Discovered automatically by Vite glob; no plugin declaration needed"
|
|
98
98
|
},
|
|
99
99
|
"tabBehavior": {
|
|
100
100
|
"type": "object",
|
|
101
|
-
"description": "
|
|
101
|
+
"description": "Tab behavior declaration — the core reads this field to decide dedup / fallback / close confirmation.",
|
|
102
102
|
"properties": {
|
|
103
103
|
"isFallback": {
|
|
104
104
|
"type": "boolean",
|
|
105
|
-
"description": "
|
|
105
|
+
"description": "Automatically create this tab when no tab is open, and make it non-closable.",
|
|
106
106
|
"default": false
|
|
107
107
|
},
|
|
108
108
|
"singleton": {
|
|
109
109
|
"type": "boolean",
|
|
110
|
-
"description": "
|
|
110
|
+
"description": "Only one instance allowed globally.",
|
|
111
111
|
"default": false
|
|
112
112
|
},
|
|
113
113
|
"confirmOnClose": {
|
|
114
114
|
"type": "string",
|
|
115
|
-
"description": "
|
|
115
|
+
"description": "Show a confirmation dialog before closing; the value is the prompt text."
|
|
116
116
|
},
|
|
117
117
|
"invokeBeforeClose": {
|
|
118
118
|
"type": "string",
|
|
119
|
-
"description": "
|
|
119
|
+
"description": "Command invoked before closing (after the confirmOnClose confirmation, before the tab closes). For example the terminal declares \"close_port\"."
|
|
120
120
|
},
|
|
121
121
|
"identityField": {
|
|
122
122
|
"type": "string",
|
|
123
|
-
"description": "CreateTabOptions
|
|
123
|
+
"description": "The single field in CreateTabOptions used to determine tab identity. Omitted = multiple instances allowed, no dedup. For example workspace declares \"workspaceName\" — only one tab per workspace name."
|
|
124
124
|
}
|
|
125
125
|
},
|
|
126
126
|
"additionalProperties": false
|
|
127
127
|
},
|
|
128
128
|
"statusBar": {
|
|
129
129
|
"type": "array",
|
|
130
|
-
"description": "
|
|
130
|
+
"description": "Status Bar contribution entries",
|
|
131
131
|
"items": {
|
|
132
132
|
"type": "object",
|
|
133
133
|
"required": ["id"],
|
|
134
134
|
"properties": {
|
|
135
|
-
"id": { "type": "string", "description": "
|
|
136
|
-
"icon": { "type": "string", "description": "codicon
|
|
137
|
-
"label": { "type": "string", "description": "
|
|
135
|
+
"id": { "type": "string", "description": "Unique identifier" },
|
|
136
|
+
"icon": { "type": "string", "description": "codicon name or SVG path" },
|
|
137
|
+
"label": { "type": "string", "description": "Display text" },
|
|
138
138
|
"align": { "type": "string", "enum": ["left", "right"], "default": "left" },
|
|
139
|
-
"onClick": { "type": "string", "description": "
|
|
140
|
-
"configurable": { "type": "boolean", "description": "
|
|
139
|
+
"onClick": { "type": "string", "description": "Click behavior — command name" },
|
|
140
|
+
"configurable": { "type": "boolean", "description": "Declaring true → the shell auto-registers a configuration entry and injects the visible prop. The plugin author writes one line of JSON, zero code.", "default": false }
|
|
141
141
|
},
|
|
142
142
|
"additionalProperties": false
|
|
143
143
|
}
|
|
144
144
|
},
|
|
145
145
|
"file": {
|
|
146
146
|
"type": "string",
|
|
147
|
-
"description": "
|
|
147
|
+
"description": "Single-file entry — for the theme/language types. Use either this or themes/languages."
|
|
148
148
|
},
|
|
149
149
|
"themes": {
|
|
150
150
|
"type": "array",
|
|
151
|
-
"description": "
|
|
151
|
+
"description": "Array of multiple themes; only for the theme type.",
|
|
152
152
|
"items": {
|
|
153
153
|
"type": "object",
|
|
154
154
|
"required": ["id", "name", "file"],
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
},
|
|
163
163
|
"languages": {
|
|
164
164
|
"type": "array",
|
|
165
|
-
"description": "
|
|
165
|
+
"description": "Array of multiple languages; only for the language type.",
|
|
166
166
|
"items": {
|
|
167
167
|
"type": "object",
|
|
168
168
|
"required": ["code", "name", "file"],
|
|
@@ -176,18 +176,18 @@
|
|
|
176
176
|
},
|
|
177
177
|
"mode": {
|
|
178
178
|
"type": "string",
|
|
179
|
-
"description": "
|
|
179
|
+
"description": "Protocol mode. text = plain-text protocol; binary = WASM binary protocol (not available yet).",
|
|
180
180
|
"enum": ["text", "binary"],
|
|
181
181
|
"default": "text"
|
|
182
182
|
},
|
|
183
183
|
"resources": {
|
|
184
184
|
"type": "array",
|
|
185
|
-
"description": "
|
|
185
|
+
"description": "Resource file list; only for the resource type.",
|
|
186
186
|
"items": { "type": "string" }
|
|
187
187
|
},
|
|
188
188
|
"recommends": {
|
|
189
189
|
"type": "array",
|
|
190
|
-
"description": "
|
|
190
|
+
"description": "Plugins recommended to install alongside.",
|
|
191
191
|
"items": {
|
|
192
192
|
"type": "object",
|
|
193
193
|
"required": ["plugin", "reason"],
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
},
|
|
201
201
|
"suggests": {
|
|
202
202
|
"type": "array",
|
|
203
|
-
"description": "
|
|
203
|
+
"description": "Optional related plugins.",
|
|
204
204
|
"items": {
|
|
205
205
|
"type": "object",
|
|
206
206
|
"required": ["plugin", "reason"],
|
|
@@ -213,40 +213,40 @@
|
|
|
213
213
|
},
|
|
214
214
|
"requires": {
|
|
215
215
|
"type": "array",
|
|
216
|
-
"description": "
|
|
216
|
+
"description": "Plugin-level activation order dependency — declared by pluginId; dependencies load before this plugin. No version constraint. A missing dependency suspends the plugin (PENDING), which then loads automatically once the dependency is ready.",
|
|
217
217
|
"items": { "type": "string" },
|
|
218
218
|
"uniqueItems": true
|
|
219
219
|
},
|
|
220
220
|
"screenshots": {
|
|
221
221
|
"type": "array",
|
|
222
|
-
"description": "
|
|
223
|
-
"$comment": "
|
|
222
|
+
"description": "Array of screenshot URLs.",
|
|
223
|
+
"$comment": "Reserved for future PluginDetailView enhancements",
|
|
224
224
|
"items": { "type": "string" }
|
|
225
225
|
},
|
|
226
226
|
"minAppVersion": {
|
|
227
227
|
"type": "string",
|
|
228
|
-
"description": "
|
|
228
|
+
"description": "Minimum required app version."
|
|
229
229
|
},
|
|
230
230
|
"docs": {
|
|
231
231
|
"type": "string",
|
|
232
|
-
"description": "
|
|
233
|
-
"$comment": "
|
|
232
|
+
"description": "Path to accompanying documentation (used with resource plugins).",
|
|
233
|
+
"$comment": "Documentation link"
|
|
234
234
|
},
|
|
235
235
|
"cardDocMap": {
|
|
236
236
|
"type": "object",
|
|
237
|
-
"description": "
|
|
238
|
-
"$comment": "
|
|
237
|
+
"description": "Card ID → documentation anchor mapping",
|
|
238
|
+
"$comment": "Card documentation mapping",
|
|
239
239
|
"additionalProperties": { "type": "string" }
|
|
240
240
|
},
|
|
241
241
|
"i18n": {
|
|
242
242
|
"type": "object",
|
|
243
|
-
"description": "@deprecated
|
|
243
|
+
"description": "@deprecated Use contributes.i18n instead — translation file declarations moved under contributes. Kept only for backward compatibility.",
|
|
244
244
|
"additionalProperties": { "type": "string" }
|
|
245
245
|
},
|
|
246
246
|
"cssVars": {
|
|
247
247
|
"type": "object",
|
|
248
|
-
"description": "
|
|
249
|
-
"$comment": "
|
|
248
|
+
"description": "Plugin-defined CSS variables",
|
|
249
|
+
"$comment": "Plugins inject CSS variables into :root",
|
|
250
250
|
"additionalProperties": {
|
|
251
251
|
"type": "object",
|
|
252
252
|
"properties": {
|
|
@@ -257,61 +257,61 @@
|
|
|
257
257
|
},
|
|
258
258
|
"permissions": {
|
|
259
259
|
"type": "array",
|
|
260
|
-
"description": "
|
|
261
|
-
"$comment": "
|
|
260
|
+
"description": "Permission declaration",
|
|
261
|
+
"$comment": "serial/filesystem/network are the first whitelist values. The value is an open string, so third parties may declare new permission names (interpreted by the main process).",
|
|
262
262
|
"items": {
|
|
263
263
|
"type": "string"
|
|
264
264
|
}
|
|
265
265
|
},
|
|
266
266
|
"iconLocation": {
|
|
267
267
|
"type": "string",
|
|
268
|
-
"description": "
|
|
268
|
+
"description": "Icon position in the Icon Bar. top (default, upper draggable area) or bottom (fixed bottom area).",
|
|
269
269
|
"enum": ["top", "bottom"],
|
|
270
270
|
"default": "top"
|
|
271
271
|
},
|
|
272
272
|
"viewRole": {
|
|
273
273
|
"type": "string",
|
|
274
|
-
"description": "
|
|
274
|
+
"description": "Interaction role of the view in the shell. sidebarPrimary = Sidebar first (clicking toggles the Sidebar; tabs are opened from within the Sidebar; default), tabOnly = tab-only view (opens a tab directly). tabPrimary was removed — all plugins use sidebarPrimary.",
|
|
275
275
|
"enum": ["sidebarPrimary", "tabOnly"],
|
|
276
276
|
"default": "sidebarPrimary"
|
|
277
277
|
},
|
|
278
278
|
"shellRendered": {
|
|
279
279
|
"type": "boolean",
|
|
280
|
-
"description": "
|
|
280
|
+
"description": "The shell renders this view itself (bypassing plugin routing). Declared only by shell-level views such as the welcome page and plugin detail page.",
|
|
281
281
|
"default": false
|
|
282
282
|
},
|
|
283
283
|
"keepSidebarOnFocus": {
|
|
284
284
|
"type": "boolean",
|
|
285
|
-
"description": "
|
|
285
|
+
"description": "Keep the current Sidebar when this view is focused — for example the Sidebar stays unchanged while browsing the plugin detail page.",
|
|
286
286
|
"default": false
|
|
287
287
|
},
|
|
288
288
|
"contributes": {
|
|
289
289
|
"type": "object",
|
|
290
|
-
"description": "
|
|
290
|
+
"description": "Contribution point declarations — mirrors VS Code package.json contributes. A core mechanism.",
|
|
291
291
|
"properties": {
|
|
292
292
|
"commands": {
|
|
293
293
|
"type": "array",
|
|
294
|
-
"description": "
|
|
294
|
+
"description": "Registered commands — the source consumed by the Command Palette, context menus, and keybindings.",
|
|
295
295
|
"items": {
|
|
296
296
|
"type": "object",
|
|
297
297
|
"required": ["id", "title"],
|
|
298
298
|
"properties": {
|
|
299
|
-
"id": { "type": "string", "description": "
|
|
300
|
-
"title": { "type": "string", "description": "
|
|
301
|
-
"category": { "type": "string", "description": "
|
|
302
|
-
"when": { "type": "string", "description": "context key when
|
|
299
|
+
"id": { "type": "string", "description": "Command ID — e.g. terminal.clear" },
|
|
300
|
+
"title": { "type": "string", "description": "Display name" },
|
|
301
|
+
"category": { "type": "string", "description": "Command palette group" },
|
|
302
|
+
"when": { "type": "string", "description": "context key when condition — e.g. activeEditor == 'terminal'" }
|
|
303
303
|
},
|
|
304
304
|
"additionalProperties": false
|
|
305
305
|
}
|
|
306
306
|
},
|
|
307
307
|
"menus": {
|
|
308
308
|
"type": "object",
|
|
309
|
-
"description": "
|
|
309
|
+
"description": "Menu item declarations — grouped by MenuId. The built-in shell registration points are listed in the MenuRegistry MENU_SLOTS constant; MenuId is an open string, so third parties may declare any new registration point.",
|
|
310
310
|
"additionalProperties": {
|
|
311
311
|
"type": "array",
|
|
312
312
|
"items": {
|
|
313
313
|
"oneOf": [
|
|
314
|
-
{ "type": "string", "description": "
|
|
314
|
+
{ "type": "string", "description": "Command ID (shorthand)" },
|
|
315
315
|
{ "$ref": "#/$defs/menuItem" }
|
|
316
316
|
]
|
|
317
317
|
}
|
|
@@ -319,27 +319,27 @@
|
|
|
319
319
|
},
|
|
320
320
|
"keybindings": {
|
|
321
321
|
"type": "array",
|
|
322
|
-
"description": "
|
|
322
|
+
"description": "Keybinding.",
|
|
323
323
|
"items": {
|
|
324
324
|
"type": "object",
|
|
325
325
|
"required": ["command", "key"],
|
|
326
326
|
"properties": {
|
|
327
327
|
"command": { "type": "string" },
|
|
328
|
-
"key": { "type": "string", "description": "
|
|
329
|
-
"when": { "type": "string", "description": "context key when
|
|
328
|
+
"key": { "type": "string", "description": "e.g. ctrl+k" },
|
|
329
|
+
"when": { "type": "string", "description": "context key when condition" }
|
|
330
330
|
},
|
|
331
331
|
"additionalProperties": false
|
|
332
332
|
}
|
|
333
333
|
},
|
|
334
334
|
"configuration": {
|
|
335
335
|
"type": "object",
|
|
336
|
-
"description": "
|
|
336
|
+
"description": "Configuration declarations — rendered automatically by the Settings Editor.",
|
|
337
337
|
"required": ["title", "properties"],
|
|
338
338
|
"properties": {
|
|
339
|
-
"title": { "type": "string", "description": "
|
|
339
|
+
"title": { "type": "string", "description": "Settings group name" },
|
|
340
340
|
"properties": {
|
|
341
341
|
"type": "object",
|
|
342
|
-
"description": "
|
|
342
|
+
"description": "Configuration mapping — key → { type, default, enum?, description }",
|
|
343
343
|
"additionalProperties": {
|
|
344
344
|
"type": "object",
|
|
345
345
|
"required": ["type", "default", "description"],
|
|
@@ -347,14 +347,14 @@
|
|
|
347
347
|
"type": { "type": "string", "enum": ["string", "number", "boolean", "object", "array"] },
|
|
348
348
|
"default": {},
|
|
349
349
|
"enum": { "type": "array" },
|
|
350
|
-
"enumDescriptions": { "type": "object", "description": "enum
|
|
350
|
+
"enumDescriptions": { "type": "object", "description": "enum value → display name mapping" },
|
|
351
351
|
"description": { "type": "string" },
|
|
352
|
-
"uiHint": { "type": "string", "description": "
|
|
353
|
-
"monoOnly": { "type": "boolean", "description": "
|
|
354
|
-
"minimum": { "type": "number", "description": "
|
|
355
|
-
"maximum": { "type": "number", "description": "
|
|
356
|
-
"step": { "type": "number", "description": "
|
|
357
|
-
"group": { "type": "string", "description": "
|
|
352
|
+
"uiHint": { "type": "string", "description": "Settings editor rendering hint. SettingsView picks the control from the hint. An unknown hint falls back to the default rendering for its type — no error is thrown. The value is an open string, so third parties may declare new hint names." },
|
|
353
|
+
"monoOnly": { "type": "boolean", "description": "Monospace only — meaningful only with uiHint \"fontFamily\". true/omitted = list monospace families only (editor fonts); false = all families (UI fonts)." },
|
|
354
|
+
"minimum": { "type": "number", "description": "Numeric lower bound — applies when type is number (range of the slider/numeric control)" },
|
|
355
|
+
"maximum": { "type": "number", "description": "Numeric upper bound — applies when type is number (range of the slider/numeric control)" },
|
|
356
|
+
"step": { "type": "number", "description": "Slider step — meaningful only with uiHint \"slider\". Defaults are derived by SettingsView from the range (0.01 for floating-point ranges)." },
|
|
357
|
+
"group": { "type": "string", "description": "Second-level heading within a group — keys sharing a group are rendered under a subheading on the settings page; without a group they stay flat (zero intrusion for third parties)" }
|
|
358
358
|
},
|
|
359
359
|
"additionalProperties": false
|
|
360
360
|
}
|
|
@@ -364,51 +364,51 @@
|
|
|
364
364
|
},
|
|
365
365
|
"configurationDefaults": {
|
|
366
366
|
"type": "object",
|
|
367
|
-
"description": "
|
|
367
|
+
"description": "Weak defaults — suggested values this plugin gives for other configuration keys; values set by the user take precedence.",
|
|
368
368
|
"additionalProperties": {}
|
|
369
369
|
},
|
|
370
370
|
"themes": {
|
|
371
371
|
"type": "array",
|
|
372
|
-
"description": "
|
|
372
|
+
"description": "Theme declarations — mirrors VS Code contributes.themes. Plugins contribute themes that users can switch in the theme browser / appearance settings.",
|
|
373
373
|
"items": {
|
|
374
374
|
"type": "object",
|
|
375
375
|
"required": ["id", "label", "uiTheme", "path"],
|
|
376
376
|
"properties": {
|
|
377
|
-
"id": { "type": "string", "description": "
|
|
378
|
-
"label": { "type": "string", "description": "
|
|
379
|
-
"uiTheme": { "type": "string", "enum": ["dark", "light", "highContrast"], "description": "
|
|
380
|
-
"path": { "type": "string", "description": "
|
|
377
|
+
"id": { "type": "string", "description": "Theme ID — e.g. my-theme-dark" },
|
|
378
|
+
"label": { "type": "string", "description": "Display name — e.g. My Theme Dark" },
|
|
379
|
+
"uiTheme": { "type": "string", "enum": ["dark", "light", "highContrast"], "description": "Base UI theme — dark / light / high contrast" },
|
|
380
|
+
"path": { "type": "string", "description": "Path to the theme definition JSON file" }
|
|
381
381
|
},
|
|
382
382
|
"additionalProperties": false
|
|
383
383
|
}
|
|
384
384
|
},
|
|
385
385
|
"iconThemes": {
|
|
386
386
|
"type": "array",
|
|
387
|
-
"description": "
|
|
387
|
+
"description": "Product icon themes — mirrors VS Code productIconThemes. Plugins declare icon sets that users can switch.",
|
|
388
388
|
"items": {
|
|
389
389
|
"type": "object",
|
|
390
390
|
"required": ["id", "label", "path"],
|
|
391
391
|
"properties": {
|
|
392
|
-
"id": { "type": "string", "description": "
|
|
393
|
-
"label": { "type": "string", "description": "
|
|
394
|
-
"path": { "type": "string", "description": "
|
|
392
|
+
"id": { "type": "string", "description": "Icon theme ID — e.g. codicon" },
|
|
393
|
+
"label": { "type": "string", "description": "Display name — e.g. Codicon" },
|
|
394
|
+
"path": { "type": "string", "description": "Path to the icon definition JSON file" }
|
|
395
395
|
},
|
|
396
396
|
"additionalProperties": false
|
|
397
397
|
}
|
|
398
398
|
},
|
|
399
399
|
"icons": {
|
|
400
400
|
"type": "object",
|
|
401
|
-
"description": "
|
|
401
|
+
"description": "Shared icons — a plugin contributes icons that other plugins reference via iconSource:shared. Mirrors the VS Code icon extension point.",
|
|
402
402
|
"additionalProperties": {
|
|
403
403
|
"type": "object",
|
|
404
404
|
"required": ["description", "default"],
|
|
405
405
|
"properties": {
|
|
406
|
-
"description": { "type": "string", "description": "
|
|
406
|
+
"description": { "type": "string", "description": "Icon description" },
|
|
407
407
|
"default": {
|
|
408
408
|
"type": "object",
|
|
409
409
|
"properties": {
|
|
410
|
-
"fontPath": { "type": "string", "description": "
|
|
411
|
-
"fontCharacter": { "type": "string", "description": "
|
|
410
|
+
"fontPath": { "type": "string", "description": "Font file path" },
|
|
411
|
+
"fontCharacter": { "type": "string", "description": "Font character code — e.g. \\e001" }
|
|
412
412
|
},
|
|
413
413
|
"additionalProperties": false
|
|
414
414
|
}
|
|
@@ -418,27 +418,27 @@
|
|
|
418
418
|
},
|
|
419
419
|
"langDefs": {
|
|
420
420
|
"type": "array",
|
|
421
|
-
"description": "
|
|
421
|
+
"description": "Language definitions — mirrors VS Code contributes.languages. Declares a new language's ID/extensions/syntax highlighting/LSP support.",
|
|
422
422
|
"items": {
|
|
423
423
|
"type": "object",
|
|
424
424
|
"required": ["id", "extensions"],
|
|
425
425
|
"properties": {
|
|
426
|
-
"id": { "type": "string", "description": "
|
|
427
|
-
"extensions": { "type": "array", "items": { "type": "string" }, "description": "
|
|
428
|
-
"aliases": { "type": "array", "items": { "type": "string" }, "description": "
|
|
426
|
+
"id": { "type": "string", "description": "Language ID — e.g. cpp / python / rust" },
|
|
427
|
+
"extensions": { "type": "array", "items": { "type": "string" }, "description": "Extension list — e.g. ['.cpp', '.cxx', '.h']" },
|
|
428
|
+
"aliases": { "type": "array", "items": { "type": "string" }, "description": "Aliases — e.g. ['C++', 'C']" },
|
|
429
429
|
"monarch": {
|
|
430
430
|
"type": "object",
|
|
431
|
-
"description": "
|
|
431
|
+
"description": "Optional — Monarch tokenizer definition (Monaco's built-in syntax highlighting)",
|
|
432
432
|
"properties": {
|
|
433
433
|
"tokenizer": { "type": "object" }
|
|
434
434
|
}
|
|
435
435
|
},
|
|
436
436
|
"lsp": {
|
|
437
437
|
"type": "object",
|
|
438
|
-
"description": "
|
|
438
|
+
"description": "Optional — LSP language server configuration",
|
|
439
439
|
"properties": {
|
|
440
|
-
"command": { "type": "string", "description": "
|
|
441
|
-
"args": { "type": "array", "items": { "type": "string" }, "description": "
|
|
440
|
+
"command": { "type": "string", "description": "Launch command — an interpreter or executable name (an interpreter such as node; a PATH binary such as clangd; or an absolute path). The python plugin uses command='node' plus args carrying the script path." },
|
|
441
|
+
"args": { "type": "array", "items": { "type": "string" }, "description": "Launch arguments. Relative-path arguments resolve against the plugin root (made absolute once at registration) — e.g. 'node_modules/pyright/dist/pyright-langserver.js' → <plugin root>/node_modules/pyright/dist/pyright-langserver.js; flags such as '--stdio' are passed through verbatim. LSP binaries ship with the plugin: the SDK packaging bundles the referenced node_modules packages into the .linkdesk-plugin file (the shell no longer ships LSPs)." }
|
|
442
442
|
}
|
|
443
443
|
}
|
|
444
444
|
},
|
|
@@ -447,62 +447,62 @@
|
|
|
447
447
|
},
|
|
448
448
|
"fileAssociations": {
|
|
449
449
|
"type": "array",
|
|
450
|
-
"description": "
|
|
450
|
+
"description": "File associations — file extension → plugin routing (consumed by the main-process plugin-manifest-loader). Declare only the extension plus an optional open command; this plugin's own pluginId comes from the top-level `pluginId` field (see the top-level pluginId description for the directory-name fallback).",
|
|
451
451
|
"items": {
|
|
452
452
|
"type": "object",
|
|
453
453
|
"required": ["extension"],
|
|
454
454
|
"properties": {
|
|
455
|
-
"extension": { "type": "string", "description": "
|
|
456
|
-
"command": { "type": "string", "description": "
|
|
457
|
-
"displayName": { "type": "string", "description": "
|
|
455
|
+
"extension": { "type": "string", "description": "File extension — without the dot, e.g. dxf / stl / step" },
|
|
456
|
+
"command": { "type": "string", "description": "Optional — command ID to run when opening a file with this extension" },
|
|
457
|
+
"displayName": { "type": "string", "description": "Optional — display name in the 'Open with…' picker" }
|
|
458
458
|
},
|
|
459
459
|
"additionalProperties": false
|
|
460
460
|
}
|
|
461
461
|
},
|
|
462
462
|
"languages": {
|
|
463
463
|
"type": "array",
|
|
464
|
-
"description": "
|
|
464
|
+
"description": "Language packs — mirrors the VS Code language extension point. A collection language pack declares multiple entries in one plugin.json.",
|
|
465
465
|
"items": {
|
|
466
466
|
"type": "object",
|
|
467
467
|
"required": ["id", "label", "path"],
|
|
468
468
|
"properties": {
|
|
469
|
-
"id": { "type": "string", "description": "
|
|
470
|
-
"label": { "type": "string", "description": "
|
|
471
|
-
"path": { "type": "string", "description": "i18n JSON
|
|
469
|
+
"id": { "type": "string", "description": "Language code — e.g. zh / en / ja" },
|
|
470
|
+
"label": { "type": "string", "description": "Display name — e.g. English / Japanese / Chinese" },
|
|
471
|
+
"path": { "type": "string", "description": "Path to the i18n JSON translation file" }
|
|
472
472
|
},
|
|
473
473
|
"additionalProperties": false
|
|
474
474
|
}
|
|
475
475
|
},
|
|
476
476
|
"titleBar": {
|
|
477
477
|
"type": "object",
|
|
478
|
-
"description": "
|
|
478
|
+
"description": "Title Bar button declarations — mirrors VS Code titleBar. Declares buttons on the left/right of the Title Bar: an icon button (icon) or a text-only button (label); set exactly one.",
|
|
479
479
|
"properties": {
|
|
480
480
|
"left": {
|
|
481
481
|
"type": "array",
|
|
482
|
-
"description": "
|
|
482
|
+
"description": "Left Title Bar buttons",
|
|
483
483
|
"items": {
|
|
484
484
|
"type": "object",
|
|
485
485
|
"required": ["command"],
|
|
486
486
|
"properties": {
|
|
487
|
-
"command": { "type": "string", "description": "
|
|
488
|
-
"icon": { "type": "string", "description": "codicon
|
|
489
|
-
"label": { "type": "string", "description": "
|
|
490
|
-
"when": { "type": "string", "description": "context key when
|
|
487
|
+
"command": { "type": "string", "description": "Command ID to run on click" },
|
|
488
|
+
"icon": { "type": "string", "description": "codicon name (e.g. codicon-settings) or image path" },
|
|
489
|
+
"label": { "type": "string", "description": "Button text — when set, the icon is not rendered. '$keyName' takes the value of that context key as the text (e.g. $updateButtonLabel); otherwise the value is treated as an i18n key (in this repository an i18n key is the original Chinese string)." },
|
|
490
|
+
"when": { "type": "string", "description": "context key when condition — the button is hidden while unmet" }
|
|
491
491
|
},
|
|
492
492
|
"additionalProperties": false
|
|
493
493
|
}
|
|
494
494
|
},
|
|
495
495
|
"right": {
|
|
496
496
|
"type": "array",
|
|
497
|
-
"description": "
|
|
497
|
+
"description": "Right Title Bar buttons",
|
|
498
498
|
"items": {
|
|
499
499
|
"type": "object",
|
|
500
500
|
"required": ["command"],
|
|
501
501
|
"properties": {
|
|
502
|
-
"command": { "type": "string", "description": "
|
|
503
|
-
"icon": { "type": "string", "description": "codicon
|
|
504
|
-
"label": { "type": "string", "description": "
|
|
505
|
-
"when": { "type": "string", "description": "context key when
|
|
502
|
+
"command": { "type": "string", "description": "Command ID to run on click" },
|
|
503
|
+
"icon": { "type": "string", "description": "codicon name (e.g. codicon-settings) or image path" },
|
|
504
|
+
"label": { "type": "string", "description": "Button text — when set, the icon is not rendered. '$keyName' takes the value of that context key as the text (e.g. $updateButtonLabel); otherwise the value is treated as an i18n key (in this repository an i18n key is the original Chinese string)." },
|
|
505
|
+
"when": { "type": "string", "description": "context key when condition — the button is hidden while unmet" }
|
|
506
506
|
},
|
|
507
507
|
"additionalProperties": false
|
|
508
508
|
}
|
|
@@ -512,33 +512,33 @@
|
|
|
512
512
|
},
|
|
513
513
|
"viewsContainers": {
|
|
514
514
|
"type": "object",
|
|
515
|
-
"description": "
|
|
515
|
+
"description": "Declares Sidebar containers — clicking this plugin's icon switches to the container. Mirrors VS Code viewsContainers.",
|
|
516
516
|
"patternProperties": {
|
|
517
517
|
"^[a-z][a-z0-9-]*$": {
|
|
518
518
|
"type": "object",
|
|
519
519
|
"required": ["title"],
|
|
520
520
|
"properties": {
|
|
521
|
-
"title": { "type": "string", "description": "
|
|
522
|
-
"icon": { "type": "string", "description": "
|
|
521
|
+
"title": { "type": "string", "description": "Container title — shown in the Sidebar header" },
|
|
522
|
+
"icon": { "type": "string", "description": "Container icon — overrides the plugin's own icon" },
|
|
523
523
|
"location": {
|
|
524
524
|
"type": "string",
|
|
525
525
|
"enum": ["sidebar", "panel", "auxiliarybar", "main"],
|
|
526
526
|
"default": "sidebar",
|
|
527
|
-
"description": "
|
|
527
|
+
"description": "Container location — sidebar = Sidebar, panel = Bottom Panel, auxiliarybar = auxiliary sidebar (⚠ not wired in the shell yet: auxiliarybar containers/views are not rendered), main = Main Area tab render surface (contributed by the active factoryRole plugin via views.main[] and consumed by the shell's ShellViewRenderer when it resolves the plugin-detail tab; third-party plugins that are not marketplace-like should use sidebar/panel)"
|
|
528
528
|
},
|
|
529
529
|
"hideIfEmpty": {
|
|
530
530
|
"type": "boolean",
|
|
531
531
|
"default": false,
|
|
532
|
-
"description": "
|
|
532
|
+
"description": "Hide the container automatically when it has no active views"
|
|
533
533
|
},
|
|
534
534
|
"order": {
|
|
535
535
|
"type": "number",
|
|
536
|
-
"description": "
|
|
536
|
+
"description": "Sort weight within the same location. Lower values come first"
|
|
537
537
|
},
|
|
538
538
|
"mergeHeaderWhenSingle": {
|
|
539
539
|
"type": "boolean",
|
|
540
540
|
"default": false,
|
|
541
|
-
"description": "
|
|
541
|
+
"description": "Hide the view header when the container holds a single view — the title merges into the container header. Mirrors VS Code mergeViewWithContainerWhenSingleView"
|
|
542
542
|
}
|
|
543
543
|
},
|
|
544
544
|
"additionalProperties": false
|
|
@@ -548,7 +548,7 @@
|
|
|
548
548
|
},
|
|
549
549
|
"views": {
|
|
550
550
|
"type": "object",
|
|
551
|
-
"description": "
|
|
551
|
+
"description": "Register views into containers — key = container ID. Mirrors VS Code views.",
|
|
552
552
|
"patternProperties": {
|
|
553
553
|
"^[a-z][a-z0-9-]*$": {
|
|
554
554
|
"type": "array",
|
|
@@ -556,52 +556,52 @@
|
|
|
556
556
|
"type": "object",
|
|
557
557
|
"required": ["id", "render"],
|
|
558
558
|
"properties": {
|
|
559
|
-
"id": { "type": "string", "description": "
|
|
560
|
-
"title": { "type": "string", "description": "
|
|
561
|
-
"render": { "type": "string", "description": "
|
|
562
|
-
"when": { "type": "string", "description": "Context key when
|
|
563
|
-
"order": { "type": "number", "description": "
|
|
564
|
-
"role": { "type": "string", "enum": ["toolbar", "section"], "default": "section", "description": "
|
|
565
|
-
"collapsed": { "type": "boolean", "default": false, "description": "
|
|
566
|
-
"canToggleVisibility": { "type": "boolean", "default": true, "description": "
|
|
567
|
-
"canMoveView": { "type": "boolean", "default": true, "description": "
|
|
559
|
+
"id": { "type": "string", "description": "Unique view ID — e.g. folders / sessions / settings" },
|
|
560
|
+
"title": { "type": "string", "description": "Display title — the header text of the SidebarSection. An empty string hides the collapsible header" },
|
|
561
|
+
"render": { "type": "string", "description": "Module path of the view component — relative to the plugin root" },
|
|
562
|
+
"when": { "type": "string", "description": "Context key when condition" },
|
|
563
|
+
"order": { "type": "number", "description": "Sort weight within the container. Lower values on top" },
|
|
564
|
+
"role": { "type": "string", "enum": ["toolbar", "section"], "default": "section", "description": "Container role — toolbar sticks to the top and is not overridden; section has a collapsible header and is replaced at the same level" },
|
|
565
|
+
"collapsed": { "type": "boolean", "default": false, "description": "Initial collapsed state" },
|
|
566
|
+
"canToggleVisibility": { "type": "boolean", "default": true, "description": "Users can toggle visibility from the Views submenu" },
|
|
567
|
+
"canMoveView": { "type": "boolean", "default": true, "description": "Users can move this view to another container" }, "minHeight": {
|
|
568
568
|
"type": "number",
|
|
569
|
-
"description": "
|
|
569
|
+
"description": "Declared minimum view height — the Sidebar pane PaneSash effectiveMinHeight (mirrors the VS Code view size)"
|
|
570
570
|
},
|
|
571
571
|
|
|
572
|
-
"hideByDefault": { "type": "boolean", "default": false, "description": "
|
|
573
|
-
"singleViewPaneContainerTitle": { "type": "string", "description": "
|
|
574
|
-
"titleDescription": { "type": "string", "description": "
|
|
572
|
+
"hideByDefault": { "type": "boolean", "default": false, "description": "Hidden by default — users must enable it manually from the Views menu" },
|
|
573
|
+
"singleViewPaneContainerTitle": { "type": "string", "description": "Replaces the container title when there is a single view and the container has mergeHeaderWhenSingle" },
|
|
574
|
+
"titleDescription": { "type": "string", "description": "Secondary text next to the title — e.g. (5 files)" },
|
|
575
575
|
"showActions": {
|
|
576
576
|
"type": "string",
|
|
577
577
|
"enum": ["always", "whenExpanded", "default"],
|
|
578
578
|
"default": "default",
|
|
579
|
-
"description": "actions
|
|
579
|
+
"description": "When actions are shown — always, whenExpanded, or default (on hover)"
|
|
580
580
|
},
|
|
581
|
-
"titleTooltip": { "type": "string", "description": "
|
|
581
|
+
"titleTooltip": { "type": "string", "description": "Title hover tooltip — shows the full text when the title is truncated" },
|
|
582
582
|
"titleActions": {
|
|
583
583
|
"type": "array",
|
|
584
|
-
"description": "
|
|
584
|
+
"description": "View action area declaration — the widget list on the right of the Panel tab bar / Sidebar header, carried along with the view when it moves. Three forms: icon button, dropdown menu, and split (primary button + dropdown, like the VS Code terminal's [+] New and [▾] profile list). An action is command + args; label/title are i18n keys (the original Chinese strings).",
|
|
585
585
|
"items": {
|
|
586
586
|
"type": "object",
|
|
587
587
|
"required": ["type", "id"],
|
|
588
588
|
"properties": {
|
|
589
|
-
"type": { "type": "string", "enum": ["icon", "dropdown", "split"], "description": "
|
|
590
|
-
"id": { "type": "string", "description": "widget
|
|
591
|
-
"command": { "type": "string", "description": "
|
|
592
|
-
"icon": { "type": "string", "description": "codicon
|
|
593
|
-
"title": { "type": "string", "description": "tooltip / aria-label
|
|
594
|
-
"args": { "description": "
|
|
589
|
+
"type": { "type": "string", "enum": ["icon", "dropdown", "split"], "description": "Widget form" },
|
|
590
|
+
"id": { "type": "string", "description": "Unique widget ID — React key / dropdown open-state anchor" },
|
|
591
|
+
"command": { "type": "string", "description": "Command ID to run on click (split = default action of the primary button; required for icon)" },
|
|
592
|
+
"icon": { "type": "string", "description": "codicon class name (e.g. codicon-add) — the icon/split primary button icon" },
|
|
593
|
+
"title": { "type": "string", "description": "tooltip / aria-label — an i18n key (used as a text button when a split has no icon)" },
|
|
594
|
+
"args": { "description": "Command arguments — passed through as the single positional argument of executeCommand(command, args) (JSON-serializable)" },
|
|
595
595
|
"items": {
|
|
596
596
|
"type": "array",
|
|
597
|
-
"description": "dropdown / split
|
|
597
|
+
"description": "dropdown / split menu entries",
|
|
598
598
|
"items": {
|
|
599
599
|
"type": "object",
|
|
600
600
|
"required": ["label", "command"],
|
|
601
601
|
"properties": {
|
|
602
|
-
"label": { "type": "string", "description": "
|
|
603
|
-
"command": { "type": "string", "description": "
|
|
604
|
-
"args": { "description": "
|
|
602
|
+
"label": { "type": "string", "description": "Display text — an i18n key (the original Chinese string)" },
|
|
603
|
+
"command": { "type": "string", "description": "Command ID to run on click" },
|
|
604
|
+
"args": { "description": "Command arguments — passed through as a single positional argument" }
|
|
605
605
|
}
|
|
606
606
|
}
|
|
607
607
|
}
|
|
@@ -617,16 +617,16 @@
|
|
|
617
617
|
},
|
|
618
618
|
"floatingPanel": {
|
|
619
619
|
"type": "object",
|
|
620
|
-
"description": "
|
|
620
|
+
"description": "Floating Panel declaration — declares that a view in contributes.views can be shown in a Floating Panel inside the shell. viewId must reference an already registered view: the declaration is resolved into pluginId/renderPath/title. Without it there is no 'Open in Floating Panel' context menu entry. The first declarer is settings (Ctrl+, opens the panel).",
|
|
621
621
|
"required": ["viewId"],
|
|
622
622
|
"properties": {
|
|
623
|
-
"viewId": { "type": "string", "description": "
|
|
623
|
+
"viewId": { "type": "string", "description": "View ID — a view registered in contributes.views" }
|
|
624
624
|
},
|
|
625
625
|
"additionalProperties": false
|
|
626
626
|
},
|
|
627
627
|
"i18n": {
|
|
628
628
|
"type": "object",
|
|
629
|
-
"description": "
|
|
629
|
+
"description": "Plugin-bundled translations — key = language code, value = JSON file path relative to the plugin root, e.g. { \"en\": \"i18n/en.json\" }. No zh.json is needed — Chinese keys are the built-in fallback.",
|
|
630
630
|
"additionalProperties": { "type": "string" }
|
|
631
631
|
}
|
|
632
632
|
},
|
|
@@ -637,16 +637,16 @@
|
|
|
637
637
|
"menuItem": {
|
|
638
638
|
"type": "object",
|
|
639
639
|
"required": ["command"],
|
|
640
|
-
"description": "
|
|
640
|
+
"description": "Menu item — aligned with the runtime ManifestMenuItem (MenuRegistry); label/order/children are recursively self-referencing. children recurses to any depth and maps one-to-one onto the runtime normalization.",
|
|
641
641
|
"properties": {
|
|
642
|
-
"command": { "type": "string", "description": "
|
|
643
|
-
"label": { "type": "string", "description": "
|
|
644
|
-
"group": { "type": "string", "description": "
|
|
645
|
-
"when": { "type": "string", "description": "context key when
|
|
646
|
-
"order": { "type": "number", "description": "
|
|
642
|
+
"command": { "type": "string", "description": "Command ID (may be empty with children — a parent menu item runs no command and expands a submenu)" },
|
|
643
|
+
"label": { "type": "string", "description": "Display label — overrides the command title (getCommand(id).title) when present; required for a parent menu item (no command)" },
|
|
644
|
+
"group": { "type": "string", "description": "Group — navigation/edit/terminal/delete/split" },
|
|
645
|
+
"when": { "type": "string", "description": "context key when condition" },
|
|
646
|
+
"order": { "type": "number", "description": "Sort weight — lower values come first within the same group" },
|
|
647
647
|
"children": {
|
|
648
648
|
"type": "array",
|
|
649
|
-
"description": "
|
|
649
|
+
"description": "Nested submenus — recurses to any depth (mirrors the VS Code SubmenuAction); command may be empty when children is present",
|
|
650
650
|
"items": { "$ref": "#/$defs/menuItem" }
|
|
651
651
|
}
|
|
652
652
|
},
|
|
@@ -655,7 +655,7 @@
|
|
|
655
655
|
},
|
|
656
656
|
"allOf": [
|
|
657
657
|
{
|
|
658
|
-
"$comment": "entry
|
|
658
|
+
"$comment": "entry condition (deprecated type family) — the if clause must include required:[\"type\"], otherwise it is vacuously true for data plugins such as theme/language that have no type (properties only validate properties that are present), which would wrongly require entry. entry is required only when type is present and matches the const.",
|
|
659
659
|
"if": {
|
|
660
660
|
"required": ["type"],
|
|
661
661
|
"properties": { "type": { "const": "view" } }
|