-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
index.ts
330 lines (307 loc) · 9.86 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
/**
* @packageDocumentation
* @module lsp-extension
*/
import {
JupyterFrontEnd,
JupyterFrontEndPlugin,
LabShell
} from '@jupyterlab/application';
import {
CodeExtractorsManager,
DocumentConnectionManager,
FeatureManager,
ILSPCodeExtractorsManager,
ILSPConnection,
ILSPDocumentConnectionManager,
ILSPFeatureManager,
IWidgetLSPAdapterTracker,
LanguageServerManager,
LanguageServersExperimental,
TextForeignCodeExtractor,
TLanguageServerConfigurations,
TLanguageServerId,
WidgetLSPAdapterTracker
} from '@jupyterlab/lsp';
import { IRunningSessionManagers, IRunningSessions } from '@jupyterlab/running';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
import { ITranslator } from '@jupyterlab/translation';
import {
IFormRenderer,
IFormRendererRegistry,
LabIcon,
pythonIcon
} from '@jupyterlab/ui-components';
import { PartialJSONObject } from '@lumino/coreutils';
import { Signal } from '@lumino/signaling';
import { renderServerSetting } from './renderer';
import type { FieldProps } from '@rjsf/utils';
const plugin: JupyterFrontEndPlugin<ILSPDocumentConnectionManager> = {
activate,
id: '@jupyterlab/lsp-extension:plugin',
description: 'Provides the language server connection manager.',
requires: [ITranslator, IWidgetLSPAdapterTracker],
optional: [IRunningSessionManagers],
provides: ILSPDocumentConnectionManager,
autoStart: true
};
const featurePlugin: JupyterFrontEndPlugin<ILSPFeatureManager> = {
id: '@jupyterlab/lsp-extension:feature',
description: 'Provides the language server feature manager.',
activate: () => new FeatureManager(),
provides: ILSPFeatureManager,
autoStart: true
};
const settingsPlugin: JupyterFrontEndPlugin<void> = {
activate: activateSettings,
id: '@jupyterlab/lsp-extension:settings',
description: 'Provides the language server settings.',
requires: [ILSPDocumentConnectionManager, ISettingRegistry, ITranslator],
optional: [IFormRendererRegistry],
autoStart: true
};
const codeExtractorManagerPlugin: JupyterFrontEndPlugin<ILSPCodeExtractorsManager> =
{
id: ILSPCodeExtractorsManager.name,
description: 'Provides the code extractor manager.',
activate: app => {
const extractorManager = new CodeExtractorsManager();
const markdownCellExtractor = new TextForeignCodeExtractor({
language: 'markdown',
isStandalone: false,
file_extension: 'md',
cellType: ['markdown']
});
extractorManager.register(markdownCellExtractor, null);
const rawCellExtractor = new TextForeignCodeExtractor({
language: 'text',
isStandalone: false,
file_extension: 'txt',
cellType: ['raw']
});
extractorManager.register(rawCellExtractor, null);
return extractorManager;
},
provides: ILSPCodeExtractorsManager,
autoStart: true
};
/**
* Activate the lsp plugin.
*/
function activate(
app: JupyterFrontEnd,
translator: ITranslator,
tracker: IWidgetLSPAdapterTracker,
runningSessionManagers: IRunningSessionManagers | null
): ILSPDocumentConnectionManager {
const languageServerManager = new LanguageServerManager({
settings: app.serviceManager.serverSettings
});
const connectionManager = new DocumentConnectionManager({
languageServerManager,
adapterTracker: tracker
});
// Add a sessions manager if the running extension is available
if (runningSessionManagers) {
addRunningSessionManager(
runningSessionManagers,
connectionManager,
translator
);
}
return connectionManager;
}
/**
* Activate the lsp settings plugin.
*/
function activateSettings(
app: JupyterFrontEnd,
connectionManager: ILSPDocumentConnectionManager,
settingRegistry: ISettingRegistry,
translator: ITranslator,
settingRendererRegistry: IFormRendererRegistry | null
): void {
const LANGUAGE_SERVERS = 'languageServers';
const languageServerManager = connectionManager.languageServerManager;
const updateOptions = (settings: ISettingRegistry.ISettings) => {
const options = settings.composite as Required<LanguageServersExperimental>;
const languageServerSettings = (options.languageServers ||
{}) as TLanguageServerConfigurations;
if (options.activate === 'on' && !languageServerManager.isEnabled) {
languageServerManager.enable().catch(console.error);
} else if (options.activate === 'off' && languageServerManager.isEnabled) {
languageServerManager.disable();
return;
}
connectionManager.initialConfigurations = languageServerSettings;
// TODO: if priorities changed reset connections
connectionManager.updateConfiguration(languageServerSettings);
connectionManager.updateServerConfigurations(languageServerSettings);
connectionManager.updateLogging(
options.logAllCommunication,
options.setTrace
);
};
settingRegistry.transform(plugin.id, {
fetch: plugin => {
const schema = plugin.schema.properties!;
const defaultValue: { [key: string]: any } = {};
languageServerManager.sessions.forEach((_, key) => {
defaultValue[key] = { rank: 50, configuration: {} };
});
schema[LANGUAGE_SERVERS]['default'] = defaultValue;
return plugin;
},
compose: plugin => {
const properties = plugin.schema.properties!;
const user = plugin.data.user;
const serverDefaultSettings = properties[LANGUAGE_SERVERS][
'default'
] as PartialJSONObject;
const serverUserSettings = user[LANGUAGE_SERVERS] as
| PartialJSONObject
| undefined;
let serverComposite = { ...serverDefaultSettings };
if (serverUserSettings) {
serverComposite = { ...serverComposite, ...serverUserSettings };
}
const composite: { [key: string]: any } = {
[LANGUAGE_SERVERS]: serverComposite
};
Object.entries(properties).forEach(([key, value]) => {
if (key !== LANGUAGE_SERVERS) {
if (key in user) {
composite[key] = user[key];
} else {
composite[key] = value.default;
}
}
});
plugin.data.composite = composite;
return plugin;
}
});
languageServerManager.sessionsChanged.connect(async () => {
await settingRegistry.load(plugin.id, true);
});
settingRegistry
.load(plugin.id)
.then(settings => {
updateOptions(settings);
settings.changed.connect(() => {
updateOptions(settings);
});
languageServerManager.disable();
})
.catch((reason: Error) => {
console.error(reason.message);
});
if (settingRendererRegistry) {
const renderer: IFormRenderer = {
fieldRenderer: (props: FieldProps) => {
return renderServerSetting(props, translator);
}
};
settingRendererRegistry.addRenderer(
`${plugin.id}.${LANGUAGE_SERVERS}`,
renderer
);
}
}
export class RunningLanguageServer implements IRunningSessions.IRunningItem {
constructor(
connection: ILSPConnection,
manager: ILSPDocumentConnectionManager
) {
this._connection = new WeakSet([connection]);
this._manager = manager;
this._serverIdentifier = connection.serverIdentifier;
this._serverLanguage = connection.serverLanguage;
}
/**
* This is no-op because we do not do anything on server click event
*/
open(): void {
/** no-op */
}
icon(): LabIcon {
return pythonIcon;
}
label(): string {
return `${this._serverIdentifier ?? ''} (${this._serverLanguage ?? ''})`;
}
shutdown(): void {
for (const [key, value] of this._manager.connections.entries()) {
if (this._connection.has(value)) {
const { uri } = this._manager.documents.get(key)!;
this._manager.unregisterDocument(uri);
}
}
this._manager.disconnect(this._serverIdentifier as TLanguageServerId);
}
private _connection: WeakSet<ILSPConnection>;
private _manager: ILSPDocumentConnectionManager;
private _serverIdentifier: string | undefined;
private _serverLanguage: string | undefined;
}
/**
* Add the running terminal manager to the running panel.
*/
function addRunningSessionManager(
managers: IRunningSessionManagers,
lsManager: ILSPDocumentConnectionManager,
translator: ITranslator
) {
const trans = translator.load('jupyterlab');
const signal = new Signal<any, any>(lsManager);
lsManager.connected.connect(() => signal.emit(lsManager));
lsManager.disconnected.connect(() => signal.emit(lsManager));
lsManager.closed.connect(() => signal.emit(lsManager));
lsManager.documentsChanged.connect(() => signal.emit(lsManager));
let currentRunning: RunningLanguageServer[] = [];
managers.add({
name: trans.__('Language servers'),
running: () => {
const connections = new Set([...lsManager.connections.values()]);
currentRunning = [...connections].map(
conn => new RunningLanguageServer(conn, lsManager)
);
return currentRunning;
},
shutdownAll: () => {
currentRunning.forEach(item => {
item.shutdown();
});
},
refreshRunning: () => {
return void 0;
},
runningChanged: signal,
shutdownLabel: trans.__('Shut Down'),
shutdownAllLabel: trans.__('Shut Down All'),
shutdownAllConfirmationText: trans.__(
'Are you sure you want to permanently shut down all running language servers?'
)
});
}
const adapterTrackerPlugin: JupyterFrontEndPlugin<IWidgetLSPAdapterTracker> = {
id: '@jupyterlab/lsp-extension:tracker',
description: 'Provides the tracker of `WidgetLSPAdapter`.',
autoStart: true,
provides: IWidgetLSPAdapterTracker,
activate: (app: JupyterFrontEnd<LabShell>): IWidgetLSPAdapterTracker => {
return new WidgetLSPAdapterTracker({ shell: app.shell });
}
};
/**
* Export the plugin as default.
*/
export default [
plugin,
featurePlugin,
settingsPlugin,
codeExtractorManagerPlugin,
adapterTrackerPlugin
];