-
Notifications
You must be signed in to change notification settings - Fork 221
/
extension.ts
246 lines (216 loc) · 9.77 KB
/
extension.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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Red Hat, Inc. All rights reserved.
* Copyright (c) Adam Voss. All rights reserved.
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
'use strict';
import * as path from 'path';
import { workspace, ExtensionContext, extensions, window, commands } from 'vscode';
import {
LanguageClient,
LanguageClientOptions,
ServerOptions,
TransportKind,
NotificationType,
RequestType,
RevealOutputChannelOn,
} from 'vscode-languageclient/node';
import { CUSTOM_SCHEMA_REQUEST, CUSTOM_CONTENT_REQUEST, SchemaExtensionAPI } from './schema-extension-api';
import { joinPath } from './paths';
import { getJsonSchemaContent, JSONSchemaDocumentContentProvider } from './json-schema-content-provider';
import { JSONSchemaCache } from './json-schema-cache';
import { getConflictingExtensions, showUninstallConflictsNotification } from './extensionConflicts';
import { getRedHatService } from '@redhat-developer/vscode-redhat-telemetry';
import { TelemetryErrorHandler, TelemetryOutputChannel } from './telemetry';
export interface ISchemaAssociations {
[pattern: string]: string[];
}
export interface ISchemaAssociation {
fileMatch: string[];
uri: string;
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace SettingIds {
export const maxItemsComputed = 'yaml.maxItemsComputed';
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace StorageIds {
export const maxItemsExceededInformation = 'yaml.maxItemsExceededInformation';
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace SchemaAssociationNotification {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const type: NotificationType<ISchemaAssociations | ISchemaAssociation[]> = new NotificationType(
'json/schemaAssociations'
);
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace VSCodeContentRequestRegistration {
// eslint-disable-next-line @typescript-eslint/ban-types
export const type: NotificationType<{}> = new NotificationType('yaml/registerContentRequest');
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace VSCodeContentRequest {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const type: RequestType<string, string, any> = new RequestType('vscode/content');
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace DynamicCustomSchemaRequestRegistration {
// eslint-disable-next-line @typescript-eslint/ban-types
export const type: NotificationType<{}> = new NotificationType('yaml/registerCustomSchemaRequest');
}
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace ResultLimitReachedNotification {
// eslint-disable-next-line @typescript-eslint/ban-types
export const type: NotificationType<string> = new NotificationType('yaml/resultLimitReached');
}
let client: LanguageClient;
const lsName = 'YAML Support';
export async function activate(context: ExtensionContext): Promise<SchemaExtensionAPI> {
// Create Telemetry Service
const telemetry = await (await getRedHatService(context)).getTelemetryService();
telemetry.sendStartupEvent();
// The YAML language server is implemented in node
const serverModule = context.asAbsolutePath(
path.join('node_modules', 'yaml-language-server', 'out', 'server', 'src', 'server.js')
);
// The debug options for the server
const debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] };
// If the extension is launched in debug mode then the debug server options are used
// Otherwise the run options are used
const serverOptions: ServerOptions = {
run: { module: serverModule, transport: TransportKind.ipc },
debug: { module: serverModule, transport: TransportKind.ipc, options: debugOptions },
};
const telemetryErrorHandler = new TelemetryErrorHandler(telemetry, lsName, 4);
const outputChannel = window.createOutputChannel(lsName);
// Options to control the language client
const clientOptions: LanguageClientOptions = {
// Register the server for on disk and newly created YAML documents
documentSelector: [{ language: 'yaml' }],
synchronize: {
// Notify the server about file changes to YAML and JSON files contained in the workspace
fileEvents: [workspace.createFileSystemWatcher('**/*.?(e)y?(a)ml'), workspace.createFileSystemWatcher('**/*.json')],
},
revealOutputChannelOn: RevealOutputChannelOn.Never,
errorHandler: telemetryErrorHandler,
outputChannel: new TelemetryOutputChannel(outputChannel, telemetry),
};
// Create the language client and start it
client = new LanguageClient('yaml', lsName, serverOptions, clientOptions);
const schemaCache = new JSONSchemaCache(context.globalStorageUri.fsPath, context.globalState, client.outputChannel);
const disposable = client.start();
const schemaExtensionAPI = new SchemaExtensionAPI(client);
// Push the disposable to the context's subscriptions so that the
// client can be deactivated on extension deactivation
context.subscriptions.push(disposable);
context.subscriptions.push(
workspace.registerTextDocumentContentProvider(
'json-schema',
new JSONSchemaDocumentContentProvider(schemaCache, schemaExtensionAPI)
)
);
context.subscriptions.push(
client.onTelemetry((e) => {
telemetry.send(e);
})
);
findConflicts();
client.onReady().then(() => {
// Send a notification to the server with any YAML schema associations in all extensions
client.sendNotification(SchemaAssociationNotification.type, getSchemaAssociations());
// If the extensions change, fire this notification again to pick up on any association changes
extensions.onDidChange(() => {
client.sendNotification(SchemaAssociationNotification.type, getSchemaAssociations());
findConflicts();
});
// Tell the server that the client is ready to provide custom schema content
client.sendNotification(DynamicCustomSchemaRequestRegistration.type);
// Tell the server that the client supports schema requests sent directly to it
client.sendNotification(VSCodeContentRequestRegistration.type);
// If the server asks for custom schema content, get it and send it back
client.onRequest(CUSTOM_SCHEMA_REQUEST, (resource: string) => {
return schemaExtensionAPI.requestCustomSchema(resource);
});
client.onRequest(CUSTOM_CONTENT_REQUEST, (uri: string) => {
return schemaExtensionAPI.requestCustomSchemaContent(uri);
});
client.onRequest(VSCodeContentRequest.type, (uri: string) => {
return getJsonSchemaContent(uri, schemaCache);
});
telemetry.send({ name: 'yaml.server.initialized' });
// Adapted from:
// https://github.com/microsoft/vscode/blob/94c9ea46838a9a619aeafb7e8afd1170c967bb55/extensions/json-language-features/client/src/jsonClient.ts#L305-L318
client.onNotification(ResultLimitReachedNotification.type, async (message) => {
const shouldPrompt = context.globalState.get<boolean>(StorageIds.maxItemsExceededInformation) !== false;
if (shouldPrompt) {
const ok = 'Ok';
const openSettings = 'Open Settings';
const neverAgain = "Don't Show Again";
const pick = await window.showInformationMessage(
`${message}\nUse setting '${SettingIds.maxItemsComputed}' to configure the limit.`,
ok,
openSettings,
neverAgain
);
if (pick === neverAgain) {
await context.globalState.update(StorageIds.maxItemsExceededInformation, false);
} else if (pick === openSettings) {
await commands.executeCommand('workbench.action.openSettings', SettingIds.maxItemsComputed);
}
}
});
});
return schemaExtensionAPI;
}
/**
* Finds extensions that conflict with VSCode-YAML.
* If one or more conflicts are found then show an uninstall notification
* If no conflicts are found then do nothing
*/
function findConflicts(): void {
const conflictingExtensions = getConflictingExtensions();
if (conflictingExtensions.length > 0) {
showUninstallConflictsNotification(conflictingExtensions);
}
}
function getSchemaAssociations(): ISchemaAssociation[] {
const associations: ISchemaAssociation[] = [];
extensions.all.forEach((extension) => {
const packageJSON = extension.packageJSON;
if (packageJSON && packageJSON.contributes && packageJSON.contributes.yamlValidation) {
const yamlValidation = packageJSON.contributes.yamlValidation;
if (Array.isArray(yamlValidation)) {
yamlValidation.forEach((jv) => {
// eslint-disable-next-line prefer-const
let { fileMatch, url } = jv;
if (typeof fileMatch === 'string') {
fileMatch = [fileMatch];
}
if (Array.isArray(fileMatch) && typeof url === 'string') {
let uri: string = url;
if (uri[0] === '.' && uri[1] === '/') {
uri = joinPath(extension.extensionUri, uri).toString();
}
fileMatch = fileMatch.map((fm) => {
if (fm[0] === '%') {
fm = fm.replace(/%APP_SETTINGS_HOME%/, '/User');
fm = fm.replace(/%MACHINE_SETTINGS_HOME%/, '/Machine');
fm = fm.replace(/%APP_WORKSPACES_HOME%/, '/Workspaces');
} else if (!fm.match(/^(\w+:\/\/|\/|!)/)) {
fm = '/' + fm;
}
return fm;
});
associations.push({ fileMatch, uri });
}
});
}
}
});
return associations;
}
export function logToExtensionOutputChannel(message: string): void {
client.outputChannel.appendLine(message);
}