@workbench-kit/shell-react 0.0.2-prototype.0.2.6 → 0.0.2-prototype.0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/README.md +41 -0
  2. package/package.json +9 -9
  3. package/src/{chat-ai-mock-proposals.ts → chat/ai-mock-proposals.ts} +39 -39
  4. package/src/{chat-command-input.ts → chat/command-input.ts} +52 -52
  5. package/src/{chat-command-policy.ts → chat/command-policy.ts} +54 -54
  6. package/src/{chat-command-surface.tsx → chat/command-surface.tsx} +155 -155
  7. package/src/{use-workbench-chat-command-proposals.ts → chat/use-chat-command-proposals.ts} +194 -194
  8. package/src/{chat-view-data.ts → chat/view-data.ts} +20 -20
  9. package/src/{chat-view.tsx → chat/view.tsx} +220 -220
  10. package/src/{command-inspector-surface.tsx → commands/inspector-surface.tsx} +46 -46
  11. package/src/{use-workbench-command-descriptors.ts → commands/use-command-descriptors.ts} +41 -41
  12. package/src/{use-context-key-revision.ts → commands/use-context-key-revision.ts} +18 -18
  13. package/src/{commands-view-data.ts → commands/view-data.ts} +17 -17
  14. package/src/{commands-view.tsx → commands/view.tsx} +43 -43
  15. package/src/devtools/WorkbenchDevtoolsPanel.tsx +124 -124
  16. package/src/devtools/WorkbenchDevtoolsShell.tsx +17 -17
  17. package/src/devtools/index.ts +11 -11
  18. package/src/devtools/use-workbench-devtools-snapshot.ts +84 -84
  19. package/src/devtools/workbench-devtools-snapshot.ts +140 -140
  20. package/src/devtools/workbench-devtools.css +82 -82
  21. package/src/{editor-area-dnd.ts → editor/area-dnd.ts} +69 -69
  22. package/src/{editor-area-model.ts → editor/area-model.ts} +71 -71
  23. package/src/{editor-area.css → editor/area.css} +454 -454
  24. package/src/{editor-area.tsx → editor/area.tsx} +676 -676
  25. package/src/{editor-host-surface.tsx → editor/host-surface.tsx} +631 -634
  26. package/src/{editor-pane-visibility.ts → editor/pane-visibility.ts} +130 -130
  27. package/src/{editor-resource.ts → editor/resource.ts} +36 -36
  28. package/src/{editor-state-storage.ts → editor/state-storage.ts} +182 -193
  29. package/src/{editor-tab-context-menu.ts → editor/tab-context-menu.ts} +118 -118
  30. package/src/{use-editor.ts → editor/use-editor.ts} +114 -107
  31. package/src/{editor-view-providers.tsx → editor/view-providers.tsx} +552 -552
  32. package/src/{editor-workspace-file-availability.ts → editor/workspace-file-availability.ts} +15 -15
  33. package/src/{editor-workspace-reconcile.tsx → editor/workspace-reconcile.tsx} +31 -28
  34. package/src/{explorer-context-menu.ts → explorer/context-menu.ts} +114 -114
  35. package/src/{createCommandWorkspaceExplorerPort.ts → explorer/create-command-workspace-explorer-port.ts} +86 -86
  36. package/src/{explorer-reveal.ts → explorer/reveal.ts} +112 -112
  37. package/src/{search-view-data.ts → explorer/search-view-data.ts} +15 -15
  38. package/src/{search-view.tsx → explorer/search-view.tsx} +65 -62
  39. package/src/{use-active-workspace-path.ts → explorer/use-active-workspace-path.ts} +15 -15
  40. package/src/{explorer-view-data.ts → explorer/view-data.ts} +58 -58
  41. package/src/{explorer-view.tsx → explorer/view.tsx} +227 -224
  42. package/src/{extension-context-menu.ts → extensions/context-menu.ts} +52 -52
  43. package/src/{extension-management-model.ts → extensions/management-model.ts} +313 -313
  44. package/src/{use-extension-management.ts → extensions/use-extension-management.ts} +241 -193
  45. package/src/{extensions-view-data.ts → extensions/view-data.ts} +19 -19
  46. package/src/{extensions-view.tsx → extensions/view.tsx} +63 -38
  47. package/src/{field-remap-demo.tsx → field-remap/demo.tsx} +18 -18
  48. package/src/{field-remap-editor-surface.tsx → field-remap/editor-surface.tsx} +36 -36
  49. package/src/{field-remap-flow-adapter.ts → field-remap/flow-adapter.ts} +240 -240
  50. package/src/{field-remap-flow.tsx → field-remap/flow.tsx} +369 -369
  51. package/src/{field-remap-graph.tsx → field-remap/graph.tsx} +559 -559
  52. package/src/field-remap/jsonata-transform.ts +166 -0
  53. package/src/{field-remap-panel.tsx → field-remap/panel.tsx} +193 -175
  54. package/src/{field-remap-samples.ts → field-remap/samples.ts} +352 -352
  55. package/src/{table-mapping-adapter.ts → field-remap/table-mapping-adapter.ts} +59 -59
  56. package/src/{field-remap-tree.tsx → field-remap/tree.tsx} +404 -404
  57. package/src/{field-remap-view-data.ts → field-remap/view-data.ts} +16 -16
  58. package/src/{field-remap-view.css → field-remap/view.css} +676 -676
  59. package/src/{field-remap-view.tsx → field-remap/view.tsx} +86 -86
  60. package/src/index.ts +212 -199
  61. package/src/{json-form-source-patch.ts → jdw/json-form-source-patch.ts} +323 -323
  62. package/src/{jdw-lab-view-data.ts → jdw/lab-view-data.ts} +25 -25
  63. package/src/{jdw-lab-view.css → jdw/lab-view.css} +21 -21
  64. package/src/{jdw-lab-view.tsx → jdw/lab-view.tsx} +79 -79
  65. package/src/{jdw-widget-form-view.tsx → jdw/widget-form-view.tsx} +68 -65
  66. package/src/{jdw-widget-preview-view.tsx → jdw/widget-preview-view.tsx} +54 -51
  67. package/src/{keybinding-overrides-storage.ts → management/keybinding-overrides-storage.ts} +49 -57
  68. package/src/{keybinding-management-settings.tsx → management/keybinding-settings.tsx} +16 -16
  69. package/src/{management-palette-commands.ts → management/palette-commands.ts} +38 -38
  70. package/src/{preference-settings-storage.ts → management/preference-settings-storage.ts} +50 -58
  71. package/src/{management-settings-ids.ts → management/settings-ids.ts} +12 -12
  72. package/src/{management-settings.tsx → management/settings.tsx} +96 -75
  73. package/src/{use-command-management.ts → management/use-command-management.ts} +191 -191
  74. package/src/{use-keybinding-management.ts → management/use-keybinding-management.ts} +130 -130
  75. package/src/{shell-model.tsx → shell/model.tsx} +149 -149
  76. package/src/{provider.tsx → shell/provider.tsx} +603 -573
  77. package/src/{shell-secondary-actions.tsx → shell/secondary-actions.tsx} +59 -59
  78. package/src/{shell-settings-constants.ts → shell/settings-constants.ts} +9 -9
  79. package/src/{shell-settings.tsx → shell/settings.tsx} +599 -599
  80. package/src/{shell.tsx → shell/shell.tsx} +680 -649
  81. package/src/{shell-titlebar-layout-controls.tsx → shell/titlebar-layout-controls.tsx} +4 -4
  82. package/src/{shell-view-host.tsx → shell/view-host.tsx} +212 -199
  83. package/src/{workbench-appearance-storage.ts → workbench/appearance-storage.ts} +107 -115
  84. package/src/{workbench-command-host.tsx → workbench/command-host.tsx} +243 -243
  85. package/src/{workbench-command-palette.ts → workbench/command-palette.ts} +208 -208
  86. package/src/{workbench-keybinding-bridge.ts → workbench/keybinding-bridge.ts} +54 -54
  87. package/src/{workbench-layout-storage.ts → workbench/layout-storage.ts} +134 -145
  88. package/src/{workbench-profile-modal.tsx → workbench/profile-modal.tsx} +118 -118
  89. package/src/{workbench-shell-command-registration.ts → workbench/shell-command-registration.ts} +58 -58
  90. package/src/{workbench-startup-gate.tsx → workbench/startup-gate.tsx} +136 -136
  91. package/src/{workbench-status-sections.ts → workbench/status-sections.ts} +43 -43
  92. package/src/{use-persisted-workbench-appearance.ts → workbench/use-persisted-appearance.ts} +33 -33
  93. package/src/{workbench-user-commands.ts → workbench/user-commands.ts} +46 -46
  94. package/src/{workspace-view-state.ts → workbench/workspace-view-state.ts} +35 -35
  95. package/src/jsonata-transform.ts +0 -36
