mirror of
https://github.com/danog/psalm.git
synced 2024-12-12 17:27:28 +01:00
205fdd197e
* Wrap entrypoints into IIFE to protect their variables Fixes vimeo/psalm#5359 * Add tests for Psalm variable isolation * Capture environment before registering autoloader
309 lines
9.2 KiB
PHP
309 lines
9.2 KiB
PHP
<?php
|
|
|
|
namespace Psalm;
|
|
|
|
use Psalm\Internal\Analyzer\ProjectAnalyzer;
|
|
use Psalm\Internal\Composer;
|
|
use Psalm\Internal\ErrorHandler;
|
|
use Psalm\Internal\IncludeCollector;
|
|
|
|
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_string;
|
|
use function preg_replace;
|
|
use function realpath;
|
|
use function setlocale;
|
|
use function strtolower;
|
|
use function substr;
|
|
|
|
use const DIRECTORY_SEPARATOR;
|
|
use const LC_CTYPE;
|
|
use const PHP_EOL;
|
|
use const STDERR;
|
|
|
|
require_once __DIR__ . '/Psalm/Internal/ErrorHandler.php';
|
|
require_once __DIR__ . '/command_functions.php';
|
|
require_once __DIR__ . '/Psalm/Internal/Composer.php';
|
|
require_once __DIR__ . '/Psalm/Internal/IncludeCollector.php';
|
|
|
|
(
|
|
/** @param array<int,string> $argv */
|
|
function (array $argv): void {
|
|
gc_disable();
|
|
ErrorHandler::install();
|
|
$valid_short_options = [
|
|
'h',
|
|
'v',
|
|
'c:',
|
|
'r:',
|
|
];
|
|
|
|
$valid_long_options = [
|
|
'clear-cache',
|
|
'config:',
|
|
'find-dead-code',
|
|
'help',
|
|
'root:',
|
|
'use-ini-defaults',
|
|
'version',
|
|
'tcp:',
|
|
'tcp-server',
|
|
'disable-on-change::',
|
|
'enable-autocomplete',
|
|
'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(
|
|
/**
|
|
* @param string $arg
|
|
*/
|
|
function ($arg) use ($valid_long_options): void {
|
|
if (substr($arg, 0, 2) === '--' && $arg !== '--') {
|
|
$arg_name = preg_replace('/=.*$/', '', substr($arg, 2));
|
|
|
|
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) (4 * 1024 * 1024 * 1024));
|
|
}
|
|
|
|
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
|
|
|
|
--clear-cache
|
|
Clears all cache files that the language server uses for this specific project
|
|
|
|
--use-ini-defaults
|
|
Use PHP-provided ini defaults for memory and error display
|
|
|
|
--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-autocomplete[=BOOL]
|
|
Enables or disables autocomplete on methods and properties. Default is true.
|
|
|
|
--use-extended-diagnostic-codes
|
|
Enables sending help uri links with the code in diagnostic messages.
|
|
|
|
--verbose
|
|
Will send log messages to the client with information.
|
|
|
|
HELP;
|
|
|
|
exit;
|
|
}
|
|
|
|
if (array_key_exists('v', $options)) {
|
|
echo 'Psalm ' . PSALM_VERSION . PHP_EOL;
|
|
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 = \Psalm\getVendorDir($current_dir);
|
|
|
|
$include_collector = new IncludeCollector();
|
|
|
|
$first_autoloader = $include_collector->runAndCollect(
|
|
function () use ($current_dir, $options, $vendor_dir): ?\Composer\Autoload\ClassLoader {
|
|
return \Psalm\requireAutoloaders($current_dir, isset($options['r']), $vendor_dir);
|
|
}
|
|
);
|
|
|
|
$ini_handler = new \Psalm\Internal\Fork\PsalmRestarter('PSALM');
|
|
|
|
$ini_handler->disableExtension('grpc');
|
|
|
|
// If Xdebug is enabled, restart without it
|
|
$ini_handler->check();
|
|
|
|
setlocale(LC_CTYPE, 'C');
|
|
|
|
$path_to_config = \Psalm\get_path_to_config($options);
|
|
|
|
if (isset($options['tcp'])) {
|
|
if (!is_string($options['tcp'])) {
|
|
fwrite(STDERR, 'tcp url should be a string' . PHP_EOL);
|
|
exit(1);
|
|
}
|
|
}
|
|
|
|
$find_unused_code = isset($options['find-dead-code']) ? 'auto' : null;
|
|
|
|
$config = \Psalm\initialiseConfig(
|
|
$path_to_config,
|
|
$current_dir,
|
|
\Psalm\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();
|
|
|
|
if (isset($options['clear-cache'])) {
|
|
$cache_directory = $config->getCacheDirectory();
|
|
|
|
if ($cache_directory !== null) {
|
|
Config::removeCacheDirectory($cache_directory);
|
|
}
|
|
echo 'Cache directory deleted' . PHP_EOL;
|
|
exit;
|
|
}
|
|
|
|
$providers = new \Psalm\Internal\Provider\Providers(
|
|
new \Psalm\Internal\Provider\FileProvider,
|
|
new \Psalm\Internal\Provider\ParserCacheProvider($config),
|
|
new \Psalm\Internal\Provider\FileStorageCacheProvider($config),
|
|
new \Psalm\Internal\Provider\ClassLikeStorageCacheProvider($config),
|
|
new \Psalm\Internal\Provider\FileReferenceCacheProvider($config),
|
|
new \Psalm\Internal\Provider\ProjectCacheProvider(Composer::getLockFilePath($current_dir))
|
|
);
|
|
|
|
$project_analyzer = new ProjectAnalyzer(
|
|
$config,
|
|
$providers
|
|
);
|
|
|
|
if ($config->find_unused_variables) {
|
|
$project_analyzer->getCodebase()->reportUnusedVariables();
|
|
}
|
|
|
|
if ($config->find_unused_code) {
|
|
$find_unused_code = 'auto';
|
|
}
|
|
|
|
if (isset($options['disable-on-change'])) {
|
|
$project_analyzer->onchange_line_limit = (int) $options['disable-on-change'];
|
|
}
|
|
|
|
$project_analyzer->provide_completion = !isset($options['enable-autocomplete'])
|
|
|| !is_string($options['enable-autocomplete'])
|
|
|| strtolower($options['enable-autocomplete']) !== 'false';
|
|
|
|
if ($find_unused_code) {
|
|
$project_analyzer->getCodebase()->reportUnusedCode($find_unused_code);
|
|
}
|
|
|
|
if (isset($options['use-extended-diagnostic-codes'])) {
|
|
$project_analyzer->language_server_use_extended_diagnostic_codes = true;
|
|
}
|
|
|
|
if (isset($options['verbose'])) {
|
|
$project_analyzer->language_server_verbose = true;
|
|
}
|
|
|
|
$project_analyzer->server($options['tcp'] ?? null, isset($options['tcp-server']) ? true : false);
|
|
}
|
|
)($argv);
|