-
Notifications
You must be signed in to change notification settings - Fork 4
/
server.ts
321 lines (279 loc) · 9.72 KB
/
server.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
/* --------------------------------------------------------------------------------------------
* 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 {
createConnection,
TextDocuments,
TextDocument,
Diagnostic,
DiagnosticSeverity,
ProposedFeatures,
InitializeParams,
DidChangeConfigurationNotification,
CompletionItem,
CompletionItemKind,
TextDocumentPositionParams
} from 'vscode-languageserver';
import * as child_process from 'child_process';
import Critique from './Critique';
import Output from './Output';
import * as which from 'which';
// Create a connection for the server. The connection uses Node's IPC as a transport.
// Also include all preview / proposed LSP features.
let connection = createConnection(ProposedFeatures.all);
// Create a simple text document manager. The text document manager
// supports full document sync only
let documents: TextDocuments = new TextDocuments();
let hasConfigurationCapability: boolean = false;
let hasWorkspaceFolderCapability: boolean = false;
let hasDiagnosticRelatedInformationCapability: boolean = false;
connection.onInitialize((params: InitializeParams) => {
let capabilities = params.capabilities;
// Does the client support the `workspace/configuration` request?
// If not, we will fall back using global settings
hasConfigurationCapability =
capabilities.workspace && !!capabilities.workspace.configuration;
hasWorkspaceFolderCapability =
capabilities.workspace && !!capabilities.workspace.workspaceFolders;
hasDiagnosticRelatedInformationCapability =
capabilities.textDocument &&
capabilities.textDocument.publishDiagnostics &&
capabilities.textDocument.publishDiagnostics.relatedInformation;
return {
capabilities: {
textDocumentSync: documents.syncKind,
// Tell the client that the server supports code completion
completionProvider: {
resolveProvider: true
}
}
};
});
connection.onInitialized(() => {
if (hasConfigurationCapability) {
// Register for all configuration changes.
connection.client.register(
DidChangeConfigurationNotification.type,
undefined
);
}
if (hasWorkspaceFolderCapability) {
connection.workspace.onDidChangeWorkspaceFolders(_event => {
connection.console.log('Workspace folder change event received.');
});
}
});
// The example settings
interface PerlcriticSettings {
maxNumberOfProblems: number;
executable: string;
severity: string;
onSave: boolean;
additionalArguments: Array<string>;
}
// The global settings, used when the `workspace/configuration` request is not supported by the client.
// Please note that this is not the case when using this server with the client provided in this example
// but could happen with other clients.
const defaultSettings: PerlcriticSettings = {
maxNumberOfProblems: 10,
executable: validateExecutable("perlcritic"),
severity: "gentle",
onSave: false,
additionalArguments: ['--quiet', ["--verbose", "%l[>]%c[>]%s[>]%m. %e[>]%d[[END]]"].join('=')]
};
let globalSettings: PerlcriticSettings = defaultSettings;
// Cache the settings of all open documents
let documentSettings: Map<string, Thenable<PerlcriticSettings>> = new Map();
connection.onDidChangeConfiguration(change => {
try {
globalSettings = mergeSettings(change.settings.perlcritic);
} catch (error) {
// do nada
}
// Revalidate all open text documents
documents.all().forEach(validateTextDocument);
});
function validateExecutable(executable: string): string {
try {
return which.sync(executable);
}
catch (error) {
connection.window.showErrorMessage(error);
return "";
}
}
function mergeSettings(newSettings: PerlcriticSettings): PerlcriticSettings {
if (!newSettings) {
return defaultSettings;
}
newSettings.executable = validateExecutable(newSettings.executable);
// Only set severity if user does not specify a profile,
// because perlcritic will ignore the profile if severity is set.
// Tested on a Mac with perlcritic v1.130, Perl v5.26.1.
if (newSettings.additionalArguments.indexOf("--profile") === -1 && newSettings.additionalArguments.indexOf("-p") === -1) {
newSettings.additionalArguments.push(`--${newSettings.severity}`);
}
newSettings.additionalArguments.push(`--top=${newSettings.maxNumberOfProblems}`);
newSettings.additionalArguments = defaultSettings.additionalArguments
.concat(newSettings.additionalArguments
.filter(a => !a.match(/count|list|profile-proto|statistics-only|-C|pager|doc|verbose|quiet/)));
return newSettings;
}
/*function getDocumentSettings(resource: string): Thenable<PerlcriticSettings> {
if (!hasConfigurationCapability) {
return Promise.resolve(globalSettings);
}
let result = documentSettings.get(resource);
if (!result) {
result = connection.workspace.getConfiguration({
scopeUri: resource,
section: 'perlcritic'
});
documentSettings.set(resource, result);
}
return result;
}*/
// Only keep settings for open documents
documents.onDidClose(e => {
documentSettings.delete(e.document.uri);
});
// The content of a text document has changed. This event is emitted
// when the text document first opened or when its content has changed.
documents.onDidChangeContent(change => {
if (!globalSettings.onSave) {
validateTextDocument(change.document);
}
});
documents.onDidSave(change => {
if (globalSettings.onSave)
validateTextDocument(change.document);
})
function validate(text: string): Promise<Output> {
if (text == "") {
return new Promise(resolve => {
resolve(new Output("", ""))
});
}
return new Promise(resolve => {
try {
let spawn = child_process.spawn;
let worker = spawn(globalSettings.executable, globalSettings.additionalArguments);
worker.stdin.write(text);
worker.stdin.end();
let outputStr = '';
worker.stdout.on('data', (chunk) => {
outputStr += chunk;
});
let errorStr = '';
worker.stderr.on('data', (chunk) => {
errorStr += chunk;
});
worker.stdout.on('end', () => {
resolve(new Output(outputStr, errorStr));
});
}
catch (error) {
resolve(new Output('', error));
return;
}
});
}
async function validateTextDocument(textDocument: TextDocument): Promise<void> {
// In this simple example we get the settings for every validate run.
// let settings = await getDocumentSettings(textDocument.uri);
let output = await validate(textDocument.getText());
if (output.error) {
connection.window.showErrorMessage(output.error);
return;
}
let diagnostics: Diagnostic[] = [];
output.critiques.forEach((critique: Critique) => {
let diagnostic: Diagnostic = {
severity: DiagnosticSeverity.Warning,
range: {
start: { line: critique.line, character: critique.column },
end: { line: critique.line, character: Number.MAX_VALUE }
},
message: critique.summary,
source: 'perlcritic'
};
if (hasDiagnosticRelatedInformationCapability) {
diagnostic.relatedInformation = [
{
location: {
uri: textDocument.uri,
range: Object.assign({}, diagnostic.range)
},
message: critique.explanation
}
];
}
diagnostics.push(diagnostic);
});
// Send the computed diagnostics to VSCode.
connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });
}
connection.onDidChangeWatchedFiles(_change => {
// Monitored files have change in VSCode
connection.console.log('We received an file change event');
});
// This handler provides the initial list of the completion items.
connection.onCompletion(
(_textDocumentPosition: TextDocumentPositionParams): CompletionItem[] => {
// The pass parameter contains the position of the text document in
// which code complete got requested. For the example we ignore this
// info and always provide the same completion items.
return [
{
label: 'TypeScript',
kind: CompletionItemKind.Text,
data: 1
},
{
label: 'JavaScript',
kind: CompletionItemKind.Text,
data: 2
}
];
}
);
// This handler resolve additional information for the item selected in
// the completion list.
connection.onCompletionResolve(
(item: CompletionItem): CompletionItem => {
if (item.data === 1) {
(item.detail = 'TypeScript details'),
(item.documentation = 'TypeScript documentation');
} else if (item.data === 2) {
(item.detail = 'JavaScript details'),
(item.documentation = 'JavaScript documentation');
}
return item;
}
);
/*
connection.onDidOpenTextDocument((params) => {
// A text document got opened in VSCode.
// params.uri uniquely identifies the document. For documents store on disk this is a file URI.
// params.text the initial full content of the document.
connection.console.log(`${params.textDocument.uri} opened.`);
});
connection.onDidChangeTextDocument((params) => {
// The content of a text document did change in VSCode.
// params.uri uniquely identifies the document.
// params.contentChanges describe the content changes to the document.
connection.console.log(`${params.textDocument.uri} changed: ${JSON.stringify(params.contentChanges)}`);
});
connection.onDidCloseTextDocument((params) => {
// A text document got closed in VSCode.
// params.uri uniquely identifies the document.
connection.console.log(`${params.textDocument.uri} closed.`);
});
*/
// Make the text document manager listen on the connection
// for open, change and close text document events
documents.listen(connection);
// Listen on the connection
connection.listen();