@@ -1,573 +1,603 @@
1
- import {
2
- createContext,
3
- useCallback,
4
- useContext,
5
- useEffect,
6
- useMemo,
7
- useRef,
8
- useState,
9
- type ReactNode,
10
- } from 'react';
11
- import {
12
- BUILTIN_WORKBENCH_EXTENSIONS,
13
- collectConfigurationDefaults,
14
- createEditorService,
15
- ExtensionRegistry,
16
- LayoutService,
17
- loadInstalledExtensions,
18
- mergeExtensionsConfigWithInstallState,
19
- PreferenceService,
20
- registerEditorSaveCommand,
21
- registerHostWorkbenchThemes,
22
- resolveInstalledAvailableExtensions,
23
- resolveWorkbenchExtensions,
24
- SAMPLE_WORKBENCH_EXTENSIONS,
25
- DEFAULT_INSTALLED_EXTENSIONS_STORAGE_KEY,
26
- WORKBENCH_EDITOR_SERVICE_CAPABILITY_ID,
27
- type EditorState,
28
- type EditorService,
29
- type PreferenceService as PreferenceServiceType,
30
- type WorkbenchHostThemeRegistration,
31
- type WorkbenchStorageAdapter,
32
- type WorkbenchEditorSavePort,
33
- type WorkbenchExtensionDescription,
34
- type WorkbenchLayoutStateInput,
35
- } from '@workbench-kit/workbench-core';
36
- import {
37
- ContextKeyService,
38
- createWorkbenchPermissionContextKeys,
39
- type ContextKeyValue,
40
- } from '@workbench-kit/platform';
41
- import type {
42
- WorkbenchExtensionsConfig,
43
- WorkbenchKeybindingDefinition,
44
- WorkbenchSettingsConfig,
45
- WorkbenchUserCommandDefinition,
46
- } from '@workbench-kit/workbench-config';
47
- import {
48
- DEFAULT_WORKBENCH_LAYOUT_STORAGE_KEY,
49
- isWorkbenchLayoutPersistenceAvailable,
50
- resolvePersistedWorkbenchLayout,
51
- writePersistedWorkbenchLayout,
52
- } from './workbench-layout-storage.js';
53
- import {
54
- DEFAULT_WORKBENCH_EDITOR_STATE_STORAGE_KEY,
55
- isWorkbenchEditorStatePersistenceAvailable,
56
- readPersistedEditorState,
57
- writePersistedEditorState,
58
- } from './editor-state-storage.js';
59
- import {
60
- DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
61
- isWorkbenchKeybindingPersistenceAvailable,
62
- readPersistedKeybindingOverrides,
63
- writePersistedKeybindingOverrides,
64
- } from './keybinding-overrides-storage.js';
65
- import {
66
- BUILTIN_EXPLORER_VIEW_CONTAINER_ID,
67
- publishExplorerRevealRequest,
68
- runExplorerHostCommandSideEffects,
69
- } from './explorer-reveal.js';
70
- import {
71
- BUILTIN_EXTENSIONS_FOCUS_COMMAND_ID,
72
- BUILTIN_EXTENSIONS_VIEW_CONTAINER_ID,
73
- } from './extensions-view-data.js';
74
- import {
75
- DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
76
- isWorkbenchLocalPreferencePersistenceAvailable,
77
- readPersistedLocalPreferences,
78
- writePersistedLocalPreferences,
79
- } from './preference-settings-storage.js';
80
- import { registerWorkbenchUserCommands } from './workbench-user-commands.js';
81
- import { EditorWorkspaceReconciler } from './editor-workspace-reconcile.js';
82
- import {
83
- DEFAULT_EDITOR_DOCUMENT_VIEW_PROVIDERS,
84
- type EditorDocumentViewProvider,
85
- } from './editor-view-providers.js';
86
- import type { EditorDocumentViewProviderRegistry } from '@workbench-kit/workbench-core';
87
-
88
- export interface WorkbenchWorkspaceHostPort extends WorkbenchEditorSavePort {
89
- readonly capabilityId?: string | undefined;
90
- readonly service?: unknown;
91
- dispose?(): void;
92
- }
93
-
94
- export type { WorkbenchStorageAdapter };
95
-
96
- const DEFAULT_AVAILABLE_EXTENSIONS = [
97
- ...BUILTIN_WORKBENCH_EXTENSIONS,
98
- ...SAMPLE_WORKBENCH_EXTENSIONS,
99
- ] as const;
100
-
101
- export interface WorkbenchProviderProps {
102
- availableExtensions?: readonly WorkbenchExtensionDescription[];
103
- children: ReactNode;
104
- contextKeyValues?: Readonly<Record<string, ContextKeyValue>> | undefined;
105
- documentViewProviders?: readonly EditorDocumentViewProvider[] | undefined;
106
- extensionsConfig?: WorkbenchExtensionsConfig;
107
- editorStateStorage?: WorkbenchStorageAdapter;
108
- editorStateStorageKey?: string;
109
- hostThemes?: readonly WorkbenchHostThemeRegistration[];
110
- initialKeybindingOverrides?: readonly WorkbenchKeybindingDefinition[];
111
- initialEditorState?: EditorState;
112
- initialLayout?: WorkbenchLayoutStateInput;
113
- initialWorkspaceSettings?: WorkbenchSettingsConfig;
114
- includeDefaultDocumentViewProviders?: boolean | undefined;
115
- installedExtensionsStorage?: WorkbenchStorageAdapter;
116
- installedExtensionsStorageKey?: string;
117
- keybindingOverridesStorage?: WorkbenchStorageAdapter;
118
- keybindingOverridesStorageKey?: string;
119
- layoutStorage?: WorkbenchStorageAdapter;
120
- layoutStorageKey?: string;
121
- localPreferenceStorage?: WorkbenchStorageAdapter;
122
- localPreferenceStorageKey?: string;
123
- onKeybindingOverridesChange?:
124
- ((overrides: readonly WorkbenchKeybindingDefinition[]) => void) | undefined;
125
- persistEditorState?: boolean;
126
- persistKeybindingOverrides?: boolean;
127
- persistLayout?: boolean;
128
- persistLocalPreferences?: boolean;
129
- userCommands?: readonly WorkbenchUserCommandDefinition[];
130
- workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
131
- }
132
-
133
- export interface WorkbenchContextValue {
134
- activateCommand(commandId: string): Promise<readonly { readonly extensionId: string }[]>;
135
- contextKeyService: ContextKeyService;
136
- editorDocumentViewProviders: EditorDocumentViewProviderRegistry;
137
- editorService: EditorService;
138
- executeCommand(commandId: string, ...args: unknown[]): Promise<unknown>;
139
- extensionRegistry: ExtensionRegistry;
140
- installedExtensionsStorage?: WorkbenchStorageAdapter;
141
- installedExtensionsStorageKey: string;
142
- keybindingOverrides: readonly WorkbenchKeybindingDefinition[];
143
- layoutService: LayoutService;
144
- missingExtensionIds: readonly string[];
145
- preferenceService: PreferenceServiceType;
146
- resetCommandKeybindingOverride(commandId: string): void;
147
- setCommandKeybindingOverride(commandId: string, key: string): void;
148
- waitForExtensionStartup(): Promise<void>;
149
- workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
150
- }
151
-
152
- interface WorkbenchProviderServices {
153
- activateStartup(): void;
154
- dispose(): void;
155
- editorDocumentViewProviders: EditorDocumentViewProviderRegistry;
156
- editorService: EditorService;
157
- extensionRegistry: ExtensionRegistry;
158
- layoutService: LayoutService;
159
- missingExtensionIds: readonly string[];
160
- preferenceService: PreferenceServiceType;
161
- waitForExtensionStartup(): Promise<void>;
162
- workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
163
- }
164
-
165
- interface DeferredProviderDispose {
166
- readonly services: WorkbenchProviderServices;
167
- readonly timeout: ReturnType<typeof setTimeout>;
168
- }
169
-
170
- const WorkbenchContext = createContext<WorkbenchContextValue | undefined>(undefined);
171
-
172
- export function WorkbenchProvider({
173
- availableExtensions,
174
- children,
175
- contextKeyValues,
176
- documentViewProviders,
177
- editorStateStorage,
178
- editorStateStorageKey = DEFAULT_WORKBENCH_EDITOR_STATE_STORAGE_KEY,
179
- extensionsConfig,
180
- hostThemes = [],
181
- initialEditorState,
182
- initialKeybindingOverrides,
183
- initialLayout,
184
- initialWorkspaceSettings,
185
- includeDefaultDocumentViewProviders,
186
- installedExtensionsStorage,
187
- installedExtensionsStorageKey = DEFAULT_INSTALLED_EXTENSIONS_STORAGE_KEY,
188
- keybindingOverridesStorage,
189
- keybindingOverridesStorageKey = DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
190
- layoutStorage,
191
- layoutStorageKey = DEFAULT_WORKBENCH_LAYOUT_STORAGE_KEY,
192
- localPreferenceStorage,
193
- localPreferenceStorageKey = DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
194
- onKeybindingOverridesChange,
195
- persistEditorState,
196
- persistKeybindingOverrides,
197
- persistLayout,
198
- persistLocalPreferences,
199
- userCommands = [],
200
- workspaceHostPort,
201
- }: WorkbenchProviderProps) {
202
- const hostAvailableExtensions = availableExtensions ?? DEFAULT_AVAILABLE_EXTENSIONS;
203
- const deferredDisposeRef = useRef<DeferredProviderDispose | undefined>(undefined);
204
- const shouldPersistEditorState =
205
- persistEditorState ??
206
- (editorStateStorage !== undefined || isWorkbenchEditorStatePersistenceAvailable());
207
- const shouldPersistKeybindingOverrides =
208
- persistKeybindingOverrides ??
209
- (keybindingOverridesStorage !== undefined || isWorkbenchKeybindingPersistenceAvailable());
210
- const shouldPersistLayout =
211
- persistLayout ?? (layoutStorage !== undefined || isWorkbenchLayoutPersistenceAvailable());
212
- const shouldPersistLocalPreferences =
213
- persistLocalPreferences ??
214
- (localPreferenceStorage !== undefined || isWorkbenchLocalPreferencePersistenceAvailable());
215
- const resolvedInitialLayout = useMemo(
216
- () =>
217
- resolvePersistedWorkbenchLayout(initialLayout, {
218
- persistLayout: shouldPersistLayout,
219
- storage: layoutStorage,
220
- storageKey: layoutStorageKey,
221
- }),
222
- [initialLayout, layoutStorage, layoutStorageKey, shouldPersistLayout],
223
- );
224
- const resolvedInitialEditorState = useMemo(
225
- () =>
226
- initialEditorState ??
227
- (shouldPersistEditorState
228
- ? readPersistedEditorState(editorStateStorageKey, editorStateStorage)
229
- : undefined),
230
- [editorStateStorage, editorStateStorageKey, initialEditorState, shouldPersistEditorState],
231
- );
232
- const resolvedInitialKeybindingOverrides = useMemo(
233
- () =>
234
- initialKeybindingOverrides ??
235
- (shouldPersistKeybindingOverrides
236
- ? readPersistedKeybindingOverrides(
237
- keybindingOverridesStorageKey,
238
- keybindingOverridesStorage,
239
- )
240
- : []),
241
- [
242
- initialKeybindingOverrides,
243
- keybindingOverridesStorage,
244
- keybindingOverridesStorageKey,
245
- shouldPersistKeybindingOverrides,
246
- ],
247
- );
248
- const [keybindingOverrides, setKeybindingOverridesState] = useState(
249
- resolvedInitialKeybindingOverrides,
250
- );
251
- const contextKeyService = useMemo(() => {
252
- const service = new ContextKeyService();
253
- for (const [key, value] of Object.entries(
254
- createWorkbenchPermissionContextKeys({ role: 'owner' }),
255
- )) {
256
- service.set(key, value);
257
- }
258
- return service;
259
- }, []);
260
-
261
- useEffect(() => {
262
- return () => {
263
- contextKeyService.dispose();
264
- };
265
- }, [contextKeyService]);
266
-
267
- useEffect(() => {
268
- if (contextKeyValues === undefined) {
269
- return;
270
- }
271
-
272
- for (const [key, value] of Object.entries(contextKeyValues)) {
273
- contextKeyService.set(key, value);
274
- }
275
- }, [contextKeyService, contextKeyValues]);
276
-
277
- useEffect(() => {
278
- setKeybindingOverridesState(resolvedInitialKeybindingOverrides);
279
- }, [resolvedInitialKeybindingOverrides]);
280
-
281
- const setCommandKeybindingOverride = useCallback((commandId: string, key: string) => {
282
- setKeybindingOverridesState((current) => {
283
- const without = current.filter((binding) => binding.command !== commandId);
284
- return [...without, { command: commandId, key }];
285
- });
286
- }, []);
287
-
288
- const resetCommandKeybindingOverride = useCallback((commandId: string) => {
289
- setKeybindingOverridesState((current) =>
290
- current.filter((binding) => binding.command !== commandId),
291
- );
292
- }, []);
293
-
294
- useEffect(() => {
295
- onKeybindingOverridesChange?.(keybindingOverrides);
296
- if (!shouldPersistKeybindingOverrides) {
297
- return;
298
- }
299
-
300
- writePersistedKeybindingOverrides(
301
- keybindingOverrides,
302
- keybindingOverridesStorageKey,
303
- keybindingOverridesStorage,
304
- );
305
- }, [
306
- keybindingOverrides,
307
- keybindingOverridesStorage,
308
- keybindingOverridesStorageKey,
309
- onKeybindingOverridesChange,
310
- shouldPersistKeybindingOverrides,
311
- ]);
312
-
313
- const resolvedInitialLocalPreferences = useMemo(
314
- () =>
315
- shouldPersistLocalPreferences
316
- ? readPersistedLocalPreferences(localPreferenceStorageKey, localPreferenceStorage)
317
- : {},
318
- [localPreferenceStorage, localPreferenceStorageKey, shouldPersistLocalPreferences],
319
- );
320
-
321
- const services = useMemo<WorkbenchProviderServices>(() => {
322
- const extensionRegistry = new ExtensionRegistry();
323
- const editorDocumentViewProviders = extensionRegistry.editorDocumentViews;
324
- const editorDocumentViewProviderDisposables = [
325
- ...(includeDefaultDocumentViewProviders === false
326
- ? []
327
- : DEFAULT_EDITOR_DOCUMENT_VIEW_PROVIDERS),
328
- ...(documentViewProviders ?? []),
329
- ].map((provider) => editorDocumentViewProviders.registerProvider(provider));
330
- const layoutService = new LayoutService(resolvedInitialLayout);
331
- const editorService = createEditorService({
332
- editorHostFactories: extensionRegistry.editorHostFactories,
333
- editorResolvers: extensionRegistry.editorResolvers,
334
- initialState: resolvedInitialEditorState,
335
- resolveEditorResource: workspaceHostPort?.resolveResource?.bind(workspaceHostPort),
336
- });
337
- const installedRecords = loadInstalledExtensions(
338
- installedExtensionsStorageKey,
339
- installedExtensionsStorage,
340
- );
341
- const resolvedAvailableExtensions =
342
- availableExtensions === undefined
343
- ? resolveInstalledAvailableExtensions(hostAvailableExtensions, installedRecords)
344
- : hostAvailableExtensions;
345
- const config = mergeExtensionsConfigWithInstallState(
346
- extensionsConfig ??
347
- ({
348
- enabled: resolvedAvailableExtensions.map(({ manifest }) => manifest.id),
349
- recommendations: [],
350
- } satisfies WorkbenchExtensionsConfig),
351
- installedRecords,
352
- );
353
- const resolution = resolveWorkbenchExtensions(config, resolvedAvailableExtensions);
354
- const extensionDisposables = extensionRegistry.registerExtensions(resolution.enabledExtensions);
355
- const hostThemeDisposables = registerHostWorkbenchThemes(extensionRegistry.themes, hostThemes);
356
- const editorServiceCapabilityDisposable = extensionRegistry.capabilityRegistry.register({
357
- id: WORKBENCH_EDITOR_SERVICE_CAPABILITY_ID,
358
- get: () => editorService,
359
- });
360
- const workspaceHostCapabilityDisposable =
361
- workspaceHostPort?.capabilityId && workspaceHostPort.service !== undefined
362
- ? extensionRegistry.capabilityRegistry.register({
363
- id: workspaceHostPort.capabilityId,
364
- get: () => workspaceHostPort.service,
365
- dispose: workspaceHostPort.dispose,
366
- })
367
- : undefined;
368
- const saveCommandDisposable = workspaceHostPort
369
- ? registerEditorSaveCommand(extensionRegistry.commands, {
370
- editorSavePort: workspaceHostPort,
371
- editorService,
372
- })
373
- : undefined;
374
- const userCommandDisposables = registerWorkbenchUserCommands(extensionRegistry, userCommands);
375
- const preferenceService = new PreferenceService({
376
- contributionDefaults: collectConfigurationDefaults(
377
- extensionRegistry.configurations.getConfigurations(),
378
- ),
379
- initialValuesByScope: {
380
- local: resolvedInitialLocalPreferences,
381
- workspace: initialWorkspaceSettings ?? {},
382
- },
383
- });
384
- let startupActivation: Promise<readonly { readonly extensionId: string }[]> | undefined;
385
- const ensureStartupActivation = () => {
386
- startupActivation ??= extensionRegistry.activateStartup();
387
- return startupActivation;
388
- };
389
-
390
- return {
391
- activateStartup: () => {
392
- void ensureStartupActivation();
393
- },
394
- dispose: () => {
395
- saveCommandDisposable?.dispose();
396
- userCommandDisposables.dispose();
397
- editorServiceCapabilityDisposable.dispose();
398
- workspaceHostCapabilityDisposable?.dispose();
399
- hostThemeDisposables.dispose();
400
- extensionDisposables.dispose();
401
- if (!workspaceHostCapabilityDisposable) {
402
- workspaceHostPort?.dispose?.();
403
- }
404
- editorService.dispose();
405
- for (const disposable of editorDocumentViewProviderDisposables) {
406
- disposable.dispose();
407
- }
408
- extensionRegistry.dispose();
409
- layoutService.dispose();
410
- preferenceService.dispose();
411
- },
412
- editorDocumentViewProviders,
413
- editorService,
414
- extensionRegistry,
415
- layoutService,
416
- missingExtensionIds: resolution.missingExtensionIds,
417
- preferenceService,
418
- waitForExtensionStartup: () => ensureStartupActivation().then(() => undefined),
419
- workspaceHostPort,
420
- };
421
- }, [
422
- availableExtensions,
423
- documentViewProviders,
424
- hostAvailableExtensions,
425
- extensionsConfig,
426
- hostThemes,
427
- includeDefaultDocumentViewProviders,
428
- initialWorkspaceSettings,
429
- installedExtensionsStorage,
430
- installedExtensionsStorageKey,
431
- resolvedInitialEditorState,
432
- resolvedInitialLayout,
433
- resolvedInitialLocalPreferences,
434
- userCommands,
435
- workspaceHostPort,
436
- ]);
437
-
438
- useEffect(() => {
439
- if (!shouldPersistLayout) {
440
- return undefined;
441
- }
442
-
443
- const disposable = services.layoutService.onDidChangeLayout(({ state }) => {
444
- writePersistedWorkbenchLayout(state, layoutStorageKey, layoutStorage);
445
- });
446
-
447
- return () => {
448
- disposable.dispose();
449
- };
450
- }, [layoutStorage, layoutStorageKey, services.layoutService, shouldPersistLayout]);
451
-
452
- useEffect(() => {
453
- if (!shouldPersistEditorState) {
454
- return undefined;
455
- }
456
-
457
- const disposable = services.editorService.onDidChangeEditors(({ state }) => {
458
- writePersistedEditorState(state, editorStateStorageKey, editorStateStorage);
459
- });
460
-
461
- return () => {
462
- disposable.dispose();
463
- };
464
- }, [editorStateStorage, editorStateStorageKey, services.editorService, shouldPersistEditorState]);
465
-
466
- useEffect(() => {
467
- if (!shouldPersistLocalPreferences) {
468
- return undefined;
469
- }
470
-
471
- const disposable = services.preferenceService.onDidChangePreference((event) => {
472
- if (event.scope !== 'local') {
473
- return;
474
- }
475
-
476
- writePersistedLocalPreferences(
477
- services.preferenceService.getScopedValues('local'),
478
- localPreferenceStorageKey,
479
- localPreferenceStorage,
480
- );
481
- });
482
-
483
- return () => {
484
- disposable.dispose();
485
- };
486
- }, [
487
- localPreferenceStorage,
488
- localPreferenceStorageKey,
489
- services.preferenceService,
490
- shouldPersistLocalPreferences,
491
- ]);
492
-
493
- useEffect(() => {
494
- const deferredDispose = deferredDisposeRef.current;
495
- if (deferredDispose?.services === services) {
496
- clearTimeout(deferredDispose.timeout);
497
- deferredDisposeRef.current = undefined;
498
- }
499
-
500
- services.activateStartup();
501
-
502
- return () => {
503
- const timeout = setTimeout(() => {
504
- if (deferredDisposeRef.current?.services === services) {
505
- deferredDisposeRef.current = undefined;
506
- }
507
- services.dispose();
508
- }, 0);
509
-
510
- deferredDisposeRef.current = { services, timeout };
511
- };
512
- }, [services]);
513
-
514
- const value = useMemo<WorkbenchContextValue>(
515
- () => ({
516
- activateCommand: (commandId) => services.extensionRegistry.activateCommand(commandId),
517
- contextKeyService,
518
- editorDocumentViewProviders: services.editorDocumentViewProviders,
519
- editorService: services.editorService,
520
- executeCommand: async (commandId, ...args) => {
521
- const result = await services.extensionRegistry.executeCommand(commandId, ...args);
522
- await runExplorerHostCommandSideEffects(commandId, args, result, {
523
- focusExplorerView: () => {
524
- services.layoutService.setActiveViewContainer(BUILTIN_EXPLORER_VIEW_CONTAINER_ID);
525
- services.layoutService.setSideBarVisible(true);
526
- },
527
- revealPath: publishExplorerRevealRequest,
528
- });
529
- if (commandId === BUILTIN_EXTENSIONS_FOCUS_COMMAND_ID) {
530
- services.layoutService.setActiveViewContainer(BUILTIN_EXTENSIONS_VIEW_CONTAINER_ID);
531
- services.layoutService.setSideBarVisible(true);
532
- }
533
- return result;
534
- },
535
- extensionRegistry: services.extensionRegistry,
536
- installedExtensionsStorage,
537
- installedExtensionsStorageKey,
538
- keybindingOverrides,
539
- layoutService: services.layoutService,
540
- missingExtensionIds: services.missingExtensionIds,
541
- preferenceService: services.preferenceService,
542
- resetCommandKeybindingOverride,
543
- setCommandKeybindingOverride,
544
- waitForExtensionStartup: services.waitForExtensionStartup,
545
- workspaceHostPort: services.workspaceHostPort,
546
- }),
547
- [
548
- contextKeyService,
549
- installedExtensionsStorage,
550
- installedExtensionsStorageKey,
551
- keybindingOverrides,
552
- resetCommandKeybindingOverride,
553
- services,
554
- setCommandKeybindingOverride,
555
- ],
556
- );
557
-
558
- return (
559
- <WorkbenchContext.Provider value={value}>
560
- <EditorWorkspaceReconciler />
561
- {children}
562
- </WorkbenchContext.Provider>
563
- );
564
- }
565
-
566
- export function useWorkbench(): WorkbenchContextValue {
567
- const value = useContext(WorkbenchContext);
568
- if (!value) {
569
- throw new Error('useWorkbench must be used inside WorkbenchProvider.');
570
- }
571
-
572
- return value;
573
- }
1
+ import {
2
+ createContext,
3
+ useCallback,
4
+ useContext,
5
+ useEffect,
6
+ useMemo,
7
+ useRef,
8
+ useState,
9
+ type ReactNode,
10
+ } from 'react';
11
+ import {
12
+ BUILTIN_WORKBENCH_EXTENSIONS,
13
+ collectConfigurationDefaults,
14
+ createEditorService,
15
+ ExtensionRegistry,
16
+ LayoutService,
17
+ loadInstalledExtensions,
18
+ mergeExtensionsConfigWithInstallState,
19
+ PreferenceService,
20
+ registerEditorSaveCommand,
21
+ registerHostWorkbenchThemes,
22
+ resolveInstalledAvailableExtensions,
23
+ resolveWorkbenchExtensions,
24
+ SAMPLE_WORKBENCH_EXTENSIONS,
25
+ DEFAULT_INSTALLED_EXTENSIONS_STORAGE_KEY,
26
+ WORKBENCH_EDITOR_SERVICE_CAPABILITY_ID,
27
+ verifyWorkbenchExtensionsAgainstLock,
28
+ type EditorState,
29
+ type EditorService,
30
+ type ExtensionIntegrityMode,
31
+ type PreferenceService as PreferenceServiceType,
32
+ type WorkbenchHostThemeRegistration,
33
+ type WorkbenchStorageAdapter,
34
+ type WorkbenchEditorSavePort,
35
+ type WorkbenchExtensionDescription,
36
+ type WorkbenchLayoutStateInput,
37
+ } from '@workbench-kit/workbench-core';
38
+ import {
39
+ ContextKeyService,
40
+ createWorkbenchPermissionContextKeys,
41
+ type ContextKeyValue,
42
+ } from '@workbench-kit/platform';
43
+ import type {
44
+ WorkbenchExtensionsConfig,
45
+ WorkbenchExtensionsLock,
46
+ WorkbenchKeybindingDefinition,
47
+ WorkbenchSettingsConfig,
48
+ WorkbenchUserCommandDefinition,
49
+ } from '@workbench-kit/workbench-config';
50
+ import {
51
+ DEFAULT_WORKBENCH_LAYOUT_STORAGE_KEY,
52
+ isWorkbenchLayoutPersistenceAvailable,
53
+ resolvePersistedWorkbenchLayout,
54
+ writePersistedWorkbenchLayout,
55
+ } from '../workbench/layout-storage.js';
56
+ import {
57
+ DEFAULT_WORKBENCH_EDITOR_STATE_STORAGE_KEY,
58
+ isWorkbenchEditorStatePersistenceAvailable,
59
+ readPersistedEditorState,
60
+ writePersistedEditorState,
61
+ } from '../editor/state-storage.js';
62
+ import {
63
+ DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
64
+ isWorkbenchKeybindingPersistenceAvailable,
65
+ readPersistedKeybindingOverrides,
66
+ writePersistedKeybindingOverrides,
67
+ } from '../management/keybinding-overrides-storage.js';
68
+ import {
69
+ BUILTIN_EXPLORER_VIEW_CONTAINER_ID,
70
+ publishExplorerRevealRequest,
71
+ runExplorerHostCommandSideEffects,
72
+ } from '../explorer/reveal.js';
73
+ import {
74
+ BUILTIN_EXTENSIONS_FOCUS_COMMAND_ID,
75
+ BUILTIN_EXTENSIONS_VIEW_CONTAINER_ID,
76
+ } from '../extensions/view-data.js';
77
+ import {
78
+ DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
79
+ isWorkbenchLocalPreferencePersistenceAvailable,
80
+ readPersistedLocalPreferences,
81
+ writePersistedLocalPreferences,
82
+ } from '../management/preference-settings-storage.js';
83
+ import { registerWorkbenchUserCommands } from '../workbench/user-commands.js';
84
+ import { EditorWorkspaceReconciler } from '../editor/workspace-reconcile.js';
85
+ import {
86
+ DEFAULT_EDITOR_DOCUMENT_VIEW_PROVIDERS,
87
+ type EditorDocumentViewProvider,
88
+ } from '../editor/view-providers.js';
89
+ import type { EditorDocumentViewProviderRegistry } from '@workbench-kit/workbench-core';
90
+
91
+ export interface WorkbenchWorkspaceHostPort extends WorkbenchEditorSavePort {
92
+ readonly capabilityId?: string | undefined;
93
+ readonly service?: unknown;
94
+ dispose?(): void;
95
+ }
96
+
97
+ export type { WorkbenchStorageAdapter };
98
+
99
+ const DEFAULT_AVAILABLE_EXTENSIONS = [
100
+ ...BUILTIN_WORKBENCH_EXTENSIONS,
101
+ ...SAMPLE_WORKBENCH_EXTENSIONS,
102
+ ] as const;
103
+
104
+ export interface WorkbenchProviderProps {
105
+ availableExtensions?: readonly WorkbenchExtensionDescription[];
106
+ children: ReactNode;
107
+ contextKeyValues?: Readonly<Record<string, ContextKeyValue>> | undefined;
108
+ documentViewProviders?: readonly EditorDocumentViewProvider[] | undefined;
109
+ /**
110
+ * When set with `extensionIntegrityMode` other than `off`, enabled extensions
111
+ * are checked against the lock before registration.
112
+ */
113
+ extensionsLock?: WorkbenchExtensionsLock | undefined;
114
+ /**
115
+ * Lock verification mode. Default `off` preserves existing hosts.
116
+ * Sample hosts may opt into `fail-closed`.
117
+ */
118
+ extensionIntegrityMode?: ExtensionIntegrityMode | undefined;
119
+ extensionsConfig?: WorkbenchExtensionsConfig;
120
+ editorStateStorage?: WorkbenchStorageAdapter;
121
+ editorStateStorageKey?: string;
122
+ hostThemes?: readonly WorkbenchHostThemeRegistration[];
123
+ initialKeybindingOverrides?: readonly WorkbenchKeybindingDefinition[];
124
+ initialEditorState?: EditorState;
125
+ initialLayout?: WorkbenchLayoutStateInput;
126
+ initialWorkspaceSettings?: WorkbenchSettingsConfig;
127
+ includeDefaultDocumentViewProviders?: boolean | undefined;
128
+ installedExtensionsStorage?: WorkbenchStorageAdapter;
129
+ installedExtensionsStorageKey?: string;
130
+ keybindingOverridesStorage?: WorkbenchStorageAdapter;
131
+ keybindingOverridesStorageKey?: string;
132
+ layoutStorage?: WorkbenchStorageAdapter;
133
+ layoutStorageKey?: string;
134
+ localPreferenceStorage?: WorkbenchStorageAdapter;
135
+ localPreferenceStorageKey?: string;
136
+ onKeybindingOverridesChange?:
137
+ ((overrides: readonly WorkbenchKeybindingDefinition[]) => void) | undefined;
138
+ persistEditorState?: boolean;
139
+ persistKeybindingOverrides?: boolean;
140
+ persistLayout?: boolean;
141
+ persistLocalPreferences?: boolean;
142
+ userCommands?: readonly WorkbenchUserCommandDefinition[];
143
+ workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
144
+ }
145
+
146
+ export interface WorkbenchContextValue {
147
+ activateCommand(commandId: string): Promise<readonly { readonly extensionId: string }[]>;
148
+ contextKeyService: ContextKeyService;
149
+ editorDocumentViewProviders: EditorDocumentViewProviderRegistry;
150
+ editorService: EditorService;
151
+ executeCommand(commandId: string, ...args: unknown[]): Promise<unknown>;
152
+ extensionRegistry: ExtensionRegistry;
153
+ installedExtensionsStorage?: WorkbenchStorageAdapter;
154
+ installedExtensionsStorageKey: string;
155
+ keybindingOverrides: readonly WorkbenchKeybindingDefinition[];
156
+ layoutService: LayoutService;
157
+ missingExtensionIds: readonly string[];
158
+ preferenceService: PreferenceServiceType;
159
+ resetCommandKeybindingOverride(commandId: string): void;
160
+ setCommandKeybindingOverride(commandId: string, key: string): void;
161
+ waitForExtensionStartup(): Promise<void>;
162
+ workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
163
+ }
164
+
165
+ interface WorkbenchProviderServices {
166
+ activateStartup(): void;
167
+ dispose(): void;
168
+ editorDocumentViewProviders: EditorDocumentViewProviderRegistry;
169
+ editorService: EditorService;
170
+ extensionRegistry: ExtensionRegistry;
171
+ layoutService: LayoutService;
172
+ missingExtensionIds: readonly string[];
173
+ preferenceService: PreferenceServiceType;
174
+ waitForExtensionStartup(): Promise<void>;
175
+ workspaceHostPort?: WorkbenchWorkspaceHostPort | undefined;
176
+ }
177
+
178
+ interface DeferredProviderDispose {
179
+ readonly services: WorkbenchProviderServices;
180
+ readonly timeout: ReturnType<typeof setTimeout>;
181
+ }
182
+
183
+ const WorkbenchContext = createContext<WorkbenchContextValue | undefined>(undefined);
184
+
185
+ export function WorkbenchProvider({
186
+ availableExtensions,
187
+ children,
188
+ contextKeyValues,
189
+ documentViewProviders,
190
+ editorStateStorage,
191
+ editorStateStorageKey = DEFAULT_WORKBENCH_EDITOR_STATE_STORAGE_KEY,
192
+ extensionIntegrityMode = 'off',
193
+ extensionsConfig,
194
+ extensionsLock,
195
+ hostThemes = [],
196
+ initialEditorState,
197
+ initialKeybindingOverrides,
198
+ initialLayout,
199
+ initialWorkspaceSettings,
200
+ includeDefaultDocumentViewProviders,
201
+ installedExtensionsStorage,
202
+ installedExtensionsStorageKey = DEFAULT_INSTALLED_EXTENSIONS_STORAGE_KEY,
203
+ keybindingOverridesStorage,
204
+ keybindingOverridesStorageKey = DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
205
+ layoutStorage,
206
+ layoutStorageKey = DEFAULT_WORKBENCH_LAYOUT_STORAGE_KEY,
207
+ localPreferenceStorage,
208
+ localPreferenceStorageKey = DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
209
+ onKeybindingOverridesChange,
210
+ persistEditorState,
211
+ persistKeybindingOverrides,
212
+ persistLayout,
213
+ persistLocalPreferences,
214
+ userCommands = [],
215
+ workspaceHostPort,
216
+ }: WorkbenchProviderProps) {
217
+ const hostAvailableExtensions = availableExtensions ?? DEFAULT_AVAILABLE_EXTENSIONS;
218
+ const deferredDisposeRef = useRef<DeferredProviderDispose | undefined>(undefined);
219
+ const shouldPersistEditorState =
220
+ persistEditorState ??
221
+ (editorStateStorage !== undefined || isWorkbenchEditorStatePersistenceAvailable());
222
+ const shouldPersistKeybindingOverrides =
223
+ persistKeybindingOverrides ??
224
+ (keybindingOverridesStorage !== undefined || isWorkbenchKeybindingPersistenceAvailable());
225
+ const shouldPersistLayout =
226
+ persistLayout ?? (layoutStorage !== undefined || isWorkbenchLayoutPersistenceAvailable());
227
+ const shouldPersistLocalPreferences =
228
+ persistLocalPreferences ??
229
+ (localPreferenceStorage !== undefined || isWorkbenchLocalPreferencePersistenceAvailable());
230
+ const resolvedInitialLayout = useMemo(
231
+ () =>
232
+ resolvePersistedWorkbenchLayout(initialLayout, {
233
+ persistLayout: shouldPersistLayout,
234
+ storage: layoutStorage,
235
+ storageKey: layoutStorageKey,
236
+ }),
237
+ [initialLayout, layoutStorage, layoutStorageKey, shouldPersistLayout],
238
+ );
239
+ const resolvedInitialEditorState = useMemo(
240
+ () =>
241
+ initialEditorState ??
242
+ (shouldPersistEditorState
243
+ ? readPersistedEditorState(editorStateStorageKey, editorStateStorage)
244
+ : undefined),
245
+ [editorStateStorage, editorStateStorageKey, initialEditorState, shouldPersistEditorState],
246
+ );
247
+ const resolvedInitialKeybindingOverrides = useMemo(
248
+ () =>
249
+ initialKeybindingOverrides ??
250
+ (shouldPersistKeybindingOverrides
251
+ ? readPersistedKeybindingOverrides(
252
+ keybindingOverridesStorageKey,
253
+ keybindingOverridesStorage,
254
+ )
255
+ : []),
256
+ [
257
+ initialKeybindingOverrides,
258
+ keybindingOverridesStorage,
259
+ keybindingOverridesStorageKey,
260
+ shouldPersistKeybindingOverrides,
261
+ ],
262
+ );
263
+ const [keybindingOverrides, setKeybindingOverridesState] = useState(
264
+ resolvedInitialKeybindingOverrides,
265
+ );
266
+ const contextKeyService = useMemo(() => {
267
+ const service = new ContextKeyService();
268
+ for (const [key, value] of Object.entries(
269
+ createWorkbenchPermissionContextKeys({ role: 'owner' }),
270
+ )) {
271
+ service.set(key, value);
272
+ }
273
+ return service;
274
+ }, []);
275
+
276
+ useEffect(() => {
277
+ return () => {
278
+ contextKeyService.dispose();
279
+ };
280
+ }, [contextKeyService]);
281
+
282
+ useEffect(() => {
283
+ if (contextKeyValues === undefined) {
284
+ return;
285
+ }
286
+
287
+ for (const [key, value] of Object.entries(contextKeyValues)) {
288
+ contextKeyService.set(key, value);
289
+ }
290
+ }, [contextKeyService, contextKeyValues]);
291
+
292
+ useEffect(() => {
293
+ setKeybindingOverridesState(resolvedInitialKeybindingOverrides);
294
+ }, [resolvedInitialKeybindingOverrides]);
295
+
296
+ const setCommandKeybindingOverride = useCallback((commandId: string, key: string) => {
297
+ setKeybindingOverridesState((current) => {
298
+ const without = current.filter((binding) => binding.command !== commandId);
299
+ return [...without, { command: commandId, key }];
300
+ });
301
+ }, []);
302
+
303
+ const resetCommandKeybindingOverride = useCallback((commandId: string) => {
304
+ setKeybindingOverridesState((current) =>
305
+ current.filter((binding) => binding.command !== commandId),
306
+ );
307
+ }, []);
308
+
309
+ useEffect(() => {
310
+ onKeybindingOverridesChange?.(keybindingOverrides);
311
+ if (!shouldPersistKeybindingOverrides) {
312
+ return;
313
+ }
314
+
315
+ writePersistedKeybindingOverrides(
316
+ keybindingOverrides,
317
+ keybindingOverridesStorageKey,
318
+ keybindingOverridesStorage,
319
+ );
320
+ }, [
321
+ keybindingOverrides,
322
+ keybindingOverridesStorage,
323
+ keybindingOverridesStorageKey,
324
+ onKeybindingOverridesChange,
325
+ shouldPersistKeybindingOverrides,
326
+ ]);
327
+
328
+ const resolvedInitialLocalPreferences = useMemo(
329
+ () =>
330
+ shouldPersistLocalPreferences
331
+ ? readPersistedLocalPreferences(localPreferenceStorageKey, localPreferenceStorage)
332
+ : {},
333
+ [localPreferenceStorage, localPreferenceStorageKey, shouldPersistLocalPreferences],
334
+ );
335
+
336
+ const services = useMemo<WorkbenchProviderServices>(() => {
337
+ const extensionRegistry = new ExtensionRegistry();
338
+ const editorDocumentViewProviders = extensionRegistry.editorDocumentViews;
339
+ const editorDocumentViewProviderDisposables = [
340
+ ...(includeDefaultDocumentViewProviders === false
341
+ ? []
342
+ : DEFAULT_EDITOR_DOCUMENT_VIEW_PROVIDERS),
343
+ ...(documentViewProviders ?? []),
344
+ ].map((provider) => editorDocumentViewProviders.registerProvider(provider));
345
+ const layoutService = new LayoutService(resolvedInitialLayout);
346
+ const editorService = createEditorService({
347
+ editorHostFactories: extensionRegistry.editorHostFactories,
348
+ editorResolvers: extensionRegistry.editorResolvers,
349
+ initialState: resolvedInitialEditorState,
350
+ resolveEditorResource: workspaceHostPort?.resolveResource?.bind(workspaceHostPort),
351
+ });
352
+ const installedRecords = loadInstalledExtensions(
353
+ installedExtensionsStorageKey,
354
+ installedExtensionsStorage,
355
+ );
356
+ const resolvedAvailableExtensions =
357
+ availableExtensions === undefined
358
+ ? resolveInstalledAvailableExtensions(hostAvailableExtensions, installedRecords)
359
+ : hostAvailableExtensions;
360
+ const config = mergeExtensionsConfigWithInstallState(
361
+ extensionsConfig ??
362
+ ({
363
+ enabled: resolvedAvailableExtensions.map(({ manifest }) => manifest.id),
364
+ recommendations: [],
365
+ } satisfies WorkbenchExtensionsConfig),
366
+ installedRecords,
367
+ );
368
+ const resolution = resolveWorkbenchExtensions(config, resolvedAvailableExtensions);
369
+ const integrity = verifyWorkbenchExtensionsAgainstLock(
370
+ resolution.enabledExtensions,
371
+ extensionsLock,
372
+ extensionIntegrityMode,
373
+ );
374
+ if (integrity.diagnostics.length > 0 && typeof console !== 'undefined') {
375
+ for (const diagnostic of integrity.diagnostics) {
376
+ console.warn(`[workbench-kit] ${diagnostic.message}`);
377
+ }
378
+ }
379
+ const extensionDisposables = extensionRegistry.registerExtensions(integrity.accepted);
380
+ const hostThemeDisposables = registerHostWorkbenchThemes(extensionRegistry.themes, hostThemes);
381
+ const editorServiceCapabilityDisposable = extensionRegistry.capabilityRegistry.register({
382
+ id: WORKBENCH_EDITOR_SERVICE_CAPABILITY_ID,
383
+ get: () => editorService,
384
+ });
385
+ const workspaceHostCapabilityDisposable =
386
+ workspaceHostPort?.capabilityId && workspaceHostPort.service !== undefined
387
+ ? extensionRegistry.capabilityRegistry.register({
388
+ id: workspaceHostPort.capabilityId,
389
+ get: () => workspaceHostPort.service,
390
+ dispose: workspaceHostPort.dispose,
391
+ })
392
+ : undefined;
393
+ const saveCommandDisposable = workspaceHostPort
394
+ ? registerEditorSaveCommand(extensionRegistry.commands, {
395
+ editorSavePort: workspaceHostPort,
396
+ editorService,
397
+ })
398
+ : undefined;
399
+ const userCommandDisposables = registerWorkbenchUserCommands(extensionRegistry, userCommands);
400
+ const preferenceService = new PreferenceService({
401
+ contributionDefaults: collectConfigurationDefaults(
402
+ extensionRegistry.configurations.getConfigurations(),
403
+ ),
404
+ initialValuesByScope: {
405
+ local: resolvedInitialLocalPreferences,
406
+ workspace: initialWorkspaceSettings ?? {},
407
+ },
408
+ });
409
+ let startupActivation: Promise<readonly { readonly extensionId: string }[]> | undefined;
410
+ const ensureStartupActivation = () => {
411
+ startupActivation ??= extensionRegistry.activateStartup();
412
+ return startupActivation;
413
+ };
414
+
415
+ return {
416
+ activateStartup: () => {
417
+ void ensureStartupActivation();
418
+ },
419
+ dispose: () => {
420
+ saveCommandDisposable?.dispose();
421
+ userCommandDisposables.dispose();
422
+ editorServiceCapabilityDisposable.dispose();
423
+ workspaceHostCapabilityDisposable?.dispose();
424
+ hostThemeDisposables.dispose();
425
+ extensionDisposables.dispose();
426
+ if (!workspaceHostCapabilityDisposable) {
427
+ workspaceHostPort?.dispose?.();
428
+ }
429
+ editorService.dispose();
430
+ for (const disposable of editorDocumentViewProviderDisposables) {
431
+ disposable.dispose();
432
+ }
433
+ extensionRegistry.dispose();
434
+ layoutService.dispose();
435
+ preferenceService.dispose();
436
+ },
437
+ editorDocumentViewProviders,
438
+ editorService,
439
+ extensionRegistry,
440
+ layoutService,
441
+ missingExtensionIds: [
442
+ ...resolution.missingExtensionIds,
443
+ ...integrity.rejected.map((extension) => extension.manifest.id),
444
+ ],
445
+ preferenceService,
446
+ waitForExtensionStartup: () => ensureStartupActivation().then(() => undefined),
447
+ workspaceHostPort,
448
+ };
449
+ }, [
450
+ availableExtensions,
451
+ documentViewProviders,
452
+ extensionIntegrityMode,
453
+ extensionsLock,
454
+ hostAvailableExtensions,
455
+ extensionsConfig,
456
+ hostThemes,
457
+ includeDefaultDocumentViewProviders,
458
+ initialWorkspaceSettings,
459
+ installedExtensionsStorage,
460
+ installedExtensionsStorageKey,
461
+ resolvedInitialEditorState,
462
+ resolvedInitialLayout,
463
+ resolvedInitialLocalPreferences,
464
+ userCommands,
465
+ workspaceHostPort,
466
+ ]);
467
+
468
+ useEffect(() => {
469
+ if (!shouldPersistLayout) {
470
+ return undefined;
471
+ }
472
+
473
+ const disposable = services.layoutService.onDidChangeLayout(({ state }) => {
474
+ writePersistedWorkbenchLayout(state, layoutStorageKey, layoutStorage);
475
+ });
476
+
477
+ return () => {
478
+ disposable.dispose();
479
+ };
480
+ }, [layoutStorage, layoutStorageKey, services.layoutService, shouldPersistLayout]);
481
+
482
+ useEffect(() => {
483
+ if (!shouldPersistEditorState) {
484
+ return undefined;
485
+ }
486
+
487
+ const disposable = services.editorService.onDidChangeEditors(({ state }) => {
488
+ writePersistedEditorState(state, editorStateStorageKey, editorStateStorage);
489
+ });
490
+
491
+ return () => {
492
+ disposable.dispose();
493
+ };
494
+ }, [editorStateStorage, editorStateStorageKey, services.editorService, shouldPersistEditorState]);
495
+
496
+ useEffect(() => {
497
+ if (!shouldPersistLocalPreferences) {
498
+ return undefined;
499
+ }
500
+
501
+ const disposable = services.preferenceService.onDidChangePreference((event) => {
502
+ if (event.scope !== 'local') {
503
+ return;
504
+ }
505
+
506
+ writePersistedLocalPreferences(
507
+ services.preferenceService.getScopedValues('local'),
508
+ localPreferenceStorageKey,
509
+ localPreferenceStorage,
510
+ );
511
+ });
512
+
513
+ return () => {
514
+ disposable.dispose();
515
+ };
516
+ }, [
517
+ localPreferenceStorage,
518
+ localPreferenceStorageKey,
519
+ services.preferenceService,
520
+ shouldPersistLocalPreferences,
521
+ ]);
522
+
523
+ useEffect(() => {
524
+ const deferredDispose = deferredDisposeRef.current;
525
+ if (deferredDispose?.services === services) {
526
+ clearTimeout(deferredDispose.timeout);
527
+ deferredDisposeRef.current = undefined;
528
+ }
529
+
530
+ services.activateStartup();
531
+
532
+ return () => {
533
+ const timeout = setTimeout(() => {
534
+ if (deferredDisposeRef.current?.services === services) {
535
+ deferredDisposeRef.current = undefined;
536
+ }
537
+ services.dispose();
538
+ }, 0);
539
+
540
+ deferredDisposeRef.current = { services, timeout };
541
+ };
542
+ }, [services]);
543
+
544
+ const value = useMemo<WorkbenchContextValue>(
545
+ () => ({
546
+ activateCommand: (commandId) => services.extensionRegistry.activateCommand(commandId),
547
+ contextKeyService,
548
+ editorDocumentViewProviders: services.editorDocumentViewProviders,
549
+ editorService: services.editorService,
550
+ executeCommand: async (commandId, ...args) => {
551
+ const result = await services.extensionRegistry.executeCommand(commandId, ...args);
552
+ await runExplorerHostCommandSideEffects(commandId, args, result, {
553
+ focusExplorerView: () => {
554
+ services.layoutService.setActiveViewContainer(BUILTIN_EXPLORER_VIEW_CONTAINER_ID);
555
+ services.layoutService.setSideBarVisible(true);
556
+ },
557
+ revealPath: publishExplorerRevealRequest,
558
+ });
559
+ if (commandId === BUILTIN_EXTENSIONS_FOCUS_COMMAND_ID) {
560
+ services.layoutService.setActiveViewContainer(BUILTIN_EXTENSIONS_VIEW_CONTAINER_ID);
561
+ services.layoutService.setSideBarVisible(true);
562
+ }
563
+ return result;
564
+ },
565
+ extensionRegistry: services.extensionRegistry,
566
+ installedExtensionsStorage,
567
+ installedExtensionsStorageKey,
568
+ keybindingOverrides,
569
+ layoutService: services.layoutService,
570
+ missingExtensionIds: services.missingExtensionIds,
571
+ preferenceService: services.preferenceService,
572
+ resetCommandKeybindingOverride,
573
+ setCommandKeybindingOverride,
574
+ waitForExtensionStartup: services.waitForExtensionStartup,
575
+ workspaceHostPort: services.workspaceHostPort,
576
+ }),
577
+ [
578
+ contextKeyService,
579
+ installedExtensionsStorage,
580
+ installedExtensionsStorageKey,
581
+ keybindingOverrides,
582
+ resetCommandKeybindingOverride,
583
+ services,
584
+ setCommandKeybindingOverride,
585
+ ],
586
+ );
587
+
588
+ return (
589
+ <WorkbenchContext.Provider value={value}>
590
+ <EditorWorkspaceReconciler />
591
+ {children}
592
+ </WorkbenchContext.Provider>
593
+ );
594
+ }
595
+
596
+ export function useWorkbench(): WorkbenchContextValue {
597
+ const value = useContext(WorkbenchContext);
598
+ if (!value) {
599
+ throw new Error('useWorkbench must be used inside WorkbenchProvider.');
600
+ }
601
+
602
+ return value;
603
+ }