-
Notifications
You must be signed in to change notification settings - Fork 653
/
LanguageServer.php
399 lines (317 loc) · 13.4 KB
/
LanguageServer.php
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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<?php
namespace Psalm\Internal\Cli;
use LanguageServerProtocol\MessageType;
use Psalm\Config;
use Psalm\Internal\CliUtils;
use Psalm\Internal\ErrorHandler;
use Psalm\Internal\Fork\PsalmRestarter;
use Psalm\Internal\IncludeCollector;
use Psalm\Internal\LanguageServer\ClientConfiguration;
use Psalm\Internal\LanguageServer\LanguageServer as LanguageServerLanguageServer;
use Psalm\Report;
use function array_key_exists;
use function array_map;
use function array_search;
use function array_slice;
use function chdir;
use function error_log;
use function fwrite;
use function gc_disable;
use function getcwd;
use function getopt;
use function implode;
use function in_array;
use function ini_set;
use function is_array;
use function is_numeric;
use function is_string;
use function preg_replace;
use function realpath;
use function setlocale;
use function strpos;
use function strtolower;
use function substr;
use const DIRECTORY_SEPARATOR;
use const LC_CTYPE;
use const PHP_EOL;
use const STDERR;
// phpcs:disable PSR1.Files.SideEffects
require_once __DIR__ . '/../ErrorHandler.php';
require_once __DIR__ . '/../CliUtils.php';
require_once __DIR__ . '/../Composer.php';
require_once __DIR__ . '/../IncludeCollector.php';
require_once __DIR__ . '/../LanguageServer/ClientConfiguration.php';
/**
* @internal
*/
final class LanguageServer
{
/**
* @param array<int,string> $argv
* @psalm-suppress ComplexMethod
*/
public static function run(array $argv): void
{
CliUtils::checkRuntimeRequirements();
$clientConfiguration = new ClientConfiguration();
gc_disable();
ErrorHandler::install($argv);
$valid_short_options = [
'h',
'v',
'c:',
'r:',
];
$valid_long_options = [
'config:',
'find-dead-code',
'help',
'root:',
'use-ini-defaults',
'version',
'tcp:',
'tcp-server',
'disable-on-change::',
'use-baseline:',
'enable-autocomplete::',
'enable-code-actions::',
'enable-provide-diagnostics::',
'enable-provide-hover::',
'enable-provide-signature-help::',
'enable-provide-definition::',
'show-diagnostic-warnings::',
'in-memory::',
'disable-xdebug::',
'on-change-debounce-ms::',
'use-extended-diagnostic-codes',
'verbose',
];
$args = array_slice($argv, 1);
$psalm_proxy = array_search('--language-server', $args, true);
if ($psalm_proxy !== false) {
unset($args[$psalm_proxy]);
}
array_map(
static function (string $arg) use ($valid_long_options): void {
if (strpos($arg, '--') === 0 && $arg !== '--') {
$arg_name = preg_replace('/=.*$/', '', substr($arg, 2), 1);
if (!in_array($arg_name, $valid_long_options, true)
&& !in_array($arg_name . ':', $valid_long_options, true)
&& !in_array($arg_name . '::', $valid_long_options, true)
) {
fwrite(
STDERR,
'Unrecognised argument "--' . $arg_name . '"' . PHP_EOL
. 'Type --help to see a list of supported arguments' . PHP_EOL,
);
error_log('Bad argument');
exit(1);
}
}
},
$args,
);
// get options from command line
$options = getopt(implode('', $valid_short_options), $valid_long_options);
if (!array_key_exists('use-ini-defaults', $options)) {
ini_set('display_errors', '1');
ini_set('display_startup_errors', '1');
ini_set('memory_limit', (string) (8 * 1_024 * 1_024 * 1_024));
}
if (array_key_exists('help', $options)) {
$options['h'] = false;
}
if (array_key_exists('version', $options)) {
$options['v'] = false;
}
if (isset($options['config'])) {
$options['c'] = $options['config'];
}
if (isset($options['c']) && is_array($options['c'])) {
fwrite(STDERR, 'Too many config files provided' . PHP_EOL);
exit(1);
}
if (array_key_exists('h', $options)) {
echo <<<HELP
Usage:
psalm-language-server [options]
Options:
-h, --help
Display this help message
-v, --version
Display the Psalm version
-c, --config=psalm.xml
Path to a psalm.xml configuration file. Run psalm --init to create one.
-r, --root
If running Psalm globally you'll need to specify a project root. Defaults to cwd
--find-dead-code
Look for dead code
--use-ini-defaults
Use PHP-provided ini defaults for memory and error display
--use-baseline=PATH
Allows you to use a baseline other than the default baseline provided in your config
--tcp=url
Use TCP mode (by default Psalm uses STDIO)
--tcp-server
Use TCP in server mode (default is client)
--disable-on-change[=line-number-threshold]
If added, the language server will not respond to onChange events.
You can also specify a line count over which Psalm will not run on-change events.
--enable-code-actions[=BOOL]
Enables or disables code actions. Default is true.
--enable-provide-diagnostics[=BOOL]
Enables or disables providing diagnostics. Default is true.
--enable-autocomplete[=BOOL]
Enables or disables autocomplete on methods and properties. Default is true.
--enable-provide-hover[=BOOL]
Enables or disables providing hover. Default is true.
--enable-provide-signature-help[=BOOL]
Enables or disables providing signature help. Default is true.
--enable-provide-definition[=BOOL]
Enables or disables providing definition. Default is true.
--show-diagnostic-warnings[=BOOL]
Enables or disables showing diagnostic warnings. Default is true.
--use-extended-diagnostic-codes (DEPRECATED)
Enables sending help uri links with the code in diagnostic messages.
--on-change-debounce-ms=[INT]
The number of milliseconds to debounce onChange events.
--disable-xdebug[=BOOL]
Disable xdebug for performance reasons. Enable for debugging
--in-memory[=BOOL]
Use in-memory mode. Default is false. Experimental.
--verbose
Will send log messages to the client with information.
HELP;
exit;
}
if (getcwd() === false) {
fwrite(STDERR, 'Cannot get current working directory' . PHP_EOL);
exit(1);
}
if (isset($options['root'])) {
$options['r'] = $options['root'];
}
$current_dir = (string)getcwd() . DIRECTORY_SEPARATOR;
if (isset($options['r']) && is_string($options['r'])) {
$root_path = realpath($options['r']);
if (!$root_path) {
fwrite(
STDERR,
'Could not locate root directory ' . $current_dir . DIRECTORY_SEPARATOR . $options['r'] . PHP_EOL,
);
exit(1);
}
$current_dir = $root_path . DIRECTORY_SEPARATOR;
}
$vendor_dir = CliUtils::getVendorDir($current_dir);
$include_collector = new IncludeCollector();
$first_autoloader = $include_collector->runAndCollect(
// we ignore the FQN because of a hack in scoper.inc that needs full path
// phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.ReferenceViaFullyQualifiedName
static fn(): ?\Composer\Autoload\ClassLoader =>
CliUtils::requireAutoloaders($current_dir, isset($options['r']), $vendor_dir)
);
if (array_key_exists('v', $options)) {
echo 'Psalm ' . PSALM_VERSION . PHP_EOL;
exit;
}
$ini_handler = new PsalmRestarter('PSALM');
$ini_handler->disableExtensions([
'grpc',
'uopz',
// extensions bellow are incompatible with JIT
'pcov',
'blackfire',
]);
$disableXdebug = !isset($options['disable-xdebug'])
|| !is_string($options['disable-xdebug'])
|| strtolower($options['disable-xdebug']) !== 'false';
// If Xdebug is enabled, restart without it based on cli
if ($disableXdebug) {
$ini_handler->check();
}
setlocale(LC_CTYPE, 'C');
$path_to_config = CliUtils::getPathToConfig($options);
if (isset($options['tcp'])) {
if (!is_string($options['tcp'])) {
fwrite(STDERR, 'tcp url should be a string' . PHP_EOL);
exit(1);
}
}
$config = CliUtils::initializeConfig(
$path_to_config,
$current_dir,
Report::TYPE_CONSOLE,
$first_autoloader,
);
$config->setIncludeCollector($include_collector);
if ($config->resolve_from_config_file) {
$current_dir = $config->base_dir;
chdir($current_dir);
}
$config->setServerMode();
$inMemory = isset($options['in-memory']) &&
is_string($options['in-memory']) &&
strtolower($options['in-memory']) === 'true';
if ($inMemory) {
$config->cache_directory = null;
} else {
$cache_directory = $config->getCacheDirectory();
if ($cache_directory !== null) {
Config::removeCacheDirectory($cache_directory);
}
}
if (isset($options['use-baseline']) && is_string($options['use-baseline'])) {
$clientConfiguration->baseline = $options['use-baseline'];
}
if (isset($options['disable-on-change']) && is_numeric($options['disable-on-change'])) {
$clientConfiguration->onchangeLineLimit = (int) $options['disable-on-change'];
}
if (isset($options['on-change-debounce-ms']) && is_numeric($options['on-change-debounce-ms'])) {
$clientConfiguration->onChangeDebounceMs = (int) $options['on-change-debounce-ms'];
}
$clientConfiguration->provideDefinition = !isset($options['enable-provide-definition'])
|| !is_string($options['enable-provide-definition'])
|| strtolower($options['enable-provide-definition']) !== 'false';
$clientConfiguration->provideSignatureHelp = !isset($options['enable-provide-signature-help'])
|| !is_string($options['enable-provide-signature-help'])
|| strtolower($options['enable-provide-signature-help']) !== 'false';
$clientConfiguration->provideHover = !isset($options['enable-provide-hover'])
|| !is_string($options['enable-provide-hover'])
|| strtolower($options['enable-provide-hover']) !== 'false';
$clientConfiguration->provideDiagnostics = !isset($options['enable-provide-diagnostics'])
|| !is_string($options['enable-provide-diagnostics'])
|| strtolower($options['enable-provide-diagnostics']) !== 'false';
$clientConfiguration->provideCodeActions = !isset($options['enable-code-actions'])
|| !is_string($options['enable-code-actions'])
|| strtolower($options['enable-code-actions']) !== 'false';
$clientConfiguration->provideCompletion = !isset($options['enable-autocomplete'])
|| !is_string($options['enable-autocomplete'])
|| strtolower($options['enable-autocomplete']) !== 'false';
$clientConfiguration->hideWarnings = !(
!isset($options['show-diagnostic-warnings'])
|| !is_string($options['show-diagnostic-warnings'])
|| strtolower($options['show-diagnostic-warnings']) !== 'false'
);
/**
* if ($config->find_unused_variables) {
* $project_analyzer->getCodebase()->reportUnusedVariables();
* }
*/
$find_unused_code = isset($options['find-dead-code']) ? 'auto' : null;
if ($config->find_unused_code) {
$find_unused_code = 'auto';
}
if ($find_unused_code) {
$clientConfiguration->findUnusedCode = $find_unused_code;
}
if (isset($options['verbose'])) {
$clientConfiguration->logLevel = $options['verbose'] ? MessageType::LOG : MessageType::INFO;
} else {
$clientConfiguration->logLevel = MessageType::INFO;
}
$clientConfiguration->TCPServerAddress = $options['tcp'] ?? null;
$clientConfiguration->TCPServerMode = isset($options['tcp-server']);
LanguageServerLanguageServer::run($config, $clientConfiguration, $current_dir, $inMemory);
}
